@wordpress/edit-site 5.5.0 → 5.7.0

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

@@ -17,23 +17,36 @@ import SidebarNavigationScreen from '../sidebar-navigation-screen';
 import SidebarNavigationItem from '../sidebar-navigation-item';
 
 export default function SidebarNavigationScreenMain() {
-	const { navigationMenus } = useSelect( ( select ) => {
-		const { getEntityRecords } = select( coreStore );
-		return {
-			navigationMenus: getEntityRecords( 'postType', 'wp_navigation', {
-				per_page: -1,
+	const hasNavigationMenus = useSelect( ( select ) => {
+		// The query needs to be the same as in the "SidebarNavigationScreenNavigationMenus" component,
+		// to avoid double network calls.
+		const navigationMenus = select( coreStore ).getEntityRecords(
+			'postType',
+			'wp_navigation',
+			{
+				per_page: 1,
 				status: 'publish',
-			} ),
-		};
+				order: 'desc',
+				orderby: 'date',
+			}
+		);
+
+		return navigationMenus?.length > 0;
 	} );
 
+	const showNavigationScreen = process.env.IS_GUTENBERG_PLUGIN
+		? hasNavigationMenus
+		: false;
 	return (
 		<SidebarNavigationScreen
 			isRoot
 			title={ __( 'Design' ) }
+			description={ __(
+				'Customize the appearance of your website using the block editor.'
+			) }
 			content={
 				<ItemGroup>
-					{ !! navigationMenus && navigationMenus.length > 0 && (
+					{ showNavigationScreen && (
 						<NavigatorButton
 							as={ SidebarNavigationItem }
 							path="/navigation"

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

@@ -2,9 +2,12 @@
  * WordPress dependencies
  */
 import { __ } from '@wordpress/i18n';
-import { useDispatch, useSelect } from '@wordpress/data';
-import { __experimentalUseNavigator as useNavigator } from '@wordpress/components';
-import { store as coreStore } from '@wordpress/core-data';
+import { useDispatch } from '@wordpress/data';
+import {
+	__experimentalUseNavigator as useNavigator,
+	ExternalLink,
+} from '@wordpress/components';
+import { useEntityRecord } from '@wordpress/core-data';
 import { decodeEntities } from '@wordpress/html-entities';
 import { pencil } from '@wordpress/icons';
 
@@ -21,26 +24,11 @@ export default function SidebarNavigationScreenNavigationItem() {
 	const {
 		params: { postType, postId },
 	} = useNavigator();
-
-	const { post } = useSelect(
-		( select ) => {
-			const { getEntityRecord } = select( coreStore );
-
-			// The currently selected entity to display.
-			// Typically template or template part in the site editor.
-			return {
-				post:
-					postId && postType
-						? getEntityRecord( 'postType', postType, postId )
-						: null,
-			};
-		},
-		[ postType, postId ]
-	);
+	const { record } = useEntityRecord( 'postType', postType, postId );
 
 	return (
 		<SidebarNavigationScreen
-			title={ post ? decodeEntities( post?.title?.rendered ) : null }
+			title={ record ? decodeEntities( record?.title?.rendered ) : null }
 			actions={
 				<SidebarButton
 					onClick={ () => setCanvasMode( 'edit' ) }
@@ -48,8 +36,29 @@ export default function SidebarNavigationScreenNavigationItem() {
 					icon={ pencil }
 				/>
 			}
+			description={
+				postType === 'page'
+					? __(
+							'Pages are static and are not listed by date. Pages do not use tags or categories.'
+					  )
+					: __(
+							'Posts are entries listed in reverse chronological order on the site homepage or on the posts page.'
+					  )
+			}
 			content={
-				post ? decodeEntities( post?.description?.rendered ) : null
+				<>
+					{ record?.link ? (
+						<ExternalLink
+							className="edit-site-sidebar-navigation-screen__page-link"
+							href={ record.link }
+						>
+							{ record.link }
+						</ExternalLink>
+					) : null }
+					{ record
+						? decodeEntities( record?.description?.rendered )
+						: null }
+				</>
 			}
 		/>
 	);

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

@@ -2,17 +2,76 @@
  * WordPress dependencies
  */
 import { __ } from '@wordpress/i18n';
-import { useCallback } from '@wordpress/element';
+import { useCallback, useMemo } from '@wordpress/element';
+import { useSelect } from '@wordpress/data';
+import { store as coreStore } from '@wordpress/core-data';
+import { BlockEditorProvider } from '@wordpress/block-editor';
+import { createBlock } from '@wordpress/blocks';
 
 /**
  * Internal dependencies
  */
 import SidebarNavigationScreen from '../sidebar-navigation-screen';
-import NavigationInspector from '../navigation-inspector';
 import { useHistory } from '../routes';
+import NavigationMenuContent from './navigation-menu-content';
+import { NavigationMenuLoader } from './loader';
+import { unlock } from '../../private-apis';
+import { store as editSiteStore } from '../../store';
+
+const noop = () => {};
+const NAVIGATION_MENUS_QUERY = {
+	per_page: 1,
+	status: 'publish',
+	order: 'desc',
+	orderby: 'date',
+};
+
+function SidebarNavigationScreenWrapper( { children, actions } ) {
+	return (
+		<SidebarNavigationScreen
+			title={ __( 'Navigation' ) }
+			actions={ actions }
+			description={ __(
+				'Browse your site, edit pages, and manage your primary navigation menu.'
+			) }
+			content={ children }
+		/>
+	);
+}
 
 export default function SidebarNavigationScreenNavigationMenus() {
 	const history = useHistory();
+	const { navigationMenus, hasResolvedNavigationMenus, storedSettings } =
+		useSelect( ( select ) => {
+			const { getSettings } = unlock( select( editSiteStore ) );
+			const { getEntityRecords, hasFinishedResolution } =
+				select( coreStore );
+
+			const navigationMenusQuery = [
+				'postType',
+				'wp_navigation',
+				NAVIGATION_MENUS_QUERY,
+			];
+			return {
+				storedSettings: getSettings( false ),
+				navigationMenus: getEntityRecords( ...navigationMenusQuery ),
+				hasResolvedNavigationMenus: hasFinishedResolution(
+					'getEntityRecords',
+					navigationMenusQuery
+				),
+			};
+		}, [] );
+
+	const firstNavigationMenu = navigationMenus?.[ 0 ]?.id;
+	const blocks = useMemo( () => {
+		return [
+			createBlock( 'core/navigation', { ref: firstNavigationMenu } ),
+		];
+	}, [ firstNavigationMenu ] );
+
+	const isLoading = ! hasResolvedNavigationMenus;
+	const hasNavigationMenus = !! navigationMenus?.length;
+
 	const onSelect = useCallback(
 		( selectedBlock ) => {
 			const { attributes, name } = selectedBlock;
@@ -36,14 +95,38 @@ export default function SidebarNavigationScreenNavigationMenus() {
 		},
 		[ history ]
 	);
+
+	if ( hasResolvedNavigationMenus && ! hasNavigationMenus ) {
+		return (
+			<SidebarNavigationScreenWrapper>
+				{ __( 'There are no Navigation Menus.' ) }
+			</SidebarNavigationScreenWrapper>
+		);
+	}
+
+	if ( ! hasResolvedNavigationMenus || isLoading ) {
+		return (
+			<SidebarNavigationScreenWrapper>
+				<NavigationMenuLoader />
+			</SidebarNavigationScreenWrapper>
+		);
+	}
+
 	return (
-		<SidebarNavigationScreen
-			title={ __( 'Navigation' ) }
-			content={
-				<div className="edit-site-sidebar-navigation-screen-navigation-menus">
-					<NavigationInspector onSelect={ onSelect } />
+		<BlockEditorProvider
+			settings={ storedSettings }
+			value={ blocks }
+			onChange={ noop }
+			onInput={ noop }
+		>
+			<SidebarNavigationScreenWrapper>
+				<div className="edit-site-sidebar-navigation-screen-navigation-menus__content">
+					<NavigationMenuContent
+						rootClientId={ blocks[ 0 ].clientId }
+						onSelect={ onSelect }
+					/>
 				</div>
-			}
-		/>
+			</SidebarNavigationScreenWrapper>
+		</BlockEditorProvider>
 	);
 }

package/src/components/sidebar-navigation-screen-navigation-menus/loader.js

@@ -0,0 +1,9 @@
+export function NavigationMenuLoader() {
+	return (
+		<>
+			<div className="edit-site-sidebar-navigation-screen-navigation-menus__placeholder" />
+			<div className="edit-site-sidebar-navigation-screen-navigation-menus__placeholder" />
+			<div className="edit-site-sidebar-navigation-screen-navigation-menus__placeholder" />
+		</>
+	);
+}

package/src/components/sidebar-navigation-screen-navigation-menus/navigation-menu-content.js

@@ -0,0 +1,78 @@
+/**
+ * WordPress dependencies
+ */
+import {
+	privateApis as blockEditorPrivateApis,
+	store as blockEditorStore,
+	BlockList,
+	BlockTools,
+} from '@wordpress/block-editor';
+import { useDispatch, useSelect } from '@wordpress/data';
+import { createBlock } from '@wordpress/blocks';
+import { useCallback } from '@wordpress/element';
+
+/**
+ * Internal dependencies
+ */
+import { unlock } from '../../private-apis';
+import { NavigationMenuLoader } from './loader';
+
+export default function NavigationMenuContent( { rootClientId, onSelect } ) {
+	const { clientIdsTree, isLoading } = useSelect(
+		( select ) => {
+			const { __unstableGetClientIdsTree, areInnerBlocksControlled } =
+				select( blockEditorStore );
+			return {
+				clientIdsTree: __unstableGetClientIdsTree( rootClientId ),
+
+				// This is a small hack to wait for the navigation block
+				// to actually load its inner blocks.
+				isLoading: ! areInnerBlocksControlled( rootClientId ),
+			};
+		},
+		[ rootClientId ]
+	);
+	const { replaceBlock, __unstableMarkNextChangeAsNotPersistent } =
+		useDispatch( blockEditorStore );
+
+	const { OffCanvasEditor, LeafMoreMenu } = unlock( blockEditorPrivateApis );
+
+	const offCanvasOnselect = useCallback(
+		( block ) => {
+			if (
+				block.name === 'core/navigation-link' &&
+				! block.attributes.url
+			) {
+				__unstableMarkNextChangeAsNotPersistent();
+				replaceBlock(
+					block.clientId,
+					createBlock( 'core/navigation-link', block.attributes )
+				);
+			} else {
+				onSelect( block );
+			}
+		},
+		[ onSelect, __unstableMarkNextChangeAsNotPersistent, replaceBlock ]
+	);
+
+	// The hidden block is needed because it makes block edit side effects trigger.
+	// For example a navigation page list load its items has an effect on edit to load its items.
+	return (
+		<>
+			{ isLoading && <NavigationMenuLoader /> }
+			{ ! isLoading && (
+				<OffCanvasEditor
+					blocks={ clientIdsTree }
+					onSelect={ offCanvasOnselect }
+					LeafMoreMenu={ LeafMoreMenu }
+					showAppender={ false }
+				/>
+			) }
+			<div style={ { visibility: 'hidden' } }>
+				<BlockTools>
+					<BlockList />
+				</BlockTools>
+			</div>
+		</>
+	);
+}

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

@@ -1,8 +1,115 @@
-.edit-site-sidebar-navigation-screen-navigation-menus {
+.edit-site-sidebar-navigation-screen__description {
+	margin: 0 0 $grid-unit-40 $grid-unit-20;
+}
+
+.edit-site-sidebar-navigation-screen-navigation-menus__placeholder {
+	padding: $grid-unit-10;
+	margin: $grid-unit-10;
+	background-color: $gray-100;
+	animation: loadingpulse 1s linear infinite;
+	animation-delay: 0.5s; // avoid animating for fast network responses
+}
+
+@keyframes loadingpulse {
+	0% {
+		opacity: 1;
+	}
+	50% {
+		opacity: 0.5;
+	}
+	100% {
+		opacity: 1;
+	}
+}
+
+.edit-site-sidebar-navigation-screen-navigation-menus__content {
 	.offcanvas-editor-list-view-leaf {
 		max-width: calc(100% - #{ $grid-unit-05 });
+		border-radius: $radius-block-ui;
+		&:hover,
+		&:focus,
+		&[aria-current] {
+			background: $gray-800;
+		}
+		.block-editor-list-view-block__menu {
+			margin-left: -$grid-unit-10;
+		}
+		&.is-selected {
+			> td {
+				background: transparent;
+			}
+
+			.block-editor-list-view-block-contents {
+				color: inherit;
+			}
+
+			&:not(:hover) {
+				.block-editor-list-view-block__menu {
+					opacity: 0;
+				}
+			}
+
+			&:hover,
+			&:focus {
+				color: $white;
+
+				.block-editor-list-view-block__menu-cell {
+					opacity: 1;
+				}
+			}
+
+			.block-editor-list-view-block__menu {
+				opacity: 1;
+
+				&:focus {
+					box-shadow: inset 0 0 0 var(--wp-admin-border-width-focus) var(--wp-admin-theme-color);
+				}
+			}
+		}
+
+		.block-editor-list-view-block-contents {
+			&:focus {
+				&::after {
+					box-shadow: inset 0 0 0 var(--wp-admin-border-width-focus) var(--wp-admin-theme-color);
+				}
+			}
+		}
+
+		&.is-branch-selected:not(.is-selected):not(.is-synced-branch) {
+			background: transparent;
+
+			&:hover {
+				background: $gray-800;
+			}
+		}
 	}
+
 	.block-editor-list-view-leaf .block-editor-list-view-block__contents-cell {
 		width: 100%;
 	}
+
+	.block-editor-list-view-leaf .block-editor-list-view-block-contents {
+		white-space: normal;
+	}
+
+	.block-editor-list-view-block__title {
+		margin-top: 3px;
+	}
+
+	.block-editor-list-view-block__menu-cell {
+		padding-right: 0;
+	}
+
+	.components-button {
+		color: $gray-600;
+		&:hover,
+		&:focus,
+		&[aria-current] {
+			color: $white;
+		}
+	}
+}
+
+.edit-site-sidebar-navigation-screen-navigation-menus__content .popover-slot .wp-block-navigation-submenu {
+	display: none;
 }

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

@@ -1,9 +1,14 @@
 /**
  * WordPress dependencies
  */
-import { __ } from '@wordpress/i18n';
-import { useDispatch } from '@wordpress/data';
+import { __, sprintf, _x } from '@wordpress/i18n';
+import { useDispatch, useSelect } from '@wordpress/data';
 import { pencil } from '@wordpress/icons';
+import {
+	__experimentalUseNavigator as useNavigator,
+	Icon,
+} from '@wordpress/components';
+import { store as coreStore } from '@wordpress/core-data';
 
 /**
  * Internal dependencies
@@ -13,20 +18,86 @@ import useEditedEntityRecord from '../use-edited-entity-record';
 import { unlock } from '../../private-apis';
 import { store as editSiteStore } from '../../store';
 import SidebarButton from '../sidebar-button';
+import { useAddedBy } from '../list/added-by';
+
+function useTemplateTitleAndDescription( postType, postId ) {
+	const { getDescription, getTitle, record } = useEditedEntityRecord(
+		postType,
+		postId
+	);
+	const currentTheme = useSelect(
+		( select ) => select( coreStore ).getCurrentTheme(),
+		[]
+	);
+	const addedBy = useAddedBy( postType, postId );
+	const isAddedByActiveTheme =
+		addedBy.type === 'theme' && record.theme === currentTheme?.stylesheet;
+	const title = getTitle();
+	let descriptionText = getDescription();
+
+	if ( ! descriptionText && addedBy.text ) {
+		if ( record.type === 'wp_template' && record.is_custom ) {
+			descriptionText = __(
+				'This is a custom template that can be applied manually to any Post or Page.'
+			);
+		} else if ( record.type === 'wp_template_part' ) {
+			descriptionText = sprintf(
+				// translators: %s: template part title e.g: "Header".
+				__( 'This is your %s template part.' ),
+				getTitle()
+			);
+		}
+	}
+
+	const description = (
+		<>
+			{ descriptionText }
+
+			{ addedBy.text && ! isAddedByActiveTheme && (
+				<span className="edit-site-sidebar-navigation-screen-template__added-by-description">
+					<span className="edit-site-sidebar-navigation-screen-template__added-by-description-author">
+						<span className="edit-site-sidebar-navigation-screen-template__added-by-description-author-icon">
+							{ addedBy.imageUrl ? (
+								<img
+									src={ addedBy.imageUrl }
+									alt=""
+									width="24"
+									height="24"
+								/>
+							) : (
+								<Icon icon={ addedBy.icon } />
+							) }
+						</span>
+						{ addedBy.text }
+					</span>
+
+					{ addedBy.isCustomized && (
+						<span className="edit-site-sidebar-navigation-screen-template__added-by-description-customized">
+							{ postType === 'wp_template'
+								? _x( '(Customized)', 'template' )
+								: _x( '(Customized)', 'template part' ) }
+						</span>
+					) }
+				</span>
+			) }
+		</>
+	);
+
+	return { title, description };
+}
 
 export default function SidebarNavigationScreenTemplate() {
+	const { params } = useNavigator();
+	const { postType, postId } = params;
 	const { setCanvasMode } = unlock( useDispatch( editSiteStore ) );
-	const { getDescription, getTitle, record } = useEditedEntityRecord();
-	let description = getDescription();
-	if ( ! description && record.is_custom ) {
-		description = __(
-			'This is a custom template that can be applied manually to any Post or Page.'
-		);
-	}
+	const { title, description } = useTemplateTitleAndDescription(
+		postType,
+		postId
+	);
 
 	return (
 		<SidebarNavigationScreen
-			title={ getTitle() }
+			title={ title }
 			actions={
 				<SidebarButton
 					onClick={ () => setCanvasMode( 'edit' ) }
@@ -34,7 +105,7 @@ export default function SidebarNavigationScreenTemplate() {
 					icon={ pencil }
 				/>
 			}
-			content={ description ? <p>{ description }</p> : undefined }
+			description={ description }
 		/>
 	);
 }

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

@@ -0,0 +1,25 @@
+.edit-site-sidebar-navigation-screen-template__added-by-description {
+	display: flex;
+	align-items: center;
+	justify-content: space-between;
+	margin-top: $grid-unit-30;
+
+	&-author {
+		display: inline-flex;
+		align-items: center;
+
+		img {
+			border-radius: $grid-unit-15;
+		}
+
+		svg {
+			fill: $gray-600;
+		}
+
+		&-icon {
+			width: 24px;
+			height: 24px;
+			margin-right: $grid-unit-10;
+		}
+	}
+}

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

@@ -29,6 +29,9 @@ const config = {
 			loading: __( 'Loading templates' ),
 			notFound: __( 'No templates found' ),
 			manage: __( 'Manage all templates' ),
+			description: __(
+				'Express the layout of your site with templates.'
+			),
 		},
 	},
 	wp_template_part: {
@@ -37,6 +40,9 @@ const config = {
 			loading: __( 'Loading template parts' ),
 			notFound: __( 'No template parts found' ),
 			manage: __( 'Manage all template parts' ),
+			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.'
+			),
 		},
 	},
 };
@@ -80,6 +86,7 @@ export default function SidebarNavigationScreenTemplates() {
 		<SidebarNavigationScreen
 			isRoot={ isTemplatePartsMode }
 			title={ config[ postType ].labels.title }
+			description={ config[ postType ].labels.description }
 			actions={
 				canCreate && (
 					<AddNewTemplate

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

@@ -12,9 +12,15 @@ import SidebarNavigationScreen from '../sidebar-navigation-screen';
 const config = {
 	wp_template: {
 		title: __( 'All templates' ),
+		description: __(
+			'Create new templates, or reset any customizations made to the templates supplied by your theme.'
+		),
 	},
 	wp_template_part: {
 		title: __( 'All template parts' ),
+		description: __(
+			'Create new template parts, or reset any customizations made to the template parts supplied by your theme.'
+		),
 	},
 };
 
@@ -22,5 +28,10 @@ export default function SidebarNavigationScreenTemplatesBrowse() {
 	const {
 		params: { postType },
 	} = useNavigator();
-	return <SidebarNavigationScreen title={ config[ postType ].title } />;
+	return (
+		<SidebarNavigationScreen
+			title={ config[ postType ].title }
+			description={ config[ postType ].description }
+		/>
+	);
 }

package/src/components/site-hub/index.js

@@ -95,7 +95,11 @@ const SiteHub = forwardRef( ( props, ref ) => {
 					</Button>
 				</motion.div>
 
-				{ showLabels && <div>{ siteTitle }</div> }
+				{ showLabels && (
+					<div className="edit-site-site-hub__site-title">
+						{ siteTitle }
+					</div>
+				) }
 			</HStack>
 		</motion.div>
 	);

package/src/components/site-hub/style.scss

@@ -11,7 +11,7 @@
 
 .edit-site-site-hub__view-mode-toggle-container {
 	height: $header-height;
-	width: $header-height + 4px;
+	width: $header-height;
 	flex-shrink: 0;
 	background: $gray-900;
 }
@@ -26,3 +26,7 @@
 	white-space: nowrap;
 	overflow: hidden;
 }
+
+.edit-site-site-hub__site-title {
+	margin-left: $grid-unit-05;
+}