PanelColorSettings: add README.md file #17996
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
retrofox
requested review from
ellatrix,
talldan and
youknowriad
as code owners
5 tasks
talldan
reviewed
Oct 18, 2019
| @@ -0,0 +1,42 @@ | |||
| # `PanelColorSettings` | |||
|
|
|||
| Render a panel with color choices shown in circles, allowing a user to pick them. | |||
There was a problem hiding this comment.
I think a really important thing to mention here is that PanelColorSettings can render multiple color palettes.
talldan
reviewed
Oct 18, 2019
| * *Required:* No | ||
| * *Default:* Null | ||
|
|
||
| The content to be displayed within the panel. |
There was a problem hiding this comment.
Specifically below the color palettes. It could also be worth mentioning that this is useful for rendering a ContrastChecker within the panel.
talldan
reviewed
Oct 18, 2019
| * **Type:** `Array` | ||
| * *Required:* Yes | ||
|
|
||
| An array of props used for mapping both ColorIndicator and ColorPaletteControl components. |
There was a problem hiding this comment.
I think it might be good to mention that each entry in the array represents an individual color palette. An example showing the shape of the object might be good here as well.
talldan
reviewed
Oct 18, 2019
|
|
||
| ### `disableCustomColors` | ||
|
|
||
| Whether to allow custom color or not. |
There was a problem hiding this comment.
Minor nitpick:
Suggested change
| Whether to allow custom color or not. | |
| Whether to allow custom colors or not. |
|
Thanks for adding these docs @retrofox! I left a few minor comments on the PR where I think the descriptions can be improved. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
It adds the README.md file to the
PanelColorSettingscompoment.How has this been tested?
Just read the doc.