Add method to name custom entity props

[richtabor]

What problem does this address?

When useEntityProp( 'root', 'site', 'title' ) is used, the entity is named "Title" within the confirmation step when saving changes.

Is there a method for naming custom entity props, to improve the UX of editing/saving them? Currently the option_name displays, instead of using a proper title, which makes it less clear what's actually being saved.

What is your proposed solution?

Have a method for assigning a name/title that displays when saving an entity prop, instead of the option_name.

Screenshots

Modifying the site title entity, displays as "Title"

Modifying a site option entity, displays the option_name

[adamziel]

It looks like each Site property is listed separately in that sidebar:

gutenberg/packages/editor/src/components/entities-saved-states/index.js

Lines 57 to 64 in 56df22d

	for ( const property in siteEdits ) {
	siteEditsAsEntities.push( {
	kind: 'root',
	name: 'site',
	title: TRANSLATED_SITE_PROPERTIES[ property ] || property,
	property,
	} );
	}

The culprit is that some properties use a human-readable label such as "Title", but the other ones are just passed verbatim, which is what you see. I wonder what a solution would look like, aside of course of allowing the developer to specify that 🤔

[adamziel]

To document some thoughts from slack,

Rich said:

If I'm updating a site setting. Then having it say a human readable title would be better than the option name

To which Adam replied:

A larger list of hardcoded labels would be an easy step to making it better. Ideally it would cover all the site options shipped with core. Then, there are custom options provided by plugins, I guess plugins would have to provide these labels.

[adamziel]

A minimal improvement would be adding more settings to this list:

gutenberg/packages/editor/src/components/entities-saved-states/index.js

Lines 23 to 30 in 56df22d

	const TRANSLATED_SITE_PROPERTIES = {
	title: __( 'Title' ),
	description: __( 'Tagline' ),
	site_logo: __( 'Logo' ),
	site_icon: __( 'Icon' ),
	show_on_front: __( 'Show on front' ),
	page_on_front: __( 'Page on front' ),
	};

Then, to allow plugin authors to supply their own labels, we'd likely need to create a new filter and then apply it to that list using applyFilters from @wordpress/hooks. Perhaps around the following line?

gutenberg/packages/editor/src/components/entities-saved-states/index.js

Line 61 in 56df22d

title: TRANSLATED_SITE_PROPERTIES[ property ] || property,

[Mamaduka]

Maybe labels can be a part of the register_setting API. It currently supports the description argument. Then we'll need to figure out how to load this data for setting entities.

[ghost]

Subscribed. Would really like to see this feature in an upcoming update.