-
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(CodeSnippet): overhaul storybook #6606
docs(CodeSnippet): overhaul storybook #6606
Conversation
Deploy preview for carbon-elements ready! Built with commit 3ce6c12 |
Deploy preview for carbon-components-react ready! Built with commit 3ce6c12 https://deploy-preview-6606--carbon-components-react.netlify.app |
Removing review requests as it's WIP 👀 |
Probably good to get some eyes on this 👀 |
<Preview> | ||
<Story id="codesnippet--code-snippet" /> | ||
</Preview> | ||
|
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.
It'd be helpful to talk about the different variations as top-level headings, maybe the following each with their own default example:
- Inline
- Multi-line
- Single-line
At a top-level, it might be helpful to address a couple of common situations:
- Copying a code snippet
- How to enable/disable
- How to configure the feedback provided
- Rendering a "light" variant, and when/why to use that
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.
I added individual sections for the different use cases (inline, multi, light etc) -- seemed a little redundant to describe turning the copy button off and on and stuff with the API and expected boolean listed in the props table though, but I can go back and add that if we think it's something we need.
Need anything else for this PR @dakahn ? 👀 |
No @joshblack, my bad it's gone so stale. I'll get this patched up by EOD |
2cfe261
to
60cf893
Compare
…on into 6592-update-codesnippet-docs
…on into 6592-update-codesnippet-docs
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.
LGTM
Closes #6592
Overhauls and streamlines CodeSnippet stories. All knobs are now in 'playground'.
Testing / Reviewing
Make sure all functionality we want to demonstrate is accounted for and working correctly 👍