-
Notifications
You must be signed in to change notification settings - Fork 236
docs(color-slider): enhance README with detailed sections #5728
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
|
📚 Branch Preview🔍 Visual Regression Test ResultsWhen a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:
Deployed to Azure Blob Storage: If the changes are expected, update the |
Tachometer resultsCurrently, no packages are changed by this PR... |
| Import the side effectful registration of `<sp-color-slider>` via: | ||
|
|
||
| ``` | ||
| ```javascript |
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.
can we use js for consistency?
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.
For every color-component we have used javascript only
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.
and everywhere else we've used js. i dont know what is better tbh was just curious lol
| #### Keyboard Navigation | ||
|
|
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.
do we wanna talk about shift+arrow keys here or not?
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.
Sure!
rise-erpelding
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.
This is excellent, overall!
Since digging through the internals of this component in SWC is new to me, there were a few things that were unfamiliar to me that may or may not need to be added to the documentation:
- How does the gradient slot work? It looks like in Storybook there are stories for Canvas and Image, which look to be using this slot, are those worth showing here?
- Can you use the color slider to select an alpha/opacity level? Similar to this example in CSS? Would that be useful at all to show here, too?
|
docs(color-slider): enhance README with detailed component overview
Overview
This PR reorganizes the color-slider README.md to follow the established documentation standards structure, improving accessibility and consistency with other components.
Changes Made
Structure Reorganization
bash,javascript)Code Quality Improvements
Accessibility Enhancements
<sp-table>structure<kbd>tags for keyboard keysTesting
Related Documentation
This PR follows the documentation standards outlined in:
Screenshots
N/A - Documentation only changes
Before/After Structure Comparison
Before:
After:
Checklist