Skip to content

Add: Mechanism to detect if a block instance matches a global styles selector #26945

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

Merged
jorgefilipecosta merged 1 commit into from
Nov 13, 2020
Merged

Add: Mechanism to detect if a block instance matches a global styles selector #26945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 8 additions & 4 deletions lib/class-wp-theme-json.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,12 +452,16 @@ public static function get_blocks_metadata() {
isset( $block_type->supports['__experimentalSelector'] ) &&
is_array( $block_type->supports['__experimentalSelector'] )
) {
foreach ( $block_type->supports['__experimentalSelector'] as $key => $selector ) {
foreach ( $block_type->supports['__experimentalSelector'] as $key => $selector_data ) {
self::$blocks_metadata[ $key ] = array(
'selector' => $selector,
'supports' => $block_supports,
'blockName' => $block_name,
'selector' => $selector_data['selector'],
'supports' => $block_supports,
'blockName' => $block_name,
'attributes' => $selector_data['attributes'],
);
if ( isset( $selector_data['title'] ) ) {
self::$blocks_metadata[ $key ]['title'] = $selector_data['title'];
}
}
} else {
self::$blocks_metadata[ $block_name ] = array(
Expand Down
39 changes: 34 additions & 5 deletions packages/block-editor/src/components/use-editor-feature/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* External dependencies
*/
import { get } from 'lodash';
import { get, isObject } from 'lodash';

/**
* WordPress dependencies
Expand Down Expand Up @@ -47,6 +47,15 @@ const deprecatedFlags = {
},
};

function blockAttributesMatch( blockAttributes, attributes ) {
for ( const attribute in attributes ) {
if ( attributes[ attribute ] !== blockAttributes[ attribute ] ) {
return false;
}
}
return true;
}

/**
* Hook that retrieves the setting for the given editor feature.
* It works with nested objects using by finding the value at path.
Expand All @@ -61,19 +70,39 @@ const deprecatedFlags = {
* ```
*/
export default function useEditorFeature( featurePath ) {
const { name: blockName } = useBlockEditContext();
const { name: blockName, clientId } = useBlockEditContext();

const setting = useSelect(
( select ) => {
const settings = select( 'core/block-editor' ).getSettings();
const { getBlockAttributes, getSettings } = select(
'core/block-editor'
);
const settings = getSettings();
const blockType = select( 'core/blocks' ).getBlockType( blockName );

let context = blockName;
const selectors = get( blockType, [
'supports',
'__experimentalSelector',
] );
if ( isObject( selectors ) ) {
const blockAttributes = getBlockAttributes( clientId );
for ( const contextSelector in selectors ) {
const { attributes } = selectors[ contextSelector ];
if ( blockAttributesMatch( blockAttributes, attributes ) ) {
context = contextSelector;
break;
}
}
}

// 1 - Use __experimental features, if available.
// We cascade to the global value if the block one is not available.
//
// TODO: make it work for blocks that define multiple selectors
// such as core/heading or core/post-title.
const globalPath = `__experimentalFeatures.global.${ featurePath }`;
const blockPath = `__experimentalFeatures.${ blockName }.${ featurePath }`;
const blockPath = `__experimentalFeatures.${ context }.${ featurePath }`;
const experimentalFeaturesResult =
get( settings, blockPath ) ?? get( settings, globalPath );
if ( experimentalFeaturesResult !== undefined ) {
Expand All @@ -94,7 +123,7 @@ export default function useEditorFeature( featurePath ) {
// To remove when __experimentalFeatures are ported to core.
return featurePath === 'typography.dropCap' ? true : undefined;
},
[ blockName, featurePath ]
[ blockName, clientId, featurePath ]
);

return setting;
Expand Down
48 changes: 42 additions & 6 deletions packages/block-library/src/heading/block.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,48 @@
"fontSize": true,
"lineHeight": true,
"__experimentalSelector": {
"core/heading/h1": "h1",
"core/heading/h2": "h2",
"core/heading/h3": "h3",
"core/heading/h4": "h4",
"core/heading/h5": "h5",
"core/heading/h6": "h6"
"core/heading/h1": {
"selector": "h1",
"title": "h1",
"attributes": {
"level": 1
}
},
"core/heading/h2": {
"selector": "h2",
"title": "h2",
"attributes": {
"level": 2
}
},
"core/heading/h3": {
"selector": "h3",
"title": "h3",
"attributes": {
"level": 3
}
},
"core/heading/h4": {
"selector": "h4",
"title": "h4",
"attributes": {
"level": 4
}
},
"core/heading/h5": {
"selector": "h5",
"title": "h5",
"attributes": {
"level": 5
}
},
"core/heading/h6": {
"selector": "h6",
"title": "h6",
"attributes": {
"level": 6
}
}
},
"__unstablePasteTextInline": true
}
Expand Down
48 changes: 42 additions & 6 deletions packages/block-library/src/post-title/block.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,48 @@
"lineHeight": true,
"__experimentalFontFamily": true,
"__experimentalSelector": {
"core/post-title/h1": "h1",
"core/post-title/h2": "h2",
"core/post-title/h3": "h3",
"core/post-title/h4": "h4",
"core/post-title/h5": "h5",
"core/post-title/h6": "h6"
"core/post-title/h1": {
"title": "h1",
"selector": "h1.wp-block-post-title",
"attributes": {
"level": 1
}
},
"core/post-title/h2": {
"title": "h2",
"selector": "h2.wp-block-post-title",
"attributes": {
"level": 2
}
},
"core/post-title/h3": {
"title": "h3",
"selector": "h3.wp-block-post-title",
"attributes": {
"level": 3
}
},
"core/post-title/h4": {
"title": "h4",
"selector": "h4.wp-block-post-title",
"attributes": {
"level": 4
}
},
"core/post-title/h5": {
"title": "h5",
"selector": "h5.wp-block-post-title",
"attributes": {
"level": 5
}
},
"core/post-title/h6": {
"title": "h6",
"selector": "h6.wp-block-post-title",
"attributes": {
"level": 6
}
}
}
}
}
2 changes: 1 addition & 1 deletion packages/edit-site/src/components/sidebar/global-styles-sidebar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ function GlobalStylesPanel( {

let panelTitle = blockType.title;
if ( 'object' === typeof blockType?.supports?.__experimentalSelector ) {
panelTitle += ` (${ context.selector })`;
panelTitle += ` (${ context.title })`;
}

return (
Expand Down