Add block description component

[swissspidy]

This is something that came up in #1440, #1467, and #1545.

The component is actually quite simple and could be added to the inspector like this:

<InspectorControls key="inspector">
	<BlockDescription>
		<p>{ __( 'Hello World' ) }</p>
	</BlockDescription>
</InspectorControls>

Now, when there are other components after it, it looks like this:

As you can see, there's a thin border being added. If it's the only component, it looks like this:

Perhaps the border should be added manually using an attribute or a <hr />, not sure what's the best approach.

Feedback welcome.

[youknowriad]

I like it but this could be a functional component, no need for a class.

[youknowriad]

I guess this component should be moved to the blocks module next to the BlockControls, InspectorControls, ...

[swissspidy]

I actually tested it as a functional component in that folder at first but wasn't sure if it's correct / the best approach. Happy to move it.

[swissspidy]

@youknowriad It's now a functional component just like you suggested.

[ahmadawais]

This is a great idea, looking forward to it being merged!

[youknowriad]

Nice 👍

[mtias]

Thanks!

[aduth]

Is there a reason this is a component and not just a localized property string of the block settings, similar to its title?

[swissspidy]

IIRC we discussed that a plain-text property string could be used for something else instead, like short descriptions somewhere à la register_post_type().

[StaggerLeee]

Those descriptions are of course of great help for Users at the beginning. But after Users see them few times they have to live with them in years to come.

Why not put a blue question icon somewhere, and set all descriptions there ?

[swissspidy]

@StaggerLeee That sounds like something that could be applied to other areas as well. Would you mind creating a new issue for this? Thanks!

[StaggerLeee]

Hi @swissspidy, it is here:
#2242