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

Jump to bottom

Patterns: Add user pattern categories to post editor inserter patterns tab #53933

Merged
merged 10 commits into from
Sep 14, 2023
Merged

Patterns: Add user pattern categories to post editor inserter patterns tab #53933

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
456134a
resolve conflict
glendaviesnz Aug 24, 2023
86cd3b8
Map category ids to slugs
glendaviesnz Aug 22, 2023
a70d3af
Update selector to use new category map
glendaviesnz Aug 24, 2023
49b855e
Mix user patterns into other pattern categories
glendaviesnz Aug 25, 2023
9d3f70b
Fix e2e tests
glendaviesnz Aug 25, 2023
84e4113
Another fix
glendaviesnz Aug 25, 2023
81ece3c
Fix typo
glendaviesnz Aug 28, 2023
e1c31ff
Remove uneeded dependency
glendaviesnz Aug 30, 2023
d2a48ce
Fix dependency and put user patterns at top of list
glendaviesnz Sep 3, 2023
a502b0a
Patterns: merge unsynced into inserter patterns tab and add paging an…
glendaviesnz Sep 14, 2023
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
4 changes: 2 additions & 2 deletions packages/block-editor/src/components/inserter/block-patterns-explorer/patterns-list.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ function PatternList( { filterValue, selectedCategory, patternCategories } ) {
const [ destinationRootClientId, onInsertBlocks ] = useInsertionPoint( {
shouldFocusBlock: true,
} );
const [ allPatterns, , onSelectBlockPattern ] = usePatternsState(
const { patterns: allPatterns, onClickPattern } = usePatternsState(
onInsertBlocks,
destinationRootClientId
);
Expand Down Expand Up @@ -116,7 +116,7 @@ function PatternList( { filterValue, selectedCategory, patternCategories } ) {
<BlockPatternsList
shownPatterns={ currentShownPatterns }
blockPatterns={ filteredBlockPatterns }
onClickPattern={ onSelectBlockPattern }
onClickPattern={ onClickPattern }
isDraggable={ false }
/>
) }
Expand Down
13 changes: 6 additions & 7 deletions packages/block-editor/src/components/inserter/block-patterns-tab.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ const noop = () => {};
// Preferred order of pattern categories. Any other categories should
// be at the bottom without any re-ordering.
const patternCategoriesOrder = [
'custom',
'featured',
'posts',
'text',
Expand All @@ -45,7 +44,7 @@ const patternCategoriesOrder = [
];

function usePatternsCategories( rootClientId ) {
const [ allPatterns, allCategories ] = usePatternsState(
const { patterns: allPatterns, allCategories } = usePatternsState(
undefined,
rootClientId
);
Expand All @@ -71,10 +70,10 @@ function usePatternsCategories( rootClientId ) {
pattern.categories?.includes( category.name )
)
)
.sort( ( { name: aName }, { name: bName } ) => {
.sort( ( { label: aLabel }, { label: bLabel } ) => {
// Sort categories according to `patternCategoriesOrder`.
let aIndex = patternCategoriesOrder.indexOf( aName );
let bIndex = patternCategoriesOrder.indexOf( bName );
let aIndex = patternCategoriesOrder.indexOf( aLabel );
let bIndex = patternCategoriesOrder.indexOf( bLabel );
// All other categories should come after that.
if ( aIndex < 0 ) aIndex = patternCategoriesOrder.length;
if ( bIndex < 0 ) bIndex = patternCategoriesOrder.length;
Expand Down Expand Up @@ -141,7 +140,7 @@ export function BlockPatternsCategoryPanel( {
category,
showTitlesAsTooltip,
} ) {
const [ allPatterns, , onClick ] = usePatternsState(
const { patterns: allPatterns, onClickPattern } = usePatternsState(
onInsert,
rootClientId
);
Expand Down Expand Up @@ -187,7 +186,7 @@ export function BlockPatternsCategoryPanel( {
<BlockPatternList
shownPatterns={ categoryPatternsList }
blockPatterns={ currentCategoryPatterns }
onClickPattern={ onClick }
onClickPattern={ onClickPattern }
onHover={ onHover }
label={ category.label }
orientation="vertical"
Expand Down
38 changes: 23 additions & 15 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 @@ -12,12 +12,6 @@ import { store as noticesStore } from '@wordpress/notices';
*/
import { store as blockEditorStore } from '../../../store';

const CUSTOM_CATEGORY = {
name: 'custom',
label: __( 'My patterns' ),
description: __( 'Custom patterns added by site users.' ),
};

/**
* Retrieves the block patterns inserter state.
*
Expand All @@ -27,24 +21,38 @@ const CUSTOM_CATEGORY = {
* @return {Array} Returns the patterns state. (patterns, categories, onSelect handler)
*/
const usePatternsState = ( onInsert, rootClientId ) => {
const { patternCategories, patterns } = useSelect(
const { patternCategories, patterns, userPatternCategories } = useSelect(
( select ) => {
const { __experimentalGetAllowedPatterns, getSettings } =
select( blockEditorStore );

const {
__experimentalUserPatternCategories,
__experimentalBlockPatternCategories,
} = getSettings();
return {
patterns: __experimentalGetAllowedPatterns( rootClientId ),
patternCategories:
getSettings().__experimentalBlockPatternCategories,
userPatternCategories:
__experimentalUserPatternCategories?.patternCategories,
patternCategories: __experimentalBlockPatternCategories,
};
},
[ rootClientId ]
);

const allCategories = useMemo(
() => [ ...patternCategories, CUSTOM_CATEGORY ],
[ patternCategories ]
);
const allCategories = useMemo( () => {
const categories = [ ...patternCategories ];
userPatternCategories?.forEach( ( userCategory ) => {
if (
! categories.find(
( existingCategory ) =>
existingCategory.name === userCategory.name
)
) {
categories.push( userCategory );
}
} );
return categories;
}, [ patternCategories, userPatternCategories ] );

const { createSuccessNotice } = useDispatch( noticesStore );
const onClickPattern = useCallback(
Expand All @@ -68,7 +76,7 @@ const usePatternsState = ( onInsert, rootClientId ) => {
[ createSuccessNotice, onInsert ]
);

return [ patterns, allCategories, onClickPattern ];
return { patterns, allCategories, onClickPattern };
};

export default usePatternsState;
2 changes: 1 addition & 1 deletion packages/block-editor/src/components/inserter/quick-inserter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export default function QuickInserter( {
onInsertBlocks
);

const [ patterns ] = usePatternsState(
const { patterns } = usePatternsState(
onInsertBlocks,
destinationRootClientId
);
Expand Down
4 changes: 2 additions & 2 deletions packages/block-editor/src/components/inserter/search-results.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ function InserterSearchResults( {
blockTypeCollections,
onSelectBlockType,
] = useBlockTypesState( destinationRootClientId, onInsertBlocks );
const [ patterns, , onSelectBlockPattern ] = usePatternsState(
const { patterns, onClickPattern } = usePatternsState(
onInsertBlocks,
destinationRootClientId
);
Expand Down Expand Up @@ -189,7 +189,7 @@ function InserterSearchResults( {
<BlockPatternsList
shownPatterns={ currentShownPatterns }
blockPatterns={ filteredBlockPatterns }
onClickPattern={ onSelectBlockPattern }
onClickPattern={ onClickPattern }
onHover={ onHoverPattern }
isDraggable={ isDraggable }
/>
Expand Down
16 changes: 14 additions & 2 deletions packages/block-editor/src/store/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2293,7 +2293,8 @@ const checkAllowListRecursive = ( blocks, allowedBlockTypes ) => {
function getUnsyncedPatterns( state ) {
const reusableBlocks =
state?.settings?.__experimentalReusableBlocks ?? EMPTY_ARRAY;

const { patternCategoriesMap: categories } =
state?.settings?.__experimentalUserPatternCategories ?? {};
return reusableBlocks
.filter(
( reusableBlock ) =>
Expand All @@ -2303,12 +2304,23 @@ function getUnsyncedPatterns( state ) {
return {
name: `core/block/${ reusableBlock.id }`,
title: reusableBlock.title.raw,
categories: [ 'custom' ],
categories: reusableBlock.wp_pattern_category.map( ( catId ) =>
categories && categories.get( catId )
? categories.get( catId ).slug
: catId
),
content: reusableBlock.content.raw,
};
} );
}

export const __experimentalUserPatternCategories = createSelector(
( state ) => {
return state?.settings?.__experimentalUserPatternCategories;
},
( state ) => [ state.settings.__experimentalUserPatternCategories ]
);

export const __experimentalGetParsedPattern = createSelector(
( state, patternName ) => {
const patterns = state.settings.__experimentalBlockPatterns;
Expand Down
2 changes: 1 addition & 1 deletion packages/editor/src/components/provider/use-block-editor-settings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,9 +220,9 @@ function useBlockEditorSettings( settings, hasTemplate ) {
settings,
hasUploadPermissions,
reusableBlocks,
userPatternCategories,
blockPatterns,
blockPatternCategories,
userPatternCategories,
canUseUnfilteredHTML,
undo,
hasTemplate,
Expand Down
Loading