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
Add documentation for colors component #25567
Conversation
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.
LGTM 👍 I guess we can expand a little bit on the withColors and explain which props are injected but I guess we can merge and iterate.
|
|
||
| ## `useColors` hook | ||
|
|
||
| Experimental hook that combines the functionality of the `withColors` HOC and `PanelColorSettings`, with `InspectorControls` into an easy to use `useColors` hook. |
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 guess instead of "Experimental hook that combines the functionality of the withColors HOC and PanelColorSettings, with InspectorControls into an easy to use useColors hook.".
We can just say that it provides equivalent functionality to withColors as a react hook.
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've modified the useColors explanation as you suggested.
This component includes a collection of color tools for Blocks.
As I understand it, it injects the ps. I still don't have write permissions here. I think it's time for me to ask for them :) |
|
Perhaps we should mention at least once what |
Description
Adding documentation for the colors component. This component provides a collection of color tools for Blocks, most of which were already documented on the code itself.
See #22891
How has this been tested?
Documentation only.
Types of changes
Documentation.
Checklist: