-
Notifications
You must be signed in to change notification settings - Fork 31
docs: Add a KeyboardKey component #3216
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
Conversation
|
View your CI Pipeline Execution ↗ for commit 09cf2a8 ☁️ Nx Cloud last updated this comment at |
dreamwasp
left a comment
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.
tried to figure out why the default doesn't work - kbd isn't recognized as a native component by Storybook so we'd have to write some custom webpack rules. doesn't seem like the juice is worth the squeeze, but we may want to add an eslint rule or something so folks use it. looks great tho and yr good 2 ship!
|
📬 Published Alpha Packages: |
|
🚀 Styleguide deploy preview ready! Preview URL: https://695d43a8aead7fdf4d929a68--gamut-preview.netlify.app |
Overview
Adds a styled
KeyboardKeycomponent to replace plain<kbd>tags in styleguide documentation, providing consistent keyboard key styling across all MDX files.Adds a ESLint rule for
mdxfiles in Storybook to use this new componentPR Checklist
Testing Instructions
Don't make me tap the sign.
/packages/styleguide/**.mdxfile, test that the new eslint error appears by adding a<kbd>element somewhere in the doc, e.g.<kbd>testing</kbd>— you may need to restart the ESLint server in your editorPR Links and Envs
N/A