-
Notifications
You must be signed in to change notification settings - Fork 198
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(alertbanner): migrate docs to storybook #3118
Conversation
|
a38a219
to
020a291
Compare
🚀 Deployed on https://pr-3118--spectrum-css.netlify.app |
020a291
to
3bc1e2b
Compare
File metricsSummaryTotal size: 4.11 MB* 🎉 No changes detected in any packages * Size determined by adding together the size of the main file for all packages in the library.* Results are not gzipped or minified. * An ASCII character in UTF-8 is 8 bits or 1 byte. |
3bc1e2b
to
8364f3a
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 looks great! Test coverage looks good, info from Docs Site is included, and the variants are all displayed in a really nice way. Well done!
I added one tiny grammatical suggestion but don't expect this would need a re-review afterward, so I'm approving!
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.
Great addition to the docs page, thanks for linking the design docs. Let's make a note to publish the site after this merges. Thanks for making these updates and expanding the test coverage.
8364f3a
to
a5c5e9a
Compare
a5c5e9a
to
0e52226
Compare
Create docs-only stories for alert banner in Storybook to represent what was on the docs site. Modifies the alert banner's action button control to allow the text of the button to be editable. Adds test cases and examples for options without close button and without close button or action button.
0e52226
to
0c76468
Compare
Description
Create docs-only stories for alert banner in Storybook to represent what was on the docs site.
Modifies the alert banner's action button control to allow the text of the button to be editable.
Adds unrepresented test cases and examples for options with just an action button (no close button), and text only (no action button or close button). The design team had confirmed these as available options during the S2 migration.
Note: these updated docs were based on the ones from from the WIP S2 migration; I decided against using the custom MDX file and just prefixing the three variant stories with "Variant: " to group them together, since the only unique thing the custom MDX was providing was another heading above the three semantic variants. And because the current preference is to use the autodocs template unless it's really necessary to create a custom MDX.
How and where has this been tested?
Please tag yourself on the tests you've marked complete to confirm the tests have been run by someone other than the author.
Validation steps
Regression testing
Validate:
To-do list