@wordpress/edit-site 5.12.5 → 5.12.7

package/src/components/sidebar-navigation-screen-pattern/index.js

@@ -1,10 +1,11 @@
 /**
  * WordPress dependencies
  */
-import { __ } from '@wordpress/i18n';
+import { __experimentalUseNavigator as useNavigator } from '@wordpress/components';
 import { useDispatch } from '@wordpress/data';
+import { __ } from '@wordpress/i18n';
 import { pencil } from '@wordpress/icons';
-import { __experimentalUseNavigator as useNavigator } from '@wordpress/components';
+import { getQueryArgs } from '@wordpress/url';
 
 /**
  * Internal dependencies
@@ -13,19 +14,26 @@ import SidebarButton from '../sidebar-button';
 import SidebarNavigationScreen from '../sidebar-navigation-screen';
 import useInitEditedEntityFromURL from '../sync-state-with-url/use-init-edited-entity-from-url';
 import usePatternDetails from './use-pattern-details';
-import useNavigationMenuContent from './use-navigation-menu-content';
 import { store as editSiteStore } from '../../store';
 import { unlock } from '../../lock-unlock';
 
 export default function SidebarNavigationScreenPattern() {
 	const { params } = useNavigator();
+	const { categoryType } = getQueryArgs( window.location.href );
 	const { postType, postId } = params;
 	const { setCanvasMode } = unlock( useDispatch( editSiteStore ) );
 
 	useInitEditedEntityFromURL();
 
 	const patternDetails = usePatternDetails( postType, postId );
-	const content = useNavigationMenuContent( postType, postId );
+
+	// The absence of a category type in the query params for template parts
+	// indicates the user has arrived at the template part via the "manage all"
+	// page and the back button should return them to that list page.
+	const backPath =
+		! categoryType && postType === 'wp_template_part'
+			? '/wp_template_part/all'
+			: '/patterns';
 
 	return (
 		<SidebarNavigationScreen
@@ -36,8 +44,7 @@ export default function SidebarNavigationScreenPattern() {
 					icon={ pencil }
 				/>
 			}
-			backPath={ '/library' }
-			content={ content }
+			backPath={ backPath }
 			{ ...patternDetails }
 		/>
 	);

package/src/components/sidebar-navigation-screen-pattern/style.scss

@@ -23,3 +23,7 @@
 	height: 24px;
 	margin-right: $grid-unit-10;
 }
+
+.edit-site-sidebar-navigation-screen-pattern__lock-icon {
+	display: inline-flex;
+}

package/src/components/sidebar-navigation-screen-pattern/use-pattern-details.js

@@ -11,7 +11,14 @@ import { Icon } from '@wordpress/components';
  */
 import { useAddedBy } from '../list/added-by';
 import useEditedEntityRecord from '../use-edited-entity-record';
+import useNavigationMenuContent from './use-navigation-menu-content';
 import SidebarNavigationScreenDetailsFooter from '../sidebar-navigation-screen-details-footer';
+import {
+	SidebarNavigationScreenDetailsPanel,
+	SidebarNavigationScreenDetailsPanelRow,
+	SidebarNavigationScreenDetailsPanelLabel,
+	SidebarNavigationScreenDetailsPanelValue,
+} from '../sidebar-navigation-screen-details-panel';
 
 export default function usePatternDetails( postType, postId ) {
 	const { getDescription, getTitle, record } = useEditedEntityRecord(
@@ -31,7 +38,7 @@ export default function usePatternDetails( postType, postId ) {
 	if ( ! descriptionText && addedBy.text ) {
 		descriptionText = sprintf(
 			// translators: %s: pattern title e.g: "Header".
-			__( 'This is your %s pattern.' ),
+			__( 'This is the %s pattern.' ),
 			getTitle()
 		);
 	}
@@ -39,7 +46,7 @@ export default function usePatternDetails( postType, postId ) {
 	if ( ! descriptionText && postType === 'wp_block' && record?.title ) {
 		descriptionText = sprintf(
 			// translators: %s: user created pattern title e.g. "Footer".
-			__( 'This is your %s pattern.' ),
+			__( 'This is the %s pattern.' ),
 			record.title
 		);
 	}
@@ -82,5 +89,40 @@ export default function usePatternDetails( postType, postId ) {
 		/>
 	) : null;
 
-	return { title, description, footer };
+	const details = [];
+
+	if ( postType === 'wp_block' ) {
+		details.push( {
+			label: __( 'Syncing' ),
+			value:
+				record.wp_pattern_sync_status === 'unsynced'
+					? __( 'Not synced' )
+					: __( 'Fully synced' ),
+		} );
+	}
+
+	const content = (
+		<>
+			{ !! details.length && (
+				<SidebarNavigationScreenDetailsPanel
+					spacing={ 5 }
+					title={ __( 'Details' ) }
+				>
+					{ details.map( ( { label, value } ) => (
+						<SidebarNavigationScreenDetailsPanelRow key={ label }>
+							<SidebarNavigationScreenDetailsPanelLabel>
+								{ label }
+							</SidebarNavigationScreenDetailsPanelLabel>
+							<SidebarNavigationScreenDetailsPanelValue>
+								{ value }
+							</SidebarNavigationScreenDetailsPanelValue>
+						</SidebarNavigationScreenDetailsPanelRow>
+					) ) }
+				</SidebarNavigationScreenDetailsPanel>
+			) }
+			{ useNavigationMenuContent( postType, postId ) }
+		</>
+	);
+
+	return { title, description, content, footer };
 }

package/src/components/{sidebar-navigation-screen-library → sidebar-navigation-screen-patterns}/category-item.js

@@ -14,15 +14,15 @@ export default function CategoryItem( {
 } ) {
 	const linkInfo = useLink(
 		{
-			path: '/library',
+			path: '/patterns',
 			categoryType: type,
 			categoryId: id,
 		},
 		{
 			// Keep a record of where we came from in state so we can
-			// use the browser's back button to go back to the library.
+			// use the browser's back button to go back to Patterns.
 			// See the implementation of the back button in patterns-list.
-			backPath: '/library',
+			backPath: '/patterns',
 		}
 	);
 

package/src/components/sidebar-navigation-screen-patterns/index.js

@@ -0,0 +1,199 @@
+/**
+ * WordPress dependencies
+ */
+import {
+	__experimentalItemGroup as ItemGroup,
+	__experimentalItem as Item,
+	Flex,
+	Icon,
+	Tooltip,
+	__experimentalHeading as Heading,
+} from '@wordpress/components';
+import { useViewportMatch } from '@wordpress/compose';
+import { useSelect } from '@wordpress/data';
+import { getTemplatePartIcon } from '@wordpress/editor';
+import { __ } from '@wordpress/i18n';
+import { getQueryArgs } from '@wordpress/url';
+import { file, starFilled, lockSmall } from '@wordpress/icons';
+
+/**
+ * Internal dependencies
+ */
+import AddNewPattern from '../add-new-pattern';
+import SidebarNavigationItem from '../sidebar-navigation-item';
+import SidebarNavigationScreen from '../sidebar-navigation-screen';
+import CategoryItem from './category-item';
+import { DEFAULT_CATEGORY, DEFAULT_TYPE } from '../page-patterns/utils';
+import { store as editSiteStore } from '../../store';
+import { useLink } from '../routes/link';
+import usePatternCategories from './use-pattern-categories';
+import useMyPatterns from './use-my-patterns';
+import useTemplatePartAreas from './use-template-part-areas';
+
+function TemplatePartGroup( { areas, currentArea, currentType } ) {
+	return (
+		<>
+			<div className="edit-site-sidebar-navigation-screen-patterns__group-header">
+				<Heading level={ 2 }>{ __( 'Template parts' ) }</Heading>
+				<p>{ __( 'Synced patterns for use in template building.' ) }</p>
+			</div>
+			<ItemGroup className="edit-site-sidebar-navigation-screen-patterns__group">
+				{ Object.entries( areas ).map(
+					( [ area, { label, templateParts } ] ) => (
+						<CategoryItem
+							key={ area }
+							count={ templateParts?.length }
+							icon={ getTemplatePartIcon( area ) }
+							label={ label }
+							id={ area }
+							type="wp_template_part"
+							isActive={
+								currentArea === area &&
+								currentType === 'wp_template_part'
+							}
+						/>
+					)
+				) }
+			</ItemGroup>
+		</>
+	);
+}
+
+function ThemePatternsGroup( { categories, currentCategory, currentType } ) {
+	return (
+		<>
+			<div className="edit-site-sidebar-navigation-screen-patterns__group-header">
+				<Heading level={ 2 }>{ __( 'Theme patterns' ) }</Heading>
+				<p>
+					{ __(
+						'For insertion into documents where they can then be customized.'
+					) }
+				</p>
+			</div>
+			<ItemGroup className="edit-site-sidebar-navigation-screen-patterns__group">
+				{ categories.map( ( category ) => (
+					<CategoryItem
+						key={ category.name }
+						count={ category.count }
+						label={
+							<Flex justify="left" align="center" gap={ 0 }>
+								{ category.label }
+								<Tooltip
+									position="top center"
+									text={ __(
+										'Theme patterns cannot be edited.'
+									) }
+								>
+									<span className="edit-site-sidebar-navigation-screen-pattern__lock-icon">
+										<Icon icon={ lockSmall } size={ 24 } />
+									</span>
+								</Tooltip>
+							</Flex>
+						}
+						icon={ file }
+						id={ category.name }
+						type="pattern"
+						isActive={
+							currentCategory === `${ category.name }` &&
+							currentType === 'pattern'
+						}
+					/>
+				) ) }
+			</ItemGroup>
+		</>
+	);
+}
+
+export default function SidebarNavigationScreenPatterns() {
+	const isMobileViewport = useViewportMatch( 'medium', '<' );
+	const { categoryType, categoryId } = getQueryArgs( window.location.href );
+	const currentCategory = categoryId || DEFAULT_CATEGORY;
+	const currentType = categoryType || DEFAULT_TYPE;
+
+	const { templatePartAreas, hasTemplateParts, isLoading } =
+		useTemplatePartAreas();
+	const { patternCategories, hasPatterns } = usePatternCategories();
+	const { myPatterns, hasPatterns: hasMyPatterns } = useMyPatterns();
+
+	const isTemplatePartsMode = useSelect( ( select ) => {
+		const settings = select( editSiteStore ).getSettings();
+		return !! settings.supportsTemplatePartsMode;
+	}, [] );
+
+	const templatePartsLink = useLink( { path: '/wp_template_part/all' } );
+	const footer = ! isMobileViewport ? (
+		<ItemGroup>
+			<SidebarNavigationItem withChevron { ...templatePartsLink }>
+				{ __( 'Manage all template parts' ) }
+			</SidebarNavigationItem>
+			<SidebarNavigationItem
+				as="a"
+				href="edit.php?post_type=wp_block"
+				withChevron
+			>
+				{ __( 'Manage all of my patterns' ) }
+			</SidebarNavigationItem>
+		</ItemGroup>
+	) : undefined;
+
+	return (
+		<SidebarNavigationScreen
+			isRoot={ isTemplatePartsMode }
+			title={ __( 'Patterns' ) }
+			description={ __(
+				'Manage what patterns are available when editing the site.'
+			) }
+			actions={ <AddNewPattern /> }
+			footer={ footer }
+			content={
+				<>
+					{ isLoading && __( 'Loading patterns' ) }
+					{ ! isLoading && (
+						<>
+							{ ! hasTemplateParts && ! hasPatterns && (
+								<ItemGroup className="edit-site-sidebar-navigation-screen-patterns__group">
+									<Item>
+										{ __(
+											'No template parts or patterns found'
+										) }
+									</Item>
+								</ItemGroup>
+							) }
+							{ hasMyPatterns && (
+								<ItemGroup className="edit-site-sidebar-navigation-screen-patterns__group">
+									<CategoryItem
+										key={ myPatterns.name }
+										count={ myPatterns.count }
+										label={ myPatterns.label }
+										icon={ starFilled }
+										id={ myPatterns.name }
+										type="wp_block"
+										isActive={
+											currentCategory ===
+												`${ myPatterns.name }` &&
+											currentType === 'wp_block'
+										}
+									/>
+								</ItemGroup>
+							) }
+							{ hasTemplateParts && (
+								<TemplatePartGroup
+									areas={ templatePartAreas }
+									currentArea={ currentCategory }
+									currentType={ currentType }
+								/>
+							) }
+							{ hasPatterns && (
+								<ThemePatternsGroup
+									categories={ patternCategories }
+									currentCategory={ currentCategory }
+									currentType={ currentType }
+								/>
+							) }
+						</>
+					) }
+				</>
+			}
+		/>
+	);
+}

package/src/components/sidebar-navigation-screen-patterns/style.scss

@@ -0,0 +1,28 @@
+.edit-site-sidebar-navigation-screen-patterns__group {
+	margin-bottom: $grid-unit-40;
+	padding-bottom: $grid-unit-30;
+	border-bottom: 1px solid $gray-800;
+
+	&:last-of-type,
+	&:first-of-type {
+		border-bottom: 0;
+		padding-bottom: 0;
+		margin-bottom: 0;
+	}
+
+	&:first-of-type {
+		margin-bottom: $grid-unit-40;
+	}
+}
+
+.edit-site-sidebar-navigation-screen-patterns__group-header {
+	p {
+		color: $gray-600;
+	}
+
+	h2 {
+		font-size: 11px;
+		font-weight: 500;
+		text-transform: uppercase;
+	}
+}

package/src/components/sidebar-navigation-screen-patterns/use-my-patterns.js

@@ -0,0 +1,23 @@
+/**
+ * WordPress dependencies
+ */
+import { store as coreStore } from '@wordpress/core-data';
+import { useSelect } from '@wordpress/data';
+import { __ } from '@wordpress/i18n';
+
+export default function useMyPatterns() {
+	const myPatterns = useSelect( ( select ) =>
+		select( coreStore ).getEntityRecords( 'postType', 'wp_block', {
+			per_page: -1,
+		} )
+	);
+
+	return {
+		myPatterns: {
+			count: myPatterns?.length || 0,
+			name: 'my-patterns',
+			label: __( 'My patterns' ),
+		},
+		hasPatterns: !! myPatterns?.length,
+	};
+}

package/src/components/{sidebar-navigation-screen-library → sidebar-navigation-screen-patterns}/use-pattern-categories.js

@@ -1,10 +1,7 @@
 /**
  * WordPress dependencies
  */
-import { store as coreStore } from '@wordpress/core-data';
-import { useSelect } from '@wordpress/data';
 import { useMemo } from '@wordpress/element';
-import { __ } from '@wordpress/i18n';
 
 /**
  * Internal dependencies
@@ -15,11 +12,6 @@ import useThemePatterns from './use-theme-patterns';
 export default function usePatternCategories() {
 	const defaultCategories = useDefaultPatternCategories();
 	const themePatterns = useThemePatterns();
-	const userPatterns = useSelect( ( select ) =>
-		select( coreStore ).getEntityRecords( 'postType', 'wp_block', {
-			per_page: -1,
-		} )
-	);
 
 	const patternCategories = useMemo( () => {
 		const categoryMap = {};
@@ -48,17 +40,8 @@ export default function usePatternCategories() {
 			}
 		} );
 
-		// Add "Your Patterns" category for user patterns if there are any.
-		if ( userPatterns?.length ) {
-			categoriesWithCounts.push( {
-				count: userPatterns.length || 0,
-				name: 'custom-patterns',
-				label: __( 'Custom patterns' ),
-			} );
-		}
-
 		return categoriesWithCounts;
-	}, [ defaultCategories, themePatterns, userPatterns ] );
+	}, [ defaultCategories, themePatterns ] );
 
 	return { patternCategories, hasPatterns: !! patternCategories.length };
 }

package/src/components/sidebar-navigation-screen-patterns/use-template-part-areas.js

@@ -0,0 +1,55 @@
+/**
+ * WordPress dependencies
+ */
+import { useEntityRecords } from '@wordpress/core-data';
+import { useSelect } from '@wordpress/data';
+import { store as editorStore } from '@wordpress/editor';
+
+const useTemplatePartsGroupedByArea = ( items ) => {
+	const allItems = items || [];
+
+	const templatePartAreas = useSelect(
+		( select ) =>
+			select( editorStore ).__experimentalGetDefaultTemplatePartAreas(),
+		[]
+	);
+
+	// Create map of template areas ensuring that default areas are displayed before
+	// any custom registered template part areas.
+	const knownAreas = {
+		header: {},
+		footer: {},
+		sidebar: {},
+		uncategorized: {},
+	};
+
+	templatePartAreas.forEach(
+		( templatePartArea ) =>
+			( knownAreas[ templatePartArea.area ] = {
+				...templatePartArea,
+				templateParts: [],
+			} )
+	);
+
+	const groupedByArea = allItems.reduce( ( accumulator, item ) => {
+		const key = accumulator[ item.area ] ? item.area : 'uncategorized';
+		accumulator[ key ].templateParts.push( item );
+		return accumulator;
+	}, knownAreas );
+
+	return groupedByArea;
+};
+
+export default function useTemplatePartAreas() {
+	const { records: templateParts, isResolving: isLoading } = useEntityRecords(
+		'postType',
+		'wp_template_part',
+		{ per_page: -1 }
+	);
+
+	return {
+		hasTemplateParts: templateParts ? !! templateParts.length : false,
+		isLoading,
+		templatePartAreas: useTemplatePartsGroupedByArea( templateParts ),
+	};
+}

package/src/components/{sidebar-navigation-screen-library → sidebar-navigation-screen-patterns}/use-theme-patterns.js

@@ -11,7 +11,7 @@ import { useMemo } from '@wordpress/element';
 import {
 	CORE_PATTERN_SOURCES,
 	filterOutDuplicatesByName,
-} from '../page-library/utils';
+} from '../page-patterns/utils';
 import { unlock } from '../../lock-unlock';
 import { store as editSiteStore } from '../../store';
 

package/src/components/sidebar-navigation-screen-templates/index.js

@@ -4,14 +4,12 @@
 import {
 	__experimentalItemGroup as ItemGroup,
 	__experimentalItem as Item,
-	__experimentalUseNavigator as useNavigator,
 } from '@wordpress/components';
 import { __ } from '@wordpress/i18n';
 import { useEntityRecords } from '@wordpress/core-data';
 import { useSelect } from '@wordpress/data';
 import { decodeEntities } from '@wordpress/html-entities';
 import { useViewportMatch } from '@wordpress/compose';
-import { getTemplatePartIcon } from '@wordpress/editor';
 
 /**
  * Internal dependencies
@@ -23,48 +21,6 @@ import AddNewTemplate from '../add-new-template';
 import { store as editSiteStore } from '../../store';
 import SidebarButton from '../sidebar-button';
 
-const config = {
-	wp_template: {
-		labels: {
-			title: __( 'Templates' ),
-			loading: __( 'Loading templates' ),
-			notFound: __( 'No templates found' ),
-			manage: __( 'Manage all templates' ),
-			description: __(
-				'Express the layout of your site with templates.'
-			),
-		},
-	},
-	wp_template_part: {
-		labels: {
-			title: __( 'Library' ),
-			loading: __( 'Loading library' ),
-			notFound: __( 'No patterns found' ),
-			manage: __( 'Manage all template parts' ),
-			reusableBlocks: __( 'Manage patterns' ),
-			description: __(
-				'Template Parts are small pieces of a layout that can be reused across multiple templates and always appear the same way. Common template parts include the site header, footer, or sidebar.'
-			),
-		},
-		sortCallback: ( items ) => {
-			const groupedByArea = items.reduce(
-				( accumulator, item ) => {
-					const key = accumulator[ item.area ] ? item.area : 'rest';
-					accumulator[ key ].push( item );
-					return accumulator;
-				},
-				{ header: [], footer: [], sidebar: [], rest: [] }
-			);
-			return [
-				...groupedByArea.header,
-				...groupedByArea.footer,
-				...groupedByArea.sidebar,
-				...groupedByArea.rest,
-			];
-		},
-	},
-};
-
 const TemplateItem = ( { postType, postId, ...props } ) => {
 	const linkInfo = useLink( {
 		postType,
@@ -74,9 +30,6 @@ const TemplateItem = ( { postType, postId, ...props } ) => {
 };
 
 export default function SidebarNavigationScreenTemplates() {
-	const {
-		params: { postType },
-	} = useNavigator();
 	const isMobileViewport = useViewportMatch( 'medium', '<' );
 	const isTemplatePartsMode = useSelect( ( select ) => {
 		const settings = select( editSiteStore ).getSettings();
@@ -86,34 +39,30 @@ export default function SidebarNavigationScreenTemplates() {
 
 	const { records: templates, isResolving: isLoading } = useEntityRecords(
 		'postType',
-		postType,
+		'wp_template',
 		{
 			per_page: -1,
 		}
 	);
-	let sortedTemplates = templates ? [ ...templates ] : [];
+
+	const sortedTemplates = templates ? [ ...templates ] : [];
 	sortedTemplates.sort( ( a, b ) =>
 		a.title.rendered.localeCompare( b.title.rendered )
 	);
-	if ( config[ postType ].sortCallback ) {
-		sortedTemplates = config[ postType ].sortCallback( sortedTemplates );
-	}
-
-	const browseAllLink = useLink( {
-		path: '/' + postType + '/all',
-	} );
 
+	const browseAllLink = useLink( { path: '/wp_template/all' } );
 	const canCreate = ! isMobileViewport && ! isTemplatePartsMode;
-	const isTemplateList = postType === 'wp_template';
 	return (
 		<SidebarNavigationScreen
 			isRoot={ isTemplatePartsMode }
-			title={ config[ postType ].labels.title }
-			description={ config[ postType ].labels.description }
+			title={ __( 'Templates' ) }
+			description={ __(
+				'Express the layout of your site with templates'
+			) }
 			actions={
 				canCreate && (
 					<AddNewTemplate
-						templateType={ postType }
+						templateType={ 'wp_template' }
 						toggleProps={ {
 							as: SidebarButton,
 						} }
@@ -122,24 +71,18 @@ export default function SidebarNavigationScreenTemplates() {
 			}
 			content={
 				<>
-					{ isLoading && config[ postType ].labels.loading }
+					{ isLoading && __( 'Loading templates' ) }
 					{ ! isLoading && (
 						<ItemGroup>
 							{ ! templates?.length && (
-								<Item>
-									{ config[ postType ].labels.notFound }
-								</Item>
+								<Item>{ __( 'No templates found' ) }</Item>
 							) }
 							{ sortedTemplates.map( ( template ) => (
 								<TemplateItem
-									postType={ postType }
+									postType={ 'wp_template' }
 									postId={ template.id }
 									key={ template.id }
 									withChevron
-									icon={
-										! isTemplateList &&
-										getTemplatePartIcon( template.area )
-									}
 								>
 									{ decodeEntities(
 										template.title?.rendered ||
@@ -153,19 +96,9 @@ export default function SidebarNavigationScreenTemplates() {
 			}
 			footer={
 				! isMobileViewport && (
-					<>
-						<SidebarNavigationItem withChevron { ...browseAllLink }>
-							{ config[ postType ].labels.manage }
-						</SidebarNavigationItem>
-						{ !! config[ postType ].labels.reusableBlocks && (
-							<SidebarNavigationItem
-								as="a"
-								href="edit.php?post_type=wp_block"
-							>
-								{ config[ postType ].labels.reusableBlocks }
-							</SidebarNavigationItem>
-						) }
-					</>
+					<SidebarNavigationItem withChevron { ...browseAllLink }>
+						{ __( 'Manage all templates' ) }
+					</SidebarNavigationItem>
 				)
 			}
 		/>