@wordpress/edit-site 5.4.0 → 5.6.0

package/src/components/list/added-by.js

@@ -1,3 +1,4 @@
+// @ts-check
 /**
  * External dependencies
  */
@@ -6,11 +7,7 @@ import classnames from 'classnames';
 /**
  * WordPress dependencies
  */
-import {
-	__experimentalHStack as HStack,
-	Icon,
-	Tooltip,
-} from '@wordpress/components';
+import { Icon, __experimentalHStack as HStack } from '@wordpress/components';
 import { store as coreStore } from '@wordpress/core-data';
 import { useSelect } from '@wordpress/data';
 import { useState } from '@wordpress/element';
@@ -20,171 +17,171 @@ import {
 	plugins as pluginIcon,
 	globe as globeIcon,
 } from '@wordpress/icons';
-import { __ } from '@wordpress/i18n';
+import { _x } from '@wordpress/i18n';
+
+/** @typedef {'wp_template'|'wp_template_part'} TemplateType */
 
+/** @type {TemplateType} */
 const TEMPLATE_POST_TYPE_NAMES = [ 'wp_template', 'wp_template_part' ];
 
-function CustomizedTooltip( { isCustomized, children } ) {
-	if ( ! isCustomized ) {
-		return children;
-	}
+/**
+ * @typedef {'theme'|'plugin'|'site'|'user'} AddedByType
+ *
+ * @typedef AddedByData
+ * @type {Object}
+ * @property {AddedByType}  type         The type of the data.
+ * @property {JSX.Element}  icon         The icon to display.
+ * @property {string}       [imageUrl]   The optional image URL to display.
+ * @property {string}       [text]       The text to display.
+ * @property {boolean}      isCustomized Whether the template has been customized.
+ *
+ * @param    {TemplateType} postType     The template post type.
+ * @param    {number}       postId       The template post id.
+ * @return {AddedByData} The added by object or null.
+ */
+export function useAddedBy( postType, postId ) {
+	return useSelect(
+		( select ) => {
+			const {
+				getTheme,
+				getPlugin,
+				getEntityRecord,
+				getMedia,
+				getUser,
+				getEditedEntityRecord,
+			} = select( coreStore );
+			const template = getEditedEntityRecord(
+				'postType',
+				postType,
+				postId
+			);
 
-	return (
-		<Tooltip text={ __( 'This template has been customized' ) }>
-			{ children }
-		</Tooltip>
+			if ( TEMPLATE_POST_TYPE_NAMES.includes( template.type ) ) {
+				// Added by theme.
+				// Template originally provided by a theme, but customized by a user.
+				// Templates originally didn't have the 'origin' field so identify
+				// older customized templates by checking for no origin and a 'theme'
+				// or 'custom' source.
+				if (
+					template.has_theme_file &&
+					( template.origin === 'theme' ||
+						( ! template.origin &&
+							[ 'theme', 'custom' ].includes(
+								template.source
+							) ) )
+				) {
+					return {
+						type: 'theme',
+						icon: themeIcon,
+						text:
+							getTheme( template.theme )?.name?.rendered ||
+							template.theme,
+						isCustomized: template.source === 'custom',
+					};
+				}
+
+				// Added by plugin.
+				if ( template.has_theme_file && template.origin === 'plugin' ) {
+					return {
+						type: 'plugin',
+						icon: pluginIcon,
+						text:
+							getPlugin( template.theme )?.name || template.theme,
+						isCustomized: template.source === 'custom',
+					};
+				}
+
+				// Added by site.
+				// Template was created from scratch, but has no author. Author support
+				// was only added to templates in WordPress 5.9. Fallback to showing the
+				// site logo and title.
+				if (
+					! template.has_theme_file &&
+					template.source === 'custom' &&
+					! template.author
+				) {
+					const siteData = getEntityRecord(
+						'root',
+						'__unstableBase'
+					);
+					return {
+						type: 'site',
+						icon: globeIcon,
+						imageUrl: siteData?.site_logo
+							? getMedia( siteData.site_logo )?.source_url
+							: undefined,
+						text: siteData?.name,
+						isCustomized: false,
+					};
+				}
+			}
+
+			// Added by user.
+			const user = getUser( template.author );
+			return {
+				type: 'user',
+				icon: authorIcon,
+				imageUrl: user?.avatar_urls?.[ 48 ],
+				text: user?.nickname,
+				isCustomized: false,
+			};
+		},
+		[ postType, postId ]
 	);
 }
 
-function BaseAddedBy( { text, icon, imageUrl, isCustomized } ) {
+/**
+ * @param {Object} props
+ * @param {string} props.imageUrl
+ */
+function AvatarImage( { imageUrl } ) {
 	const [ isImageLoaded, setIsImageLoaded ] = useState( false );
 
 	return (
-		<HStack alignment="left">
-			<CustomizedTooltip isCustomized={ isCustomized }>
-				{ imageUrl ? (
-					<div
-						className={ classnames(
-							'edit-site-list-added-by__avatar',
-							{
-								'is-loaded': isImageLoaded,
-							}
-						) }
-					>
-						<img
-							onLoad={ () => setIsImageLoaded( true ) }
-							alt=""
-							src={ imageUrl }
-						/>
-					</div>
-				) : (
-					<div
-						className={ classnames(
-							'edit-site-list-added-by__icon',
-							{
-								'is-customized': isCustomized,
-							}
-						) }
-					>
-						<Icon icon={ icon } />
-					</div>
-				) }
-			</CustomizedTooltip>
-			<span>{ text }</span>
-		</HStack>
-	);
-}
-
-function AddedByTheme( { slug, isCustomized } ) {
-	const theme = useSelect(
-		( select ) => select( coreStore ).getTheme( slug ),
-		[ slug ]
-	);
-
-	return (
-		<BaseAddedBy
-			icon={ themeIcon }
-			text={ theme?.name?.rendered || slug }
-			isCustomized={ isCustomized }
-		/>
-	);
-}
-
-function AddedByPlugin( { slug, isCustomized } ) {
-	const plugin = useSelect(
-		( select ) => select( coreStore ).getPlugin( slug ),
-		[ slug ]
-	);
-
-	return (
-		<BaseAddedBy
-			icon={ pluginIcon }
-			text={ plugin?.name || slug }
-			isCustomized={ isCustomized }
-		/>
+		<div
+			className={ classnames( 'edit-site-list-added-by__avatar', {
+				'is-loaded': isImageLoaded,
+			} ) }
+		>
+			<img
+				onLoad={ () => setIsImageLoaded( true ) }
+				alt=""
+				src={ imageUrl }
+			/>
+		</div>
 	);
 }
 
-function AddedByAuthor( { id } ) {
-	const user = useSelect(
-		( select ) => select( coreStore ).getUser( id ),
-		[ id ]
-	);
-
-	return (
-		<BaseAddedBy
-			icon={ authorIcon }
-			imageUrl={ user?.avatar_urls?.[ 48 ] }
-			text={ user?.nickname }
-		/>
+/**
+ * @param {Object}       props
+ * @param {TemplateType} props.postType The template post type.
+ * @param {number}       props.postId   The template post id.
+ */
+export default function AddedBy( { postType, postId } ) {
+	const { text, icon, imageUrl, isCustomized } = useAddedBy(
+		postType,
+		postId
 	);
-}
-
-function AddedBySite() {
-	const { name, logoURL } = useSelect( ( select ) => {
-		const { getEntityRecord, getMedia } = select( coreStore );
-		const siteData = getEntityRecord( 'root', '__unstableBase' );
-
-		return {
-			name: siteData?.name,
-			logoURL: siteData?.site_logo
-				? getMedia( siteData.site_logo )?.source_url
-				: undefined,
-		};
-	}, [] );
 
 	return (
-		<BaseAddedBy icon={ globeIcon } imageUrl={ logoURL } text={ name } />
+		<HStack alignment="left">
+			{ imageUrl ? (
+				<AvatarImage imageUrl={ imageUrl } />
+			) : (
+				<div className="edit-site-list-added-by__icon">
+					<Icon icon={ icon } />
+				</div>
+			) }
+			<span>
+				{ text }
+				{ isCustomized && (
+					<span className="edit-site-list-added-by__customized-info">
+						{ postType === 'wp_template'
+							? _x( 'Customized', 'template' )
+							: _x( 'Customized', 'template part' ) }
+					</span>
+				) }
+			</span>
+		</HStack>
 	);
 }
-
-export default function AddedBy( { templateType, template } ) {
-	if ( ! template ) {
-		return;
-	}
-
-	if ( TEMPLATE_POST_TYPE_NAMES.includes( templateType ) ) {
-		// Template originally provided by a theme, but customized by a user.
-		// Templates originally didn't have the 'origin' field so identify
-		// older customized templates by checking for no origin and a 'theme'
-		// or 'custom' source.
-		if (
-			template.has_theme_file &&
-			( template.origin === 'theme' ||
-				( ! template.origin &&
-					[ 'theme', 'custom' ].includes( template.source ) ) )
-		) {
-			return (
-				<AddedByTheme
-					slug={ template.theme }
-					isCustomized={ template.source === 'custom' }
-				/>
-			);
-		}
-
-		// Template originally provided by a plugin, but customized by a user.
-		if ( template.has_theme_file && template.origin === 'plugin' ) {
-			return (
-				<AddedByPlugin
-					slug={ template.theme }
-					isCustomized={ template.source === 'custom' }
-				/>
-			);
-		}
-
-		// Template was created from scratch, but has no author. Author support
-		// was only added to templates in WordPress 5.9. Fallback to showing the
-		// site logo and title.
-		if (
-			! template.has_theme_file &&
-			template.source === 'custom' &&
-			! template.author
-		) {
-			return <AddedBySite />;
-		}
-	}
-
-	// Simply show the author for templates created from scratch that have an
-	// author or for any other post type.
-	return <AddedByAuthor id={ template.author } />;
-}

package/src/components/list/index.js

@@ -19,8 +19,10 @@ import useTitle from '../routes/use-title';
 
 export default function List() {
 	const {
-		params: { postType: templateType },
+		params: { path },
 	} = useLocation();
+	const templateType =
+		path === '/wp_template/all' ? 'wp_template' : 'wp_template_part';
 
 	useRegisterShortcuts();
 

package/src/components/list/style.scss

@@ -141,7 +141,6 @@
 .edit-site-list-added-by__icon {
 	display: flex;
 	flex-shrink: 0;
-	position: relative;
 	align-items: center;
 	justify-content: center;
 	width: $grid-unit-40;
@@ -152,18 +151,6 @@
 	svg {
 		fill: $white;
 	}
-
-	&.is-customized::after {
-		position: absolute;
-		content: "";
-		background: var(--wp-admin-theme-color);
-		height: $grid-unit-10;
-		width: $grid-unit-10;
-		outline: 2px solid $white;
-		border-radius: 100%;
-		top: -1px;
-		right: -1px;
-	}
 }
 
 .edit-site-list-added-by__avatar {
@@ -189,3 +176,8 @@
 		}
 	}
 }
+
+.edit-site-list-added-by__customized-info {
+	display: block;
+	color: $gray-700;
+}

package/src/components/list/table.js

@@ -46,6 +46,9 @@ export default function Table( { templateType } ) {
 		);
 	}
 
+	const sortedTemplates = [ ...templates ];
+	sortedTemplates.sort( ( a, b ) => a.slug.localeCompare( b.slug ) );
+
 	return (
 		// These explicit aria roles are needed for Safari.
 		// See https://developer.mozilla.org/en-US/docs/Web/CSS/display#tables
@@ -74,7 +77,7 @@ export default function Table( { templateType } ) {
 			</thead>
 
 			<tbody>
-				{ templates.map( ( template ) => (
+				{ sortedTemplates.map( ( template ) => (
 					<tr
 						key={ template.id }
 						className="edit-site-list-table-row"
@@ -84,12 +87,9 @@ export default function Table( { templateType } ) {
 							<Heading level={ 4 }>
 								<Link
 									params={ {
-										path:
-											template.type === 'wp_template'
-												? '/templates/single'
-												: '/template-parts/single',
 										postId: template.id,
 										postType: template.type,
+										canvas: 'edit',
 									} }
 								>
 									{ decodeEntities(
@@ -102,10 +102,12 @@ export default function Table( { templateType } ) {
 						</td>
 
 						<td className="edit-site-list-table-column" role="cell">
-							<AddedBy
-								templateType={ templateType }
-								template={ template }
-							/>
+							{ template ? (
+								<AddedBy
+									postType={ template.type }
+									postId={ template.id }
+								/>
+							) : null }
 						</td>
 						<td className="edit-site-list-table-column" role="cell">
 							<Actions template={ template } />

package/src/components/routes/link.js

@@ -1,7 +1,7 @@
 /**
  * WordPress dependencies
  */
-import { addQueryArgs } from '@wordpress/url';
+import { addQueryArgs, getQueryArgs, removeQueryArgs } from '@wordpress/url';
 
 /**
  * Internal dependencies
@@ -21,8 +21,15 @@ export function useLink( params = {}, state, shouldReplace = false ) {
 		}
 	}
 
+	const currentArgs = getQueryArgs( window.location.href );
+	const currentUrlWithoutArgs = removeQueryArgs(
+		window.location.href,
+		...Object.keys( currentArgs )
+	);
+	const newUrl = addQueryArgs( currentUrlWithoutArgs, params );
+
 	return {
-		href: addQueryArgs( window.location.href, params ),
+		href: newUrl,
 		onClick,
 	};
 }

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

@@ -0,0 +1,78 @@
+/**
+ * WordPress dependencies
+ */
+import { useSelect, useDispatch } from '@wordpress/data';
+import { Button, __experimentalHStack as HStack } from '@wordpress/components';
+import { sprintf, __, _n } from '@wordpress/i18n';
+import { store as coreStore } from '@wordpress/core-data';
+import { displayShortcut } from '@wordpress/keycodes';
+import { check } from '@wordpress/icons';
+
+/**
+ * Internal dependencies
+ */
+import { store as editSiteStore } from '../../store';
+
+export default function SaveButton() {
+	const { countUnsavedChanges, isDirty, isSaving, isSaveViewOpen } =
+		useSelect( ( select ) => {
+			const {
+				__experimentalGetDirtyEntityRecords,
+				isSavingEntityRecord,
+			} = select( coreStore );
+			const dirtyEntityRecords = __experimentalGetDirtyEntityRecords();
+			const { isSaveViewOpened } = select( editSiteStore );
+			return {
+				isDirty: dirtyEntityRecords.length > 0,
+				isSaving: dirtyEntityRecords.some( ( record ) =>
+					isSavingEntityRecord( record.kind, record.name, record.key )
+				),
+				isSaveViewOpen: isSaveViewOpened(),
+				countUnsavedChanges: dirtyEntityRecords.length,
+			};
+		}, [] );
+	const { setIsSaveViewOpened } = useDispatch( editSiteStore );
+
+	const disabled = ! isDirty || isSaving;
+
+	const label = disabled ? __( 'Saved' ) : __( 'Save' );
+
+	return (
+		<HStack className="edit-site-save-hub" alignment="right" spacing={ 4 }>
+			{ isDirty && (
+				<span>
+					{ sprintf(
+						// translators: %d: number of unsaved changes (number).
+						_n(
+							'%d unsaved change',
+							'%d unsaved changes',
+							countUnsavedChanges
+						),
+						countUnsavedChanges
+					) }
+				</span>
+			) }
+			<Button
+				className="edit-site-save-hub__button"
+				variant={ disabled ? undefined : 'primary' }
+				aria-disabled={ disabled }
+				aria-expanded={ isSaveViewOpen }
+				isBusy={ isSaving }
+				onClick={
+					disabled ? undefined : () => setIsSaveViewOpened( true )
+				}
+				label={ label }
+				/*
+				 * We want the tooltip to show the keyboard shortcut only when the
+				 * button does something, i.e. when it's not disabled.
+				 */
+				shortcut={
+					disabled ? undefined : displayShortcut.primary( 's' )
+				}
+				icon={ disabled ? check : undefined }
+			>
+				{ label }
+			</Button>
+		</HStack>
+	);
+}

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

@@ -0,0 +1,15 @@
+.edit-site-save-hub {
+	color: $gray-600;
+}
+
+.edit-site-save-hub__button {
+	color: inherit;
+
+	&[aria-disabled="true"] {
+		opacity: 1;
+	}
+
+	&[aria-disabled="true"]:hover {
+		color: inherit;
+	}
+}

package/src/components/save-panel/index.js

@@ -1,3 +1,8 @@
+/**
+ * External dependencies
+ */
+import classnames from 'classnames';
+
 /**
  * WordPress dependencies
  */
@@ -46,7 +51,9 @@ export default function SavePanel() {
 
 	return (
 		<NavigableRegion
-			className="edit-site-layout__actions"
+			className={ classnames( 'edit-site-layout__actions', {
+				'is-entity-save-view-open': isSaveViewOpen,
+			} ) }
 			ariaLabel={ __( 'Save sidebar' ) }
 		>
 			{ isSaveViewOpen ? (

package/src/components/sidebar/index.js

@@ -1,8 +1,11 @@
 /**
  * WordPress dependencies
  */
-import { memo } from '@wordpress/element';
-import { __experimentalNavigatorProvider as NavigatorProvider } from '@wordpress/components';
+import { memo, useRef } from '@wordpress/element';
+import {
+	__experimentalNavigatorProvider as NavigatorProvider,
+	__experimentalNavigatorScreen as NavigatorScreen,
+} from '@wordpress/components';
 
 /**
  * Internal dependencies
@@ -10,42 +13,56 @@ import { __experimentalNavigatorProvider as NavigatorProvider } from '@wordpress
 import SidebarNavigationScreenMain from '../sidebar-navigation-screen-main';
 import SidebarNavigationScreenTemplates from '../sidebar-navigation-screen-templates';
 import SidebarNavigationScreenTemplate from '../sidebar-navigation-screen-template';
-import useSyncPathWithURL from '../sync-state-with-url/use-sync-path-with-url';
+import useSyncPathWithURL, {
+	getPathFromURL,
+} from '../sync-state-with-url/use-sync-path-with-url';
 import SidebarNavigationScreenNavigationMenus from '../sidebar-navigation-screen-navigation-menus';
 import SidebarNavigationScreenTemplatesBrowse from '../sidebar-navigation-screen-templates-browse';
-import SaveButton from '../save-button';
+import SaveHub from '../save-hub';
 import SidebarNavigationScreenNavigationItem from '../sidebar-navigation-screen-navigation-item';
+import { useLocation } from '../routes';
 
 function SidebarScreens() {
 	useSyncPathWithURL();
 
 	return (
 		<>
-			<SidebarNavigationScreenMain />
-			<SidebarNavigationScreenNavigationMenus />
-			<SidebarNavigationScreenNavigationItem />
-			<SidebarNavigationScreenTemplates postType="wp_template" />
-			<SidebarNavigationScreenTemplates postType="wp_template_part" />
-			<SidebarNavigationScreenTemplate postType="wp_template" />
-			<SidebarNavigationScreenTemplate postType="wp_template_part" />
-			<SidebarNavigationScreenTemplatesBrowse postType="wp_template" />
-			<SidebarNavigationScreenTemplatesBrowse postType="wp_template_part" />
+			<NavigatorScreen path="/">
+				<SidebarNavigationScreenMain />
+			</NavigatorScreen>
+			<NavigatorScreen path="/navigation">
+				<SidebarNavigationScreenNavigationMenus />
+			</NavigatorScreen>
+			<NavigatorScreen path="/navigation/:postType/:postId">
+				<SidebarNavigationScreenNavigationItem />
+			</NavigatorScreen>
+			<NavigatorScreen path="/:postType(wp_template|wp_template_part)">
+				<SidebarNavigationScreenTemplates />
+			</NavigatorScreen>
+			<NavigatorScreen path="/:postType(wp_template|wp_template_part)/all">
+				<SidebarNavigationScreenTemplatesBrowse />
+			</NavigatorScreen>
+			<NavigatorScreen path="/:postType(wp_template|wp_template_part)/:postId">
+				<SidebarNavigationScreenTemplate />
+			</NavigatorScreen>
 		</>
 	);
 }
 
 function Sidebar() {
+	const { params: urlParams } = useLocation();
+	const initialPath = useRef( getPathFromURL( urlParams ) );
+
 	return (
 		<>
 			<NavigatorProvider
 				className="edit-site-sidebar__content"
-				initialPath="/"
+				initialPath={ initialPath.current }
 			>
 				<SidebarScreens />
 			</NavigatorProvider>
-
 			<div className="edit-site-sidebar__footer">
-				<SaveButton />
+				<SaveHub />
 			</div>
 		</>
 	);

package/src/components/sidebar/style.scss

@@ -1,7 +1,10 @@
 .edit-site-sidebar__content {
 	flex-grow: 1;
 	overflow-y: auto;
-	@include custom-scrollbars-on-hover;
+
+	.components-navigator-screen {
+		@include custom-scrollbars-on-hover;
+	}
 }
 
 .edit-site-sidebar__footer {
@@ -9,8 +12,6 @@
 	flex-shrink: 0;
 	margin: 0 $canvas-padding;
 	padding: $canvas-padding 0;
-	display: flex;
-	justify-content: flex-end;
 }
 
 .edit-site-sidebar__content.edit-site-sidebar__content {