Skip to content
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.

Sign up for GitHub

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

Incorporate getBlockLabel into useBlockDisplayInformation #29010

Closed
wants to merge 6 commits into from
Closed

Incorporate getBlockLabel into useBlockDisplayInformation #29010

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7543572
Incorporate getLabel into useBlockDisplayInformation
david-szabo97 Feb 15, 2021
759f113
Update readme
david-szabo97 Feb 15, 2021
c1dad7a
Update test
david-szabo97 Feb 15, 2021
723590a
Fix documentation
david-szabo97 Feb 16, 2021
e903a4f
Add e2e test
david-szabo97 Feb 16, 2021
e08215b
Revert activateTheme
david-szabo97 Feb 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions packages/block-editor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -574,14 +574,16 @@ _Related_

<a name="useBlockDisplayInformation" href="#useBlockDisplayInformation">#</a> **useBlockDisplayInformation**

Hook used to try to find a matching block variation and return
the appropriate information for display reasons. In order to
to try to find a match we need to things:
Hook used appropriate information for display reasons.
It takes variations and custom `label` function into account.

In order to try to find a variation match we need to things:
1\. Block's client id to extract it's current attributes.
2\. A block variation should have set `isActive` prop to a proper function.

If for any reason a block variaton match cannot be found,
the returned information come from the Block Type.
Value from custom `label` function is prioritized, if that's not found
then the block variation' information is returned. If both are missing
then the information is returned from the Block Type.
If no blockType is found with the provided clientId, returns null.

_Parameters_
Expand Down
21 changes: 5 additions & 16 deletions packages/block-editor/src/components/block-title/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,7 @@ import { truncate } from 'lodash';
* WordPress dependencies
*/
import { useSelect } from '@wordpress/data';
import {
getBlockType,
__experimentalGetBlockLabel as getBlockLabel,
isReusableBlock,
} from '@wordpress/blocks';
import { getBlockType, isReusableBlock } from '@wordpress/blocks';

/**
* Internal dependencies
Expand All @@ -35,7 +31,7 @@ import { store as blockEditorStore } from '../../store';
* @return {?string} Block title.
*/
export default function BlockTitle( { clientId } ) {
const { attributes, name, reusableBlockTitle } = useSelect(
const { name, reusableBlockTitle } = useSelect(
( select ) => {
if ( ! clientId ) {
return {};
Expand All @@ -51,7 +47,6 @@ export default function BlockTitle( { clientId } ) {
}
const isReusable = isReusableBlock( getBlockType( blockName ) );
return {
attributes: getBlockAttributes( clientId ),
name: blockName,
reusableBlockTitle:
isReusable &&
Expand All @@ -65,13 +60,7 @@ export default function BlockTitle( { clientId } ) {

const blockInformation = useBlockDisplayInformation( clientId );
if ( ! name || ! blockInformation ) return null;
const blockType = getBlockType( name );
const label = reusableBlockTitle || getBlockLabel( blockType, attributes );
// Label will fallback to the title if no label is defined for the current
// label context. If the label is defined we prioritize it over possible
// possible block variation title match.
if ( label !== blockType.title ) {
return truncate( label, { length: 35 } );
}
return blockInformation.title;

const label = reusableBlockTitle || blockInformation.title;
return truncate( label, { length: 35 } );
}
18 changes: 4 additions & 14 deletions packages/block-editor/src/components/block-title/test/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,26 +30,16 @@ jest.mock( '@wordpress/blocks', () => {
return { title: 'Block With Long Label' };
}
},
__experimentalGetBlockLabel( { title } ) {
switch ( title ) {
case 'Block With Label':
return 'Test Label';

case 'Block With Long Label':
return 'This is a longer label than typical for blocks to have.';

default:
return title;
}
},
};
} );

jest.mock( '../../use-block-display-information', () => {
const resultsMap = {
'id-name-exists': { title: 'Block Title' },
'id-name-with-label': { title: 'Block With Label' },
'id-name-with-long-label': { title: 'Block With Long Label' },
'id-name-with-label': { title: 'Test Label' },
'id-name-with-long-label': {
title: 'This is a longer label than typical for blocks to have.',
},
};
return jest.fn( ( clientId ) => resultsMap[ clientId ] );
} );
Expand Down
13 changes: 9 additions & 4 deletions packages/block-editor/src/components/use-block-display-information/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
# useBlockDisplayInformation

A React Hook that tries to find a matching block variation and returns the appropriate information for display reasons. In order to try to find a match we need two things:
Hook used appropriate information for display reasons.
david-szabo97 marked this conversation as resolved.
Show resolved Hide resolved
It takes variations and custom `label` function into account.

1. Block's client id to extract its current attributes.
2. A block variation has `isActive` prop defined with a matcher function.
In order to try to find a variation match we need to things:
david-szabo97 marked this conversation as resolved.
Show resolved Hide resolved
1\. Block's client id to extract it's current attributes.
david-szabo97 marked this conversation as resolved.
Show resolved Hide resolved
2\. A block variation should have set `isActive` prop to a proper function.

If for any reason a block variaton match cannot be found, the returned information come from the Block Type.
Value from custom `label` function is prioritized, if that's not found
then the block variation' information is returned. If both are missing
then the information is returned from the Block Type.
If no blockType is found with the provided clientId, returns null.

### Usage

Expand Down
61 changes: 41 additions & 20 deletions packages/block-editor/src/components/use-block-display-information/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
* WordPress dependencies
*/
import { useSelect } from '@wordpress/data';
import { store as blocksStore } from '@wordpress/blocks';
import {
store as blocksStore,
__experimentalGetBlockLabel as getBlockLabel,
} from '@wordpress/blocks';

/**
* Internal dependencies
Expand All @@ -22,49 +25,67 @@ import { store as blockEditorStore } from '../../store';
*/

/**
* Hook used to try to find a matching block variation and return
* the appropriate information for display reasons. In order to
* to try to find a match we need to things:
* Hook used appropriate information for display reasons.
* It takes variations and custom `label` function into account.
*
* In order to try to find a variation match we need to things:
* 1. Block's client id to extract it's current attributes.
* 2. A block variation should have set `isActive` prop to a proper function.
*
* If for any reason a block variaton match cannot be found,
* the returned information come from the Block Type.
* Value from custom `label` function is prioritized, if that's not found
* then the block variation' information is returned. If both are missing
* then the information is returned from the Block Type.
* If no blockType is found with the provided clientId, returns null.
*
* @param {string} clientId Block's client id.
* @return {?WPBlockDisplayInformation} Block's display information, or `null` when the block or its type not found.
*/

export default function useBlockDisplayInformation( clientId ) {
return useSelect(
( select ) => {
if ( ! clientId ) return null;

const { getBlockName, getBlockAttributes } = select(
blockEditorStore
);
const { getBlockType, getBlockVariations } = select( blocksStore );

const blockName = getBlockName( clientId );
const blockType = getBlockType( blockName );
if ( ! blockType ) return null;

const variations = getBlockVariations( blockName );
const blockTypeInfo = {
title: blockType.title,
icon: blockType.icon,
description: blockType.description,
};
if ( ! variations?.length ) return blockTypeInfo;
const attributes = getBlockAttributes( clientId );
const match = variations.find( ( variation ) =>
variation.isActive?.( attributes, variation.attributes )
);
if ( ! match ) return blockTypeInfo;

const dynamicTitle = getBlockLabel( blockType, attributes );
const variationInfo = getVariationInfo( variations, attributes );

const title =
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The use of the getBlockLabel to generate a "dynamic" title makes sense to me, but, with that being said, I don't have a lot of historical context with use-block-display-information.

Also, @david-szabo97, do you happen to know what the exact differences are between a block label and title? The label appears to be a canonical name, while the title is something customized by the user (definitely correct me if I'm wrong).

Copy link
Contributor

@talldan talldan Feb 16, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The label appears to be a canonical name, while the title is something customized by the user (definitely correct me if I'm wrong).

Title is generally the hard-coded block name (e.g. 'Heading'), the label is the value returned by the __experimentalLabel property on a block's declaration. It's generally one of the attributes that represents what the user has 'labelled' a block, but it's not defined for every block.

edit: sorry, revised this comment a few times as my first interpretation was wrong.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I see -- I had it reversed in my head. This makes sense. Thanks @talldan!

dynamicTitle && dynamicTitle !== blockType.title
? dynamicTitle
: variationInfo.title || blockType.title;
const icon = variationInfo.icon || blockType.icon;
const description =
variationInfo.description || blockType.description;

return {
title: match.title || blockType.title,
icon: match.icon || blockType.icon,
description: match.description || blockType.description,
title,
icon,
description,
};
},
[ clientId ]
);
}

function getVariationInfo( variations, attributes ) {
const emptyInfo = { title: null, icon: null, description: null };
if ( ! variations?.length ) {
return emptyInfo;
}

const match = variations.find( ( variation ) =>
variation.isActive?.( attributes, variation.attributes )
);
return match || emptyInfo;
}