Include icon in documentation for MediaPlaceholder #15585
Conversation
LeonBlade
requested review from
ellatrix,
gziolo,
noisysocks,
talldan and
youknowriad
as code owners
youknowriad
added
[Type] Developer Documentation
There was a problem hiding this comment.
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.
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.
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 |
Description
Just adds
iconto theREADME.How has this been tested?
N/A
Screenshots
N/A
Types of changes
Simple README tweak.
Checklist: