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

docs: move Multiselect.Filterable from knobs to it's own story #5294

Merged

Conversation

vpicone
Copy link
Contributor

@vpicone vpicone commented Feb 6, 2020

Closes #5293

Considering Multiselect.Filterable is essentially it's own component, it should be surfaced as it's own story rather than hidden amongst the props object that gets used to generate knobs.

Accessing a component via dot notation/destructuring is a pretty rare occurence in our library. It's unclear to me why this behavior wasn't just exposed via a prop.

This also allows us to provide specific guidance in the story for when someone might use this component and makes all of the story tabs more legibile rather than showing ComponentToUse.

Changelog

New

  • filterable story for multiselect

Removed

  • filterable knob in all multiselect stories

Testing / Reviewing

Use the new story

@vpicone vpicone requested a review from a team as a code owner February 6, 2020 21:35
@ghost ghost requested review from joshblack and tw15egan February 6, 2020 21:35
@vpicone vpicone requested review from emyarod and removed request for joshblack February 6, 2020 21:37
@netlify
Copy link

netlify bot commented Feb 6, 2020

Deploy preview for carbon-elements ready!

Built with commit 0868a98

https://deploy-preview-5294--carbon-elements.netlify.com

Copy link
Collaborator

@tw15egan tw15egan left a comment

Choose a reason for hiding this comment

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

Thanks for adding this in, makes much more sense to be its own story 👍 ✅

@netlify
Copy link

netlify bot commented Feb 6, 2020

Deploy preview for carbon-components-react failed.

Built with commit 0868a98

https://app.netlify.com/sites/carbon-components-react/deploys/5e3c9e208fbcd20008610e04

Copy link
Contributor

@asudoh asudoh left a comment

Choose a reason for hiding this comment

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

Makes sense, thanks @vpicone

@vpicone vpicone merged commit 1721418 into carbon-design-system:master Feb 7, 2020
@vpicone vpicone deleted the add-filterable-multiselect-story branch February 7, 2020 01:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs]: Improve discoverability of Multiselect.Filterable component
3 participants