-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
Include icon in documentation for MediaPlaceholder #15585
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.
Hi @LeonBlade, thank you for your contribution. I left some comments but overall the change looks good.
packages/block-editor/src/components/media-placeholder/README.md
Outdated
Show resolved
Hide resolved
@@ -65,6 +65,13 @@ Class name added to the placeholder. | |||
- Type: `String` | |||
- Required: No | |||
|
|||
### icon | |||
|
|||
Dashicon to display left of the title. |
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.
Maybe we can link to the Dashicon docs https://developer.wordpress.org/resource/dashicons/ and refer that a normal WordPress component could also be passed.
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.
Good idea, I've gone ahead and referenced the docs and the normal component as well, specifically mentioning BlockIcon
, as I've seen it being used in other parts of Gutenberg already for MediaPlaceholder
.
I've amended the docs to include a link to Dashicons which will better explain what to specify. I've also included mention of the other possible argument being a |
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.
Looks good with changes incorporated 👍
Description
Just adds
icon
to theREADME
.How has this been tested?
N/A
Screenshots
N/A
Types of changes
Simple README tweak.
Checklist: