@wordpress/edit-site 5.32.0 → 5.34.0

package/src/components/sidebar-edit-mode/plugin-sidebar/index.js

@@ -1,80 +0,0 @@
-/**
- * WordPress dependencies
- */
-import { ComplementaryArea } from '@wordpress/interface';
-
-/**
- * Renders a sidebar when activated. The contents within the `PluginSidebar` will appear as content within the sidebar.
- * It also automatically renders a corresponding `PluginSidebarMenuItem` component when `isPinnable` flag is set to `true`.
- * If you wish to display the sidebar, you can with use the `PluginSidebarMoreMenuItem` component or the `wp.data.dispatch` API:
- *
- * ```js
- * wp.data.dispatch( 'core/edit-site' ).openGeneralSidebar( 'plugin-name/sidebar-name' );
- * ```
- *
- * @see PluginSidebarMoreMenuItem
- *
- * @param {Object}                props                                 Element props.
- * @param {string}                props.name                            A string identifying the sidebar. Must be unique for every sidebar registered within the scope of your plugin.
- * @param {string}                [props.className]                     An optional class name added to the sidebar body.
- * @param {string}                props.title                           Title displayed at the top of the sidebar.
- * @param {boolean}               [props.isPinnable=true]               Whether to allow to pin sidebar to the toolbar. When set to `true` it also automatically renders a corresponding menu item.
- * @param {WPBlockTypeIconRender} [props.icon=inherits from the plugin] The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered when the sidebar is pinned to toolbar.
- *
- * @example
- * ```js
- * // Using ES5 syntax
- * var __ = wp.i18n.__;
- * var el = wp.element.createElement;
- * var PanelBody = wp.components.PanelBody;
- * var PluginSidebar = wp.editSite.PluginSidebar;
- * var moreIcon = wp.element.createElement( 'svg' ); //... svg element.
- *
- * function MyPluginSidebar() {
- * 	return el(
- * 			PluginSidebar,
- * 			{
- * 				name: 'my-sidebar',
- * 				title: 'My sidebar title',
- * 				icon: moreIcon,
- * 			},
- * 			el(
- * 				PanelBody,
- * 				{},
- * 				__( 'My sidebar content' )
- * 			)
- * 	);
- * }
- * ```
- *
- * @example
- * ```jsx
- * // Using ESNext syntax
- * import { __ } from '@wordpress/i18n';
- * import { PanelBody } from '@wordpress/components';
- * import { PluginSidebar } from '@wordpress/edit-site';
- * import { more } from '@wordpress/icons';
- *
- * const MyPluginSidebar = () => (
- * 	<PluginSidebar
- * 		name="my-sidebar"
- * 		title="My sidebar title"
- * 		icon={ more }
- * 	>
- * 		<PanelBody>
- * 			{ __( 'My sidebar content' ) }
- * 		</PanelBody>
- * 	</PluginSidebar>
- * );
- * ```
- */
-export default function PluginSidebarEditSite( { className, ...props } ) {
-	return (
-		<ComplementaryArea
-			panelClassName={ className }
-			className="edit-site-sidebar-edit-mode"
-			scope="core/edit-site"
-			{ ...props }
-		/>
-	);
-}

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

@@ -1,59 +0,0 @@
-/**
- * WordPress dependencies
- */
-import { __ } from '@wordpress/i18n';
-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';
-
-/**
- * Internal dependencies
- */
-import SidebarNavigationScreen from '../sidebar-navigation-screen';
-import { unlock } from '../../lock-unlock';
-import { store as editSiteStore } from '../../store';
-import SidebarButton from '../sidebar-button';
-
-export default function SidebarNavigationScreenNavigationItem() {
-	const { setCanvasMode } = unlock( useDispatch( editSiteStore ) );
-	const {
-		params: { postType, postId },
-	} = useNavigator();
-	const { record } = useEntityRecord( 'postType', postType, postId );
-
-	return (
-		<SidebarNavigationScreen
-			title={ record ? decodeEntities( record?.title?.rendered ) : null }
-			actions={
-				<SidebarButton
-					onClick={ () => setCanvasMode( 'edit' ) }
-					label={ __( 'Edit' ) }
-					icon={ pencil }
-				/>
-			}
-			description={ __(
-				'Posts are entries listed in reverse chronological order on the site homepage or on the posts page.'
-			) }
-			content={
-				<>
-					{ 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/sync-state-with-url/use-sync-path-with-url.js

@@ -1,147 +0,0 @@
-/**
- * WordPress dependencies
- */
-import { __experimentalUseNavigator as useNavigator } from '@wordpress/components';
-import { useEffect, useRef } from '@wordpress/element';
-import { privateApis as routerPrivateApis } from '@wordpress/router';
-
-/**
- * Internal dependencies
- */
-import { unlock } from '../../lock-unlock';
-import {
-	TEMPLATE_POST_TYPE,
-	TEMPLATE_PART_POST_TYPE,
-	PATTERN_TYPES,
-} from '../../utils/constants';
-
-const { useLocation, useHistory } = unlock( routerPrivateApis );
-
-export function getPathFromURL( urlParams ) {
-	let path = urlParams?.path ?? '/';
-
-	// Compute the navigator path based on the URL params.
-	if ( urlParams?.postType && urlParams?.postId ) {
-		switch ( urlParams.postType ) {
-			case PATTERN_TYPES.user:
-			case TEMPLATE_POST_TYPE:
-			case TEMPLATE_PART_POST_TYPE:
-			case 'page':
-				path = `/${ encodeURIComponent(
-					urlParams.postType
-				) }/${ encodeURIComponent( urlParams.postId ) }`;
-				break;
-			default:
-				path = `/navigation/${ encodeURIComponent(
-					urlParams.postType
-				) }/${ encodeURIComponent( urlParams.postId ) }`;
-		}
-	}
-
-	return path;
-}
-
-function isSubset( subset, superset ) {
-	return Object.entries( subset ).every( ( [ key, value ] ) => {
-		return superset[ key ] === value;
-	} );
-}
-
-export default function useSyncPathWithURL() {
-	const history = useHistory();
-	const { params: urlParams } = useLocation();
-	const {
-		location: navigatorLocation,
-		params: navigatorParams,
-		goTo,
-	} = useNavigator();
-	const isMounting = useRef( true );
-
-	useEffect(
-		() => {
-			// The navigatorParams are only initially filled properly when the
-			// navigator screens mount. so we ignore the first synchronisation.
-			if ( isMounting.current ) {
-				isMounting.current = false;
-				return;
-			}
-
-			function updateUrlParams( newUrlParams ) {
-				if ( isSubset( newUrlParams, urlParams ) ) {
-					return;
-				}
-				const updatedParams = {
-					...urlParams,
-					...newUrlParams,
-				};
-				history.push( updatedParams );
-			}
-
-			if ( navigatorParams?.postType && navigatorParams?.postId ) {
-				updateUrlParams( {
-					postType: navigatorParams?.postType,
-					postId: navigatorParams?.postId,
-					path: undefined,
-					layout: undefined,
-				} );
-			} else if (
-				navigatorLocation.path.startsWith( '/page/' ) &&
-				navigatorParams?.postId
-			) {
-				updateUrlParams( {
-					postType: 'page',
-					postId: navigatorParams?.postId,
-					path: undefined,
-					layout: undefined,
-				} );
-			} else if ( navigatorLocation.path === '/patterns' ) {
-				updateUrlParams( {
-					postType: undefined,
-					postId: undefined,
-					canvas: undefined,
-					path: navigatorLocation.path,
-				} );
-			} else if (
-				// These sidebar paths are special in the sense that the url in these pages may or may not have a postId and we need to retain it if it has.
-				// The "type" property should be kept as well.
-				navigatorLocation.path === '/page' ||
-				navigatorLocation.path === '/wp_template' ||
-				navigatorLocation.path === '/wp_template_part/all'
-			) {
-				updateUrlParams( {
-					postType: undefined,
-					categoryType: undefined,
-					categoryId: undefined,
-					path: navigatorLocation.path,
-				} );
-			} else {
-				updateUrlParams( {
-					postType: undefined,
-					postId: undefined,
-					categoryType: undefined,
-					categoryId: undefined,
-					layout: undefined,
-					path:
-						navigatorLocation.path === '/'
-							? undefined
-							: navigatorLocation.path,
-				} );
-			}
-		},
-		// Trigger only when navigator changes to prevent infinite loops.
-		// eslint-disable-next-line react-hooks/exhaustive-deps
-		[ navigatorLocation?.path, navigatorParams ]
-	);
-
-	useEffect(
-		() => {
-			const path = getPathFromURL( urlParams );
-			if ( navigatorLocation.path !== path ) {
-				goTo( path );
-			}
-		},
-		// Trigger only when URL changes to prevent infinite loops.
-		// eslint-disable-next-line react-hooks/exhaustive-deps
-		[ urlParams ]
-	);
-}