@wordpress/edit-site 5.5.0 → 5.7.0

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

@@ -1,3 +1,4 @@
+// @ts-check
 /**
  * External dependencies
  */
@@ -6,7 +7,7 @@ import classnames from 'classnames';
 /**
  * WordPress dependencies
  */
-import { __experimentalHStack as HStack, Icon } 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';
@@ -18,25 +19,154 @@ import {
 } from '@wordpress/icons';
 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 BaseAddedBy( { text, icon, imageUrl, isCustomized, templateType } ) {
+/**
+ * @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
+			);
+
+			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 ]
+	);
+}
+
+/**
+ * @param {Object} props
+ * @param {string} props.imageUrl
+ */
+function AvatarImage( { imageUrl } ) {
 	const [ isImageLoaded, setIsImageLoaded ] = useState( false );
 
+	return (
+		<div
+			className={ classnames( 'edit-site-list-added-by__avatar', {
+				'is-loaded': isImageLoaded,
+			} ) }
+		>
+			<img
+				onLoad={ () => setIsImageLoaded( true ) }
+				alt=""
+				src={ imageUrl }
+			/>
+		</div>
+	);
+}
+
+/**
+ * @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
+	);
+
 	return (
 		<HStack alignment="left">
 			{ imageUrl ? (
-				<div
-					className={ classnames( 'edit-site-list-added-by__avatar', {
-						'is-loaded': isImageLoaded,
-					} ) }
-				>
-					<img
-						onLoad={ () => setIsImageLoaded( true ) }
-						alt=""
-						src={ imageUrl }
-					/>
-				</div>
+				<AvatarImage imageUrl={ imageUrl } />
 			) : (
 				<div className="edit-site-list-added-by__icon">
 					<Icon icon={ icon } />
@@ -46,7 +176,7 @@ function BaseAddedBy( { text, icon, imageUrl, isCustomized, templateType } ) {
 				{ text }
 				{ isCustomized && (
 					<span className="edit-site-list-added-by__customized-info">
-						{ templateType === 'wp_template'
+						{ postType === 'wp_template'
 							? _x( 'Customized', 'template' )
 							: _x( 'Customized', 'template part' ) }
 					</span>
@@ -55,129 +185,3 @@ function BaseAddedBy( { text, icon, imageUrl, isCustomized, templateType } ) {
 		</HStack>
 	);
 }
-
-function AddedByTheme( { slug, isCustomized, templateType } ) {
-	const theme = useSelect(
-		( select ) => select( coreStore ).getTheme( slug ),
-		[ slug ]
-	);
-
-	return (
-		<BaseAddedBy
-			icon={ themeIcon }
-			text={ theme?.name?.rendered || slug }
-			isCustomized={ isCustomized }
-			templateType={ templateType }
-		/>
-	);
-}
-
-function AddedByPlugin( { slug, isCustomized, templateType } ) {
-	const plugin = useSelect(
-		( select ) => select( coreStore ).getPlugin( slug ),
-		[ slug ]
-	);
-
-	return (
-		<BaseAddedBy
-			icon={ pluginIcon }
-			text={ plugin?.name || slug }
-			isCustomized={ isCustomized }
-			templateType={ templateType }
-		/>
-	);
-}
-
-function AddedByAuthor( { id, templateType } ) {
-	const user = useSelect(
-		( select ) => select( coreStore ).getUser( id ),
-		[ id ]
-	);
-
-	return (
-		<BaseAddedBy
-			icon={ authorIcon }
-			imageUrl={ user?.avatar_urls?.[ 48 ] }
-			text={ user?.nickname }
-			templateType={ templateType }
-		/>
-	);
-}
-
-function AddedBySite( { templateType } ) {
-	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 }
-			templateType={ templateType }
-		/>
-	);
-}
-
-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' }
-					templateType={ templateType }
-				/>
-			);
-		}
-
-		// 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' }
-					templateType={ templateType }
-				/>
-			);
-		}
-
-		// 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 templateType={ templateType } />;
-		}
-	}
-
-	// Simply show the author for templates created from scratch that have an
-	// author or for any other post type.
-	return (
-		<AddedByAuthor id={ template.author } templateType={ templateType } />
-	);
-}

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/table.js

@@ -89,6 +89,7 @@ export default function Table( { templateType } ) {
 									params={ {
 										postId: template.id,
 										postType: template.type,
+										canvas: 'edit',
 									} }
 								>
 									{ decodeEntities(
@@ -101,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-button/index.js

@@ -12,7 +12,7 @@ import { displayShortcut } from '@wordpress/keycodes';
  */
 import { store as editSiteStore } from '../../store';
 
-export default function SaveButton( { showTooltip = true } ) {
+export default function SaveButton() {
 	const { isDirty, isSaving, isSaveViewOpen } = useSelect( ( select ) => {
 		const { __experimentalGetDirtyEntityRecords, isSavingEntityRecord } =
 			select( coreStore );
@@ -52,7 +52,7 @@ export default function SaveButton( { showTooltip = true } ) {
 			 * of the button that we want to avoid. By setting `showTooltip`,
 			 & the tooltip is always rendered even when there's no keyboard shortcut.
 			 */
-			showTooltip={ showTooltip }
+			showTooltip
 		>
 			{ label }
 		</Button>

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/secondary-sidebar/list-view-sidebar.js

@@ -1,7 +1,7 @@
 /**
  * WordPress dependencies
  */
-import { __experimentalListView as ListView } from '@wordpress/block-editor';
+import { privateApis as blockEditorPrivateApis } from '@wordpress/block-editor';
 import { Button } from '@wordpress/components';
 import {
 	useFocusOnMount,
@@ -18,6 +18,7 @@ import { ESCAPE } from '@wordpress/keycodes';
  * Internal dependencies
  */
 import { store as editSiteStore } from '../../store';
+import { unlock } from '../../private-apis';
 
 export default function ListViewSidebar() {
 	const { setIsListViewOpened } = useDispatch( editSiteStore );
@@ -33,7 +34,7 @@ export default function ListViewSidebar() {
 
 	const instanceId = useInstanceId( ListViewSidebar );
 	const labelId = `edit-site-editor__list-view-panel-label-${ instanceId }`;
-
+	const { PrivateListView } = unlock( blockEditorPrivateApis );
 	return (
 		// eslint-disable-next-line jsx-a11y/no-static-element-interactions
 		<div
@@ -59,7 +60,7 @@ export default function ListViewSidebar() {
 					focusOnMountRef,
 				] ) }
 			>
-				<ListView />
+				<PrivateListView />
 			</div>
 		</div>
 	);

package/src/components/sidebar/index.js

@@ -18,7 +18,7 @@ import useSyncPathWithURL, {
 } 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';
 
@@ -61,9 +61,8 @@ function Sidebar() {
 			>
 				<SidebarScreens />
 			</NavigatorProvider>
-
 			<div className="edit-site-sidebar__footer">
-				<SaveButton showTooltip={ false } />
+				<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 {

package/src/components/sidebar-button/style.scss

@@ -17,7 +17,8 @@
 	&:hover,
 	&:focus-visible,
 	&:focus,
-	&:not([aria-disabled="true"]):active {
+	&:not([aria-disabled="true"]):active,
+	&[aria-expanded="true"] {
 		color: $white;
 	}
 }

package/src/components/sidebar-navigation-item/style.scss

@@ -1,13 +1,12 @@
 .edit-site-sidebar-navigation-item.components-item {
 	color: $gray-600;
-	border-width: $border-width-tab;
+	margin: 0 $grid-unit-05;
 
 	&:hover,
 	&:focus,
 	&[aria-current] {
 		color: $white;
 		background: $gray-800;
-		border-width: $border-width-tab;
 	}
 
 	&[aria-current] {
@@ -15,28 +14,7 @@
 	}
 }
 
-.edit-site-sidebar-navigation-screen__content .edit-site-navigation-inspector .components-button {
-	color: $gray-600;
-	&:hover,
-	&:focus,
-	&[aria-current] {
-		color: $white;
-	}
-}
-
-.edit-site-sidebar-navigation-screen__content .edit-site-navigation-inspector .offcanvas-editor-list-view-leaf {
-	&:hover,
-	&:focus,
-	&[aria-current] {
-		background: $gray-800;
-	}
-	.block-editor-list-view-block__menu {
-		margin-left: -$grid-unit-10;
-	}
-}
-
 .edit-site-sidebar-navigation-screen__content .block-editor-list-view-block-select-button {
 	cursor: grab;
-	width: calc(100% - #{ $border-width-focus });
 	padding: $grid-unit-10;
 }

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

@@ -22,6 +22,7 @@ export default function SidebarNavigationScreen( {
 	title,
 	actions,
 	content,
+	description,
 } ) {
 	const { dashboardLink } = useSelect( ( select ) => {
 		const { getSettings } = unlock( select( editSiteStore ) );
@@ -58,6 +59,11 @@ export default function SidebarNavigationScreen( {
 			</HStack>
 
 			<nav className="edit-site-sidebar-navigation-screen__content">
+				{ description && (
+					<p className="edit-site-sidebar-navigation-screen__description">
+						{ description }
+					</p>
+				) }
 				{ content }
 			</nav>
 		</VStack>

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

@@ -10,6 +10,21 @@
 	color: $gray-600;
 }
 
+.edit-site-sidebar-navigation-screen__page-link {
+	color: $gray-600;
+
+	&:hover,
+	&:focus {
+		color: $white;
+	}
+
+	.components-external-link__icon {
+		margin-left: $grid-unit-05;
+	}
+	margin-left: $grid-unit-20;
+	display: inline-block;
+}
+
 .edit-site-sidebar-navigation-screen__title-icon {
 	position: sticky;
 	top: 0;