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

Exploration - Semantic template part contextual block patterns in inserter sidebar. #29595

Closed
wants to merge 3 commits into from
Closed

Exploration - Semantic template part contextual block patterns in inserter sidebar. #29595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2205f53
show template part specific patterns in inserter when in context
Addison-Stavlo Mar 5, 2021
9636b08
update category name and label to use block name and block label
Addison-Stavlo Mar 5, 2021
36e828e
try replace all template parts inner blocks when pattern is for templ…
Addison-Stavlo Mar 8, 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
92 changes: 92 additions & 0 deletions lib/block-patterns.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,95 @@
<!-- /wp:columns -->',
)
);

register_block_pattern(
'template-part/tt1-header',
array(
'title' => __( 'test-TT1 header', 'gutenberg' ),
'scope' => array(
'inserter' => false,
'block' => array( 'core/template-part' ),
'variation' => 'header',
),
'categories' => array( 'core/template-part_header' ),
'content' => '<!-- wp:spacer {"height":70} -->
<div style="height:70px" aria-hidden="true" class="wp-block-spacer"></div>
<!-- /wp:spacer -->

<!-- wp:columns {"align":"wide"} -->
<div class="wp-block-columns alignwide"><!-- wp:column -->
<div class="wp-block-column"><!-- wp:site-title /-->

<!-- wp:site-tagline /--></div>
<!-- /wp:column -->

<!-- wp:column -->
<div class="wp-block-column">
<!-- wp:navigation {"orientation":"horizontal","itemsJustification":"right"} /-->
</div>
<!-- /wp:column --></div>
<!-- /wp:columns -->

<!-- wp:spacer {"height":70} -->
<div style="height:70px" aria-hidden="true" class="wp-block-spacer"></div>
<!-- /wp:spacer -->',
)
);

register_block_pattern(
'template-part/tt1-footer',
array(
'title' => __( 'test-TT1 footer', 'gutenberg' ),
'scope' => array(
'inserter' => false,
'block' => array( 'core/template-part' ),
'variation' => 'footer',
),
'categories' => array( 'core/template-part_footer' ),
'content' => '<!-- wp:spacer {"height":70} -->
<div style="height:70px" aria-hidden="true" class="wp-block-spacer"></div>
<!-- /wp:spacer -->

<!-- wp:columns {"align":"wide"} -->
<div class="wp-block-columns alignwide"><!-- wp:column -->
<div class="wp-block-column"><!-- wp:paragraph -->
<p><a href="mailto:#">example@example.com<br></a>T. +00 (0)1 22 33 44 55</p>
<!-- /wp:paragraph --></div>
<!-- /wp:column -->
<!-- wp:column -->
<div class="wp-block-column"><!-- wp:paragraph {"align":"center"} -->
<p class="has-text-align-center">2, Rue Louis-Boilly<br>Paris, France</p>
<!-- /wp:paragraph --></div>
<!-- /wp:column -->
<!-- wp:column {"verticalAlignment":"center"} -->
<div class="wp-block-column is-vertically-aligned-center"><!-- wp:social-links {"align":"right","className":"is-style-twentytwentyone-social-icons-color"} -->
<ul class="wp-block-social-links alignright is-style-twentytwentyone-social-icons-color"><!-- wp:social-link {"url":"https://wordpress.org","service":"wordpress"} /-->
<!-- wp:social-link {"url":"https://www.facebook.com/WordPress/","service":"facebook"} /-->
<!-- wp:social-link {"url":"https://twitter.com/WordPress","service":"twitter"} /-->
<!-- wp:social-link {"url":"https://www.youtube.com/wordpress","service":"youtube"} /--></ul>
<!-- /wp:social-links --></div>
<!-- /wp:column --></div>
<!-- /wp:columns -->

<!-- wp:spacer {"height":70} -->
<div style="height:70px" aria-hidden="true" class="wp-block-spacer"></div>
<!-- /wp:spacer -->

<!-- wp:separator {"align":"wide","className":"is-style-twentytwentyone-separator-thick"} -->
<hr class="wp-block-separator alignwide is-style-twentytwentyone-separator-thick"/>
<!-- /wp:separator -->

<!-- wp:columns {"align":"wide"} -->
<div class="wp-block-columns alignwide"><!-- wp:column {"verticalAlignment":"center"} -->
<div class="wp-block-column is-vertically-aligned-center"><!-- wp:site-title /--></div>
<!-- /wp:column -->

<!-- wp:column {"verticalAlignment":"center"} -->
<div class="wp-block-column is-vertically-aligned-center"><!-- wp:paragraph {"align":"right"} -->
<p class="has-text-align-right">Proudly powered by <a href="https://wordpress.org/">WordPress</a>.</p>
<!-- /wp:paragraph --></div>
<!-- /wp:column --></div>
<!-- /wp:columns -->',
)
);

18 changes: 16 additions & 2 deletions packages/block-editor/src/components/inserter/hooks/use-insertion-point.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,10 +106,24 @@ function useInsertionPoint( {
} = useDispatch( blockEditorStore );

const onInsertBlocks = useCallback(
( blocks, meta, shouldForceFocusBlock = false ) => {
(
blocks,
meta,
shouldForceFocusBlock = false,
__experimentalReplaceInnerBlocks = false,
innerBlocksToReplace = []
) => {
const selectedBlock = getSelectedBlock();

if (
if ( __experimentalReplaceInnerBlocks ) {
replaceBlocks(
innerBlocksToReplace,
blocks,
null,
shouldFocusBlock || shouldForceFocusBlock ? 0 : null,
meta
);
} else if (
! isAppender &&
selectedBlock &&
isUnmodifiedDefaultBlock( selectedBlock )
Expand Down
100 changes: 93 additions & 7 deletions packages/block-editor/src/components/inserter/hooks/use-patterns-state.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,12 @@ import { map } from 'lodash';
* WordPress dependencies
*/
import { useCallback } from '@wordpress/element';
import { cloneBlock } from '@wordpress/blocks';
import {
store as blocksStore,
cloneBlock,
__experimentalGetBlockLabel as getBlockLabel,
getBlockType,
} from '@wordpress/blocks';
import { useDispatch, useSelect } from '@wordpress/data';
import { __, sprintf } from '@wordpress/i18n';
import { store as noticesStore } from '@wordpress/notices';
Expand All @@ -26,29 +31,104 @@ import { store as blockEditorStore } from '../../../store';
* @return {Array} Returns the patterns state. (patterns, categories, onSelect handler)
*/
const usePatternsState = ( onInsert, rootClientId ) => {
const { patternCategories, patterns } = useSelect(
const {
patternCategories,
patterns,
activeTemplatePartId,
innerBlocksToReplace,
} = useSelect(
( select ) => {
const { __experimentalGetAllowedPatterns, getSettings } = select(
blockEditorStore
);

const _activeTemplatePartId = select(
blockEditorStore
).__experimentalGetActiveBlockIdByBlockNames( [
'core/template-part',
] );

const contextualPatterns = {
patterns: [],
patternCategories: [],
};

if ( _activeTemplatePartId ) {
const block = select( blockEditorStore ).getBlock(
_activeTemplatePartId
);
const variations = select( blocksStore ).getBlockVariations(
'core/template-part'
);

const activeVariation = variations.find( ( variation ) =>
variation.isActive?.(
block.attributes,
variation.attributes
)
);

const templatePartpatterns = select(
blockEditorStore
).__experimentalGetScopedBlockPatterns(
'block',
'core/template-part'
);

const contextualInserterPatterns = templatePartpatterns.filter(
( pattern ) =>
pattern.scope.variation === activeVariation?.name
);

contextualPatterns.patterns = contextualInserterPatterns;
contextualPatterns.patternCategories = [
{
name: `${ block.name }_` + activeVariation.name,
label: getBlockLabel(
getBlockType( block.name ),
block.attributes
),
},
];
}

const inserterPatterns = __experimentalGetAllowedPatterns(
rootClientId
).filter(
( pattern ) => ! pattern.scope || pattern.scope.inserter
);

return {
patterns: inserterPatterns,
patternCategories: getSettings()
.__experimentalBlockPatternCategories,
patterns: [
...contextualPatterns.patterns,
...inserterPatterns,
],
patternCategories: [
...contextualPatterns.patternCategories,
...getSettings().__experimentalBlockPatternCategories,
],
activeTemplatePartId: _activeTemplatePartId,
innerBlocksToReplace: _activeTemplatePartId
? select( blockEditorStore )
.getBlocks( _activeTemplatePartId )
.map( ( item ) => item.clientId )
: [],
};
},
[ rootClientId ]
);
const { createSuccessNotice } = useDispatch( noticesStore );
const onClickPattern = useCallback( ( pattern, blocks ) => {
const shouldReplaceInnerBlocks =
!! activeTemplatePartId &&
pattern.scope?.block?.includes( 'core/template-part' );

onInsert(
map( blocks, ( block ) => cloneBlock( block ) ),
pattern.name
pattern.name,
false,
shouldReplaceInnerBlocks,
innerBlocksToReplace
);
createSuccessNotice(
sprintf(
Expand All @@ -62,7 +142,13 @@ const usePatternsState = ( onInsert, rootClientId ) => {
);
}, [] );

return [ patterns, patternCategories, onClickPattern ];
return [
patterns,
patternCategories,
onClickPattern,
activeTemplatePartId,
innerBlocksToReplace,
];
};

export default usePatternsState;
16 changes: 14 additions & 2 deletions packages/block-editor/src/components/inserter/menu.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,20 @@ function InserterMenu( {
);

const onInsertPattern = useCallback(
( blocks, patternName ) => {
onInsertBlocks( blocks, { patternName } );
(
blocks,
patternName,
shouldForceFocusBlock,
shouldReplaceInnerBlocks,
innerBlocksToReplace
) => {
onInsertBlocks(
blocks,
{ patternName },
shouldForceFocusBlock,
shouldReplaceInnerBlocks,
innerBlocksToReplace
);
onSelect();
},
[ onInsertBlocks, onSelect ]
Expand Down