Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the specification around adding foundation components #37

Merged
merged 3 commits into from
May 9, 2022

Conversation

janechu
Copy link
Contributor

@janechu janechu commented May 6, 2022

Pull Request

πŸ“– Description

This update to the specification clarifies adding a "foundation" component with a specific add-foundation-component command.

πŸ‘©β€πŸ’» Reviewer Notes

Read through and make sure this command makes sense given the add-component command. Since the add-component command deals with adding via templates, the add-foundation-component is intended to explicit to adding foundation based component. This distinction was thought to be necessary as this adds the @microsoft/fast-foundation dependency and begins to use the preconfigured design tokens, so if you are not intending to use those systems, you would simply use the add-component command for your custom components.

βœ… Checklist

General

  • I have added tests for my changes.
  • I have tested my changes.
  • I have updated the project documentation to reflect my changes.

⏭ Next Steps

@janechu janechu self-assigned this May 6, 2022
Copy link
Contributor

@EisenbergEffect EisenbergEffect left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems a bit verbose but otherwise makes sense. At first I wasn't sure about this being a separate command but I think the reasoning is solid. I'm not sure if there's a great way to improve the verbosity.

One thought I had was about related components. For example, if someone adds the accordion, they probably want the accordion-item as well. Could we make an experience improvement at some point so that in cases like this we ask "would you also like to ..."?

@janechu
Copy link
Contributor Author

janechu commented May 9, 2022

Seems a bit verbose but otherwise makes sense. At first I wasn't sure about this being a separate command but I think the reasoning is solid. I'm not sure if there's a great way to improve the verbosity.

One thought I had was about related components. For example, if someone adds the accordion, they probably want the accordion-item as well. Could we make an experience improvement at some point so that in cases like this we ask "would you also like to ..."?

Hm, perhaps I don't include breadcrumb-item, accordion-item etc. due to the fact that they're not meant to be standalone components. That solves both issues. Radio-group is another one that fits along those lines.

Edit: I realize that was unclear, what I mean is you only have the option to add "radio-group" and "breadcrumb" and you would get any sub-components with it.

@janechu janechu merged commit 01e3686 into main May 9, 2022
@janechu janechu deleted the users/janechu/update-add-foundation-command-spec branch May 9, 2022 23:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants