Docs: custom block category add icon info #11213
Conversation
chrisvanpatten
left a comment
chrisvanpatten
left a comment
There was a problem hiding this comment.
Just a few small suggestions :)
Co-Authored-By: ajitbohra <[email protected]>
chrisvanpatten
left a comment
chrisvanpatten
left a comment
There was a problem hiding this comment.
Approving but also it'd be great to get width/height attributes in as per my comment.
| 'slug' => 'my-category', | ||
| 'title' => __( 'My category', 'my-plugin' ), | ||
| 'icon' => 'screenoptions', | ||
| 'icon' => '<svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill="none" d="M0 0h24v24H0V0z" /><path d="M19 13H5v-2h14v2z" /></svg>', |
There was a problem hiding this comment.
Small thing, but we also want to encourage block devs to include width and height attributes.
There was a problem hiding this comment.
Icon component is used to render proper icons and currently, it enforces default width for dashicons and svg icons. Let me know if should add the width/height to the example.
There was a problem hiding this comment.
If there's a default width that works I think this is fine.
| add_filter( 'block_categories', 'my_plugin_block_categories', 10, 2 ); | ||
| ``` | ||
|
|
||
| You can also display an icon with your block category by setting an `icon` attribute. The value can be the slug of a [WordPress Dashicon](https://developer.wordpress.org/resource/dashicons/), or a custom `svg` element. |
There was a problem hiding this comment.
FWIW, components and functions are supported as well - you can refer to https://github.com/wordpress/gutenberg/blob/729fa981795ba1ca90c90eccff6b8e6da38d19f9/packages/components/src/icon/README.md for details, or maybe link to it here in the docs.
There was a problem hiding this comment.
Would be good to link to Icon component for all available options. I guess the same is applicable for block icon also as we are using the same icon component.
There was a problem hiding this comment.
These are PHP docs though, so referencing a component or function isn't really applicable. I think this README is fine.
With #10651 custom block categories can have a custom icon.
This PR adds the same to docs https://wordpress.org/gutenberg/handbook/extensibility/extending-blocks/#managing-block-categories
cc: @tyxla