-
Notifications
You must be signed in to change notification settings - Fork 233
docs(color-field): enhance README with detailed usage, options, and a… #5701
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
…ccessibility information
|
📚 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... |
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 love the work you put into the Accessibility section.
I had one question about whether quiet is a state or more of an option.
And I added suggestions to wrap the color formats into tabs rather than bullets for easier reading.
packages/color-field/README.md
Outdated
#### Quiet | ||
|
||
A Quiet color field | ||
A quiet color field provides a more subtle appearance: | ||
|
||
```html | ||
<sp-color-field quiet value="#e6e600"></sp-color-field> | ||
``` |
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.
Should we move Quiet to the Options section?
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.
Done!
@@ -63,80 +77,149 @@ import { ColorField } from '@spectrum-web-components/color-field'; | |||
</sp-tab-panel> | |||
</sp-tabs> | |||
|
|||
## View Color |
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.
Should we move Quiet section here?
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.
Done!
Co-authored-by: Nikki Massaro <[email protected]>
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.
One small nit suggestion, that you can choose to commit or ignore, but otherwise LGTM.
Co-authored-by: Nikki Massaro <[email protected]>
Overview
This PR reorganizes the color-field README.md to follow the established documentation standards structure, improving accessibility and consistency with other components.
Changes Made
Structure Reorganization
Content Improvements
Testing
Related Documentation
This reorganization makes the color-field documentation more accessible, easier to navigate, and consistent with the established documentation standards across the Spectrum Web Components library.