@wordpress/block-editor 11.2.0 → 11.3.0

package/src/components/inner-blocks/index.js

@@ -11,7 +11,6 @@ import { forwardRef, useMemo } from '@wordpress/element';
 import { useSelect } from '@wordpress/data';
 import {
 	getBlockSupport,
-	getBlockType,
 	store as blocksStore,
 	__unstableGetInnerBlocksProps as getInnerBlocksProps,
 } from '@wordpress/blocks';
@@ -23,13 +22,16 @@ import ButtonBlockAppender from './button-block-appender';
 import DefaultBlockAppender from './default-block-appender';
 import useNestedSettingsUpdate from './use-nested-settings-update';
 import useInnerBlockTemplateSync from './use-inner-block-template-sync';
-import getBlockContext from './get-block-context';
+import useBlockContext from './use-block-context';
 import { BlockListItems } from '../block-list';
 import { BlockContextProvider } from '../block-context';
 import { useBlockEditContext } from '../block-edit/context';
 import useBlockSync from '../provider/use-block-sync';
 import { store as blockEditorStore } from '../../store';
 import useBlockDropZone from '../use-block-drop-zone';
+import useSetting from '../use-setting';
+
+const EMPTY_OBJECT = {};
 
 /**
  * InnerBlocks is a component which allows a single block to have multiple blocks
@@ -54,7 +56,7 @@ function UncontrolledInnerBlocks( props ) {
 		renderAppender,
 		orientation,
 		placeholder,
-		__experimentalLayout,
+		layout,
 	} = props;
 
 	useNestedSettingsUpdate(
@@ -65,7 +67,7 @@ function UncontrolledInnerBlocks( props ) {
 		templateLock,
 		captureToolbars,
 		orientation,
-		__experimentalLayout
+		layout
 	);
 
 	useInnerBlockTemplateSync(
@@ -75,43 +77,33 @@ function UncontrolledInnerBlocks( props ) {
 		templateInsertUpdatesSelection
 	);
 
-	const { context, name } = useSelect(
+	const context = useBlockContext( clientId );
+	const name = useSelect(
 		( select ) => {
-			const block = select( blockEditorStore ).getBlock( clientId );
-
-			// This check is here to avoid the Redux zombie bug where a child subscription
-			// is called before a parent, causing potential JS errors when the child has been removed.
-			if ( ! block ) {
-				return {};
-			}
-
-			const blockType = getBlockType( block.name );
-
-			if (
-				Object.keys( blockType?.providesContext ?? {} ).length === 0
-			) {
-				return { name: block.name };
-			}
-
-			return {
-				context: getBlockContext( block.attributes, blockType ),
-				name: block.name,
-			};
+			return select( blockEditorStore ).getBlock( clientId )?.name;
 		},
 		[ clientId ]
 	);
 
-	const { allowSizingOnChildren = false } =
-		getBlockSupport( name, '__experimentalLayout' ) || {};
+	const defaultLayoutBlockSupport =
+		getBlockSupport( name, '__experimentalLayout' ) || EMPTY_OBJECT;
+
+	const { allowSizingOnChildren = false } = defaultLayoutBlockSupport;
+
+	const defaultLayout = useSetting( 'layout' ) || EMPTY_OBJECT;
 
-	const layout = useMemo(
+	const usedLayout = layout || defaultLayoutBlockSupport;
+
+	const memoedLayout = useMemo(
 		() => ( {
-			...__experimentalLayout,
+			// Default layout will know about any content/wide size defined by the theme.
+			...defaultLayout,
+			...usedLayout,
 			...( allowSizingOnChildren && {
 				allowSizingOnChildren: true,
 			} ),
 		} ),
-		[ __experimentalLayout, allowSizingOnChildren ]
+		[ defaultLayout, usedLayout, allowSizingOnChildren ]
 	);
 
 	// This component needs to always be synchronous as it's the one changing
@@ -122,7 +114,7 @@ function UncontrolledInnerBlocks( props ) {
 				rootClientId={ clientId }
 				renderAppender={ renderAppender }
 				__experimentalAppenderTagName={ __experimentalAppenderTagName }
-				__experimentalLayout={ layout }
+				__experimentalLayout={ memoedLayout }
 				wrapperRef={ wrapperRef }
 				placeholder={ placeholder }
 			/>
@@ -171,8 +163,11 @@ const ForwardedInnerBlocks = forwardRef( ( props, ref ) => {
 export function useInnerBlocksProps( props = {}, options = {} ) {
 	const { __unstableDisableLayoutClassNames, __unstableDisableDropZone } =
 		options;
-	const { clientId, __unstableLayoutClassNames: layoutClassNames = '' } =
-		useBlockEditContext();
+	const {
+		clientId,
+		layout = null,
+		__unstableLayoutClassNames: layoutClassNames = '',
+	} = useBlockEditContext();
 	const isSmallScreen = useViewportMatch( 'medium', '<' );
 	const { __experimentalCaptureToolbars, hasOverlay } = useSelect(
 		( select ) => {
@@ -218,6 +213,7 @@ export function useInnerBlocksProps( props = {}, options = {} ) {
 
 	const innerBlocksProps = {
 		__experimentalCaptureToolbars,
+		layout,
 		...options,
 	};
 	const InnerBlocks =

package/src/components/inner-blocks/index.native.js

@@ -1,11 +1,7 @@
 /**
  * WordPress dependencies
  */
-import { useSelect } from '@wordpress/data';
-import {
-	getBlockType,
-	__unstableGetInnerBlocksProps as getInnerBlocksProps,
-} from '@wordpress/blocks';
+import { __unstableGetInnerBlocksProps as getInnerBlocksProps } from '@wordpress/blocks';
 import { useRef } from '@wordpress/element';
 
 /**
@@ -15,7 +11,7 @@ import ButtonBlockAppender from './button-block-appender';
 import DefaultBlockAppender from './default-block-appender';
 import useNestedSettingsUpdate from './use-nested-settings-update';
 import useInnerBlockTemplateSync from './use-inner-block-template-sync';
-import getBlockContext from './get-block-context';
+import useBlockContext from './use-block-context';
 
 /**
  * Internal dependencies
@@ -26,7 +22,6 @@ import { useBlockEditContext } from '../block-edit/context';
 import useBlockSync from '../provider/use-block-sync';
 import { BlockContextProvider } from '../block-context';
 import { defaultLayout, LayoutProvider } from '../block-list/layout';
-import { store as blockEditorStore } from '../../store';
 
 /**
  * This hook is used to lightly mark an element as an inner blocks wrapper
@@ -100,10 +95,7 @@ function UncontrolledInnerBlocks( props ) {
 		useCompactList,
 	} = props;
 
-	const block = useSelect(
-		( select ) => select( blockEditorStore ).getBlock( clientId ),
-		[ clientId ]
-	) || { innerBlocks: [] };
+	const context = useBlockContext( clientId );
 
 	useNestedSettingsUpdate( clientId, allowedBlocks, templateLock );
 
@@ -116,43 +108,31 @@ function UncontrolledInnerBlocks( props ) {
 
 	const BlockListComponent = useCompactList ? BlockListCompact : BlockList;
 
-	let blockList = (
-		<BlockListComponent
-			marginVertical={ marginVertical }
-			marginHorizontal={ marginHorizontal }
-			rootClientId={ clientId }
-			renderAppender={ renderAppender }
-			renderFooterAppender={ renderFooterAppender }
-			withFooter={ false }
-			orientation={ orientation }
-			parentWidth={ parentWidth }
-			horizontalAlignment={ horizontalAlignment }
-			horizontal={ horizontal }
-			contentResizeMode={ contentResizeMode }
-			contentStyle={ contentStyle }
-			onAddBlock={ onAddBlock }
-			onDeleteBlock={ onDeleteBlock }
-			filterInnerBlocks={ filterInnerBlocks }
-			gridProperties={ gridProperties }
-			blockWidth={ blockWidth }
-		/>
+	return (
+		<LayoutProvider value={ layout }>
+			<BlockContextProvider value={ context }>
+				<BlockListComponent
+					marginVertical={ marginVertical }
+					marginHorizontal={ marginHorizontal }
+					rootClientId={ clientId }
+					renderAppender={ renderAppender }
+					renderFooterAppender={ renderFooterAppender }
+					withFooter={ false }
+					orientation={ orientation }
+					parentWidth={ parentWidth }
+					horizontalAlignment={ horizontalAlignment }
+					horizontal={ horizontal }
+					contentResizeMode={ contentResizeMode }
+					contentStyle={ contentStyle }
+					onAddBlock={ onAddBlock }
+					onDeleteBlock={ onDeleteBlock }
+					filterInnerBlocks={ filterInnerBlocks }
+					gridProperties={ gridProperties }
+					blockWidth={ blockWidth }
+				/>
+			</BlockContextProvider>
+		</LayoutProvider>
 	);
-
-	// Wrap context provider if (and only if) block has context to provide.
-	const blockType = getBlockType( block.name );
-	if ( blockType && blockType.providesContext ) {
-		const context = getBlockContext( block.attributes, blockType );
-
-		blockList = (
-			<LayoutProvider value={ layout }>
-				<BlockContextProvider value={ context }>
-					{ blockList }
-				</BlockContextProvider>
-			</LayoutProvider>
-		);
-	}
-
-	return blockList;
 }
 
 /**

package/src/components/inner-blocks/use-block-context.js

@@ -0,0 +1,47 @@
+/**
+ * WordPress dependencies
+ */
+import { store as blocksStore } from '@wordpress/blocks';
+import { useSelect } from '@wordpress/data';
+
+/**
+ * Internal dependencies
+ */
+import { store as blockEditorStore } from '../../store';
+
+/**
+ * Returns a context object for a given block.
+ *
+ * @param {string} clientId The block client ID.
+ *
+ * @return {Record<string,*>} Context value.
+ */
+export default function useBlockContext( clientId ) {
+	return useSelect(
+		( select ) => {
+			const block = select( blockEditorStore ).getBlock( clientId );
+			if ( ! block ) {
+				return undefined;
+			}
+
+			const blockType = select( blocksStore ).getBlockType( block.name );
+			if ( ! blockType ) {
+				return undefined;
+			}
+
+			if ( Object.keys( blockType.providesContext ).length === 0 ) {
+				return undefined;
+			}
+
+			return Object.fromEntries(
+				Object.entries( blockType.providesContext ).map(
+					( [ contextName, attributeName ] ) => [
+						contextName,
+						block.attributes[ attributeName ],
+					]
+				)
+			);
+		},
+		[ clientId ]
+	);
+}

package/src/components/inserter/block-patterns-explorer/explorer.js

@@ -38,7 +38,6 @@ function PatternsExplorerModal( { onModalClose, ...restProps } ) {
 	return (
 		<Modal
 			title={ __( 'Patterns' ) }
-			closeLabel={ __( 'Close' ) }
 			onRequestClose={ onModalClose }
 			isFullScreen
 		>

package/src/components/inserter/block-patterns-tab.js

@@ -92,6 +92,7 @@ function usePatternsCategories( rootClientId ) {
 export function BlockPatternsCategoryDialog( {
 	rootClientId,
 	onInsert,
+	onHover,
 	category,
 	showTitlesAsTooltip,
 } ) {
@@ -113,6 +114,7 @@ export function BlockPatternsCategoryDialog( {
 			<BlockPatternsCategoryPanel
 				rootClientId={ rootClientId }
 				onInsert={ onInsert }
+				onHover={ onHover }
 				category={ category }
 				showTitlesAsTooltip={ showTitlesAsTooltip }
 			/>
@@ -123,6 +125,7 @@ export function BlockPatternsCategoryDialog( {
 export function BlockPatternsCategoryPanel( {
 	rootClientId,
 	onInsert,
+	onHover,
 	category,
 	showTitlesAsTooltip,
 } ) {
@@ -156,6 +159,9 @@ export function BlockPatternsCategoryPanel( {
 
 	const currentShownPatterns = useAsyncList( currentCategoryPatterns );
 
+	// Hide block pattern preview on unmount.
+	useEffect( () => () => onHover( null ), [] );
+
 	if ( ! currentCategoryPatterns.length ) {
 		return null;
 	}
@@ -170,6 +176,7 @@ export function BlockPatternsCategoryPanel( {
 				shownPatterns={ currentShownPatterns }
 				blockPatterns={ currentCategoryPatterns }
 				onClickPattern={ onClick }
+				onHover={ onHover }
 				label={ category.label }
 				orientation="vertical"
 				category={ category.label }

package/src/components/inserter/block-types-tab.js

@@ -1,7 +1,7 @@
 /**
  * External dependencies
  */
-import { map, groupBy } from 'lodash';
+import { groupBy } from 'lodash';
 
 /**
  * WordPress dependencies
@@ -113,7 +113,7 @@ export function BlockTypesTab( {
 					</InserterPanel>
 				) }
 
-				{ map( currentlyRenderedCategories, ( category ) => {
+				{ currentlyRenderedCategories.map( ( category ) => {
 					const categoryItems = itemsPerCategory[ category.slug ];
 					if ( ! categoryItems || ! categoryItems.length ) {
 						return null;
@@ -148,8 +148,7 @@ export function BlockTypesTab( {
 					</InserterPanel>
 				) }
 
-				{ map(
-					currentlyRenderedCollections,
+				{ currentlyRenderedCollections.map(
 					( [ namespace, collection ] ) => {
 						const collectionItems = itemsPerCollection[ namespace ];
 						if ( ! collectionItems || ! collectionItems.length ) {

package/src/components/inserter/hooks/use-patterns-state.js

@@ -1,8 +1,3 @@
-/**
- * External dependencies
- */
-import { map } from 'lodash';
-
 /**
  * WordPress dependencies
  */
@@ -41,7 +36,7 @@ const usePatternsState = ( onInsert, rootClientId ) => {
 	const { createSuccessNotice } = useDispatch( noticesStore );
 	const onClickPattern = useCallback( ( pattern, blocks ) => {
 		onInsert(
-			map( blocks, ( block ) => cloneBlock( block ) ),
+			( blocks ?? [] ).map( ( block ) => cloneBlock( block ) ),
 			pattern.name
 		);
 		createSuccessNotice(

package/src/components/inserter/index.js

@@ -207,7 +207,7 @@ class Inserter extends Component {
 					'block-editor-inserter__popover',
 					{ 'is-quick': isQuick }
 				) }
-				position={ position }
+				popoverProps={ { position } }
 				onToggle={ this.onToggle }
 				expandOnMobile
 				headerTitle={ __( 'Add a block' ) }
@@ -225,7 +225,7 @@ export default compose( [
 			const {
 				getBlockRootClientId,
 				hasInserterItems,
-				__experimentalGetAllowedBlocks,
+				getAllowedBlocks,
 				__experimentalGetDirectInsertBlock,
 				getSettings,
 			} = select( blockEditorStore );
@@ -235,8 +235,7 @@ export default compose( [
 			rootClientId =
 				rootClientId || getBlockRootClientId( clientId ) || undefined;
 
-			const allowedBlocks =
-				__experimentalGetAllowedBlocks( rootClientId );
+			const allowedBlocks = getAllowedBlocks( rootClientId );
 
 			const directInsertBlock =
 				shouldDirectInsert &&

package/src/components/inserter/media-tab/hooks.js

@@ -1,8 +1,7 @@
 /**
  * WordPress dependencies
  */
-import { __ } from '@wordpress/i18n';
-import { useEffect, useState } from '@wordpress/element';
+import { useEffect, useState, useRef, useMemo } from '@wordpress/element';
 import { useSelect } from '@wordpress/data';
 
 /**
@@ -10,80 +9,183 @@ import { useSelect } from '@wordpress/data';
  */
 import { store as blockEditorStore } from '../../../store';
 
-export function useMediaResults( options = {} ) {
-	const [ results, setResults ] = useState();
-	const settings = useSelect(
-		( select ) => select( blockEditorStore ).getSettings(),
-		[]
-	);
+/**
+ * Interface for inserter media requests.
+ *
+ * @typedef {Object} InserterMediaRequest
+ * @property {number} per_page How many items to fetch per page.
+ * @property {string} search   The search term to use for filtering the results.
+ */
+
+/**
+ * Interface for inserter media responses. Any media resource should
+ * map their response to this interface, in order to create the core
+ * WordPress media blocks (image, video, audio).
+ *
+ * @typedef {Object} InserterMediaItem
+ * @property {string}        title        The title of the media item.
+ * @property {string}        url          The source url of the media item.
+ * @property {string}        [previewUrl] The preview source url of the media item to display in the media list.
+ * @property {number}        [id]         The WordPress id of the media item.
+ * @property {number|string} [sourceId]   The id of the media item from external source.
+ * @property {string}        [alt]        The alt text of the media item.
+ * @property {string}        [caption]    The caption of the media item.
+ */
+
+/**
+ * Fetches media items based on the provided category.
+ * Each media category is responsible for providing a `fetch` function.
+ *
+ * @param {Object}               category The media category to fetch results for.
+ * @param {InserterMediaRequest} query    The query args to use for the request.
+ * @return {InserterMediaItem[]} The media results.
+ */
+export function useMediaResults( category, query = {} ) {
+	const [ mediaList, setMediaList ] = useState();
+	const [ isLoading, setIsLoading ] = useState( false );
+	// We need to keep track of the last request made because
+	// multiple request can be fired without knowing the order
+	// of resolution, and we need to ensure we are showing
+	// the results of the last request.
+	// In the future we could use AbortController to cancel previous
+	// requests, but we don't for now as it involves adding support
+	// for this to `core-data` package.
+	const lastRequest = useRef();
 	useEffect( () => {
 		( async () => {
-			setResults();
-			const _media = await settings?.__unstableFetchMedia( options );
-			if ( _media ) setResults( _media );
+			const key = JSON.stringify( {
+				category: category.name,
+				...query,
+			} );
+			lastRequest.current = key;
+			setIsLoading( true );
+			setMediaList( [] ); // Empty the previous results.
+			const _media = await category.fetch?.( query );
+			if ( key === lastRequest.current ) {
+				setMediaList( _media );
+				setIsLoading( false );
+			}
 		} )();
-	}, Object.values( options ) );
-	return results;
+	}, [ category.name, ...Object.values( query ) ] );
+	return { mediaList, isLoading };
+}
+
+function useInserterMediaCategories() {
+	const {
+		inserterMediaCategories,
+		allowedMimeTypes,
+		enableOpenverseMediaCategory,
+	} = useSelect( ( select ) => {
+		const settings = select( blockEditorStore ).getSettings();
+		return {
+			inserterMediaCategories: settings.inserterMediaCategories,
+			allowedMimeTypes: settings.allowedMimeTypes,
+			enableOpenverseMediaCategory: settings.enableOpenverseMediaCategory,
+		};
+	}, [] );
+	// The allowed `mime_types` can be altered by `upload_mimes` filter and restrict
+	// some of them. In this case we shouldn't add the category to the available media
+	// categories list in the inserter.
+	const allowedCategories = useMemo( () => {
+		if ( ! inserterMediaCategories || ! allowedMimeTypes ) {
+			return;
+		}
+		return inserterMediaCategories.filter( ( category ) => {
+			// Check if Openverse category is enabled.
+			if (
+				! enableOpenverseMediaCategory &&
+				category.name === 'openverse'
+			) {
+				return false;
+			}
+			// When a category has set `isExternalResource` to `true`, we
+			// don't need to check for allowed mime types, as they are used
+			// for restricting uploads for this media type and not for
+			// inserting media from external sources.
+			if ( category.isExternalResource ) {
+				return true;
+			}
+			return Object.values( allowedMimeTypes ).some( ( mimeType ) =>
+				mimeType.startsWith( `${ category.mediaType }/` )
+			);
+		} );
+	}, [
+		inserterMediaCategories,
+		allowedMimeTypes,
+		enableOpenverseMediaCategory,
+	] );
+	return allowedCategories;
 }
 
-const MEDIA_CATEGORIES = [
-	{ label: __( 'Images' ), name: 'images', mediaType: 'image' },
-	{ label: __( 'Videos' ), name: 'videos', mediaType: 'video' },
-	{ label: __( 'Audio' ), name: 'audio', mediaType: 'audio' },
-];
 export function useMediaCategories( rootClientId ) {
 	const [ categories, setCategories ] = useState( [] );
-	const { canInsertImage, canInsertVideo, canInsertAudio, fetchMedia } =
-		useSelect(
-			( select ) => {
-				const { canInsertBlockType, getSettings } =
-					select( blockEditorStore );
-				return {
-					fetchMedia: getSettings().__unstableFetchMedia,
-					canInsertImage: canInsertBlockType(
-						'core/image',
-						rootClientId
-					),
-					canInsertVideo: canInsertBlockType(
-						'core/video',
-						rootClientId
-					),
-					canInsertAudio: canInsertBlockType(
-						'core/audio',
-						rootClientId
-					),
-				};
-			},
-			[ rootClientId ]
-		);
+	const { canInsertImage, canInsertVideo, canInsertAudio } = useSelect(
+		( select ) => {
+			const { canInsertBlockType } = select( blockEditorStore );
+			return {
+				canInsertImage: canInsertBlockType(
+					'core/image',
+					rootClientId
+				),
+				canInsertVideo: canInsertBlockType(
+					'core/video',
+					rootClientId
+				),
+				canInsertAudio: canInsertBlockType(
+					'core/audio',
+					rootClientId
+				),
+			};
+		},
+		[ rootClientId ]
+	);
+	const inserterMediaCategories = useInserterMediaCategories();
 	useEffect( () => {
 		( async () => {
-			// If `__unstableFetchMedia` is not defined in block
-			// editor settings, do not set any media categories.
-			if ( ! fetchMedia ) return;
-			const query = {
-				context: 'view',
-				per_page: 1,
-				_fields: [ 'id' ],
-			};
-			const [ image, video, audio ] = await Promise.allSettled( [
-				fetchMedia( { ...query, media_type: 'image' } ),
-				fetchMedia( { ...query, media_type: 'video' } ),
-				fetchMedia( { ...query, media_type: 'audio' } ),
-			] );
-			// The `value` property is only present if the promise's status is "fulfilled".
-			const showImage = canInsertImage && !! image.value?.length;
-			const showVideo = canInsertVideo && !! video.value?.length;
-			const showAudio = canInsertAudio && !! audio.value?.length;
-			setCategories(
-				MEDIA_CATEGORIES.filter(
-					( { mediaType } ) =>
-						( mediaType === 'image' && showImage ) ||
-						( mediaType === 'video' && showVideo ) ||
-						( mediaType === 'audio' && showAudio )
+			const _categories = [];
+			// If `inserterMediaCategories` is not defined in
+			// block editor settings, do not show any media categories.
+			if ( ! inserterMediaCategories ) {
+				return;
+			}
+			// Loop through categories to check if they have at least one media item.
+			const categoriesHaveMedia = new Map(
+				await Promise.all(
+					inserterMediaCategories.map( async ( category ) => {
+						// Some sources are external and we don't need to make a request.
+						if ( category.isExternalResource ) {
+							return [ category.name, true ];
+						}
+						const results = await category.fetch( { per_page: 1 } );
+						return [ category.name, !! results.length ];
+					} )
 				)
 			);
+			// We need to filter out categories that don't have any media items or
+			// whose corresponding block type is not allowed to be inserted, based
+			// on the category's `mediaType`.
+			const canInsertMediaType = {
+				image: canInsertImage,
+				video: canInsertVideo,
+				audio: canInsertAudio,
+			};
+			inserterMediaCategories.forEach( ( category ) => {
+				if (
+					canInsertMediaType[ category.mediaType ] &&
+					categoriesHaveMedia.get( category.name )
+				) {
+					_categories.push( category );
+				}
+			} );
+			if ( !! _categories.length ) {
+				setCategories( _categories );
+			}
 		} )();
-	}, [ canInsertImage, canInsertVideo, canInsertAudio, fetchMedia ] );
+	}, [
+		canInsertImage,
+		canInsertVideo,
+		canInsertAudio,
+		inserterMediaCategories,
+	] );
 	return categories;
 }