-
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(Modal): add storybook MDX example #6804
docs(Modal): add storybook MDX example #6804
Conversation
Deploy preview for carbon-elements ready! Built with commit 5791197 |
Deploy preview for carbon-components-react ready! Built with commit 5791197 https://deploy-preview-6804--carbon-components-react.netlify.app |
@emyarod looking through the Modal PRs, would it make sense if we consolidate them into a single docs page and maybe grouped them under a "Modal" group? Just saw some of the content here included |
yeah that's a side effect of moving from the website to storybook where we have distinct exported components. so would that mean grouping the stories together or something? |
Could you do something like (in Haven't tested so not sure it's possible. |
yeah we can do that if we are fine with combining the docs for the modal variants, but the component previews will all be the same as well |
I think we could definitely do a Modal group and group each sub-component under it while providing a holistic "how to use modal" docs page. The other option could be that we each docs page refer to only the component in the story (e.g. Modal.mdx would only talk about Modal). For data table, I ended up doing the former but I can see value either way 👍 |
yeah I can make the ComposedModal docs more scoped to ComposedModal usage. there will be some overlap at the end of the day though since they are both modals |
e087992
to
f8daa52
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 an awesome addition to the Modal documentation! Very thorough and will really help or users when dealing with this component. Thanks for taking the time to explain some of the more complicated areas of this component.
The only changes I have are some formatting changes to fit better with our other mdx files, better syntax highlighting, and a few wording changes (feel free to ignore those, though!). I like the usage of the InlineNotification
, we just need to import it into the mdx
file 👍
f8daa52
to
fce81af
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.
Looks good with TJ's review comments above 👀 Let me know when they're addressed and I can re-review!
fce81af
to
5db574e
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.
Just a few tiny comments, other than that it looks 💯
efff057
to
35cf380
Compare
Ref #6591
This PR adds a custom modal state manager example and MDX docs to the existing Modal docs
Testing / Reviewing
Review the new modal state manager example and the storybook Docs tabs updates