-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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(Slug): move slug examples under experimental section #15294
docs(Slug): move slug examples under experimental section #15294
Conversation
✅ Deploy Preview for v11-carbon-react ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
f6c1e39
to
7e53c58
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great. One question. Why do I see slug in the prop table here:
But not in the experimental example?
That seems important in all these examples, to show how the Slug is passed into each component?
@mattrosno I can add it, I just had those select few props to test the components in various states. Adding the slug prop to that table isn’t going to let them change the slug that is rendered inside the component though. The knobs are great for basic state changes, but to understand how to use the slug prop I’d expect the story code itself to be more help. We could also add example usage inside the mdx file if we want |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Storybook organization and experimental status in prop tables LGTM.
I found one bug. I don't know if this is getting addressed in a different issue or not. The label is overlapping with the slug where if you click directly on the slug icon, it selects that label not the slug. If you click outside of that label but still within the 32px slug, it then triggers the slug as expected.
@mattrosno fixed 👍🏻 I believe that was unique to |
…ign-system#15294) * docs(Slug): move slug examples under experimental section * refactor(Slug): move all slug examples under slug * test(e2e): update form test to match new location * refactor(Slug): add controls to slug example components * docs(Slug): add slug to controls table * style(TextArea): fix label width issue
Based on feedback from @mattrosno. This moves all slug-specific stories under the
unstable__slug
storybook folder. It also adds comments to components with aslug
prop to mark it as an experimental prop. Also closes #15296Changelog
New
Examples
folder underunstable__Slug
in storybook. This contains an example of each component that has theslug
prop.Changed
AI Form
story to underunstable__Slug
, as well as all associated stylesTile
slug test story to underunstable__Slug
, as well as all associated stylesRadio Button
andCheckbox
slug test stories to underunstable__Slug
, as well as all associated stylesExperimental:
before eachslug
prop type definitionRemoved
Checkbox
story file that was causing thedisabled
prop to be hidden ([Bug]: Disabled prop under checkbox is not showing in the storybook #15296)Slug
Testing / Reviewing
unstable__Slug --> Form
unstable__Slug --> Examples
and the props work as expected