Skip to content
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

Block Editor: Add README for PanelColorSettings component #52327

Merged
merged 1 commit into from
Jul 5, 2023

Conversation

tyxla
Copy link
Member

@tyxla tyxla commented Jul 5, 2023

What?

This PR adds a README for the PanelColorSettings component.

Fixes #52064.

Why?

Part of #22891 where we aim to document all block editor components.

How?

Just adding a README.

Testing Instructions

Not needed.

Testing Instructions for Keyboard

None.

Screenshots or screencast

None.

@tyxla tyxla added [Type] Developer Documentation Documentation for developers [Package] Block editor /packages/block-editor labels Jul 5, 2023
@tyxla tyxla requested a review from mburridge July 5, 2023 12:08
@tyxla tyxla self-assigned this Jul 5, 2023
@tyxla tyxla requested a review from ellatrix as a code owner July 5, 2023 12:08
Copy link
Contributor

@mburridge mburridge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great. Thanks @tyxla. The only thing I would add, if possible, is a screen shot showing the component. Quite a few of the readme's have a screen shot, such as the Block Card component.

Admittedly quite a few don't have a screen shot, so it's fine without, but I think it's a "nice to have". Feel free to merge either way.

Thanks again.

@tyxla
Copy link
Member Author

tyxla commented Jul 5, 2023

The only thing I would add, if possible, is a screen shot showing the component. Quite a few of the readme's have a screen shot, such as the Block Card component.

Admittedly quite a few don't have a screen shot, so it's fine without, but I think it's a "nice to have". Feel free to merge either way.

Thanks for pointing that out. I'd say I intentionally didn't add a screenshot here since this is an adapter component - it doesn't do much more than reorganize the props and pass them down to PanelColorGradientSettings. The visual part comes from the underlying PanelColorGradientSettings, and if we're to add a screenshot, we should add it under that one's README.

@tyxla tyxla merged commit 454452e into trunk Jul 5, 2023
@tyxla tyxla deleted the add/panel-color-settings-readme branch July 5, 2023 14:37
@github-actions github-actions bot added this to the Gutenberg 16.2 milestone Jul 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Block editor /packages/block-editor [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add README.md file for panel-color-settings component
2 participants