More storybook example/docs for dynamic/multi-state buttons #4553
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
size-limit report 📦
|
khiga8
commented
May 2, 2024
...pshots/components/Button.test.ts-snapshots/Button-Trailing-Counter-dark-colorblind-linux.png
Outdated
Show resolved
Hide resolved
khiga8
commented
May 2, 2024
|
|
||
| <Meta of={ButtonStories} title="Components/Button/Features/MultiStateButtons" /> | ||
|
|
||
| # Multi-state Buttons |
There was a problem hiding this comment.
See new documentation!
khiga8
force-pushed
the
kh-button-special-cases
branch
from
aca05ff
to
eb5c6c5
Compare
lindseywild
approved these changes
May 3, 2024
Co-authored-by: Lindsey Wild <[email protected]>
joshblack
approved these changes
May 16, 2024
| @@ -141,6 +141,7 @@ | |||
| "@storybook/addon-links": "7.6.2", | |||
| "@storybook/addon-storysource": "7.6.14", | |||
| "@storybook/addon-styling": "1.3.7", | |||
| "@storybook/blocks": "8.0.9", | |||
There was a problem hiding this comment.
Could we use the v7 version of @storybook/blocks since we're still on v7 of storybook? 👀
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: https://github.com/github/accessibility/issues/6266
Changelog
New
storybook/addon-blockspackage. This allows me to provide more comprehensive documentation for a storybook example the storybook way ✨ .I've already proposed doc updates to Primer's interface guidelines. I don't think this is enough. I find additional value in having code examples with explanatory text, since the interface guidelines is more framework agnostic.
There is a need to provide additional documentation for nuanced examples alongside the code (Slack), but there isn't a standardized practice for doing that right now in storybook.
Initially I went down the route of directly adding text explanations to the storybook story, but utilizing storybook blocks and MDX feels a lot cleaner, and feels like the "storybook way". So, I am trying this storybook markdown out!
Check it out 🔍 :
📢 REVIEWERS: let me know if this approach doesn't make sense to you or if you have a different suggestion!
Are there are any concerns with adding this package? 👀
Rollout strategy
Testing & Reviewing
Merge checklist