@wordpress/block-editor 12.17.0 → 12.18.0

package/src/components/list-view/block.js

@@ -43,7 +43,10 @@ import AriaReferencedText from './aria-referenced-text';
 
 function ListViewBlock( {
 	block: { clientId },
+	displacement,
+	isAfterDraggedBlocks,
 	isDragged,
+	isNesting,
 	isSelected,
 	isBranchSelected,
 	selectBlock,
@@ -270,6 +273,11 @@ function ListViewBlock( {
 		'has-single-cell': ! showBlockActions,
 		'is-synced': blockInformation?.isSynced,
 		'is-draggable': canMove,
+		'is-displacement-normal': displacement === 'normal',
+		'is-displacement-up': displacement === 'up',
+		'is-displacement-down': displacement === 'down',
+		'is-after-dragged-blocks': isAfterDraggedBlocks,
+		'is-nesting': isNesting,
 	} );
 
 	// Only include all selected blocks if the currently clicked on block
@@ -296,6 +304,7 @@ function ListViewBlock( {
 	return (
 		<ListViewLeaf
 			className={ classes }
+			isDragged={ isDragged }
 			onKeyDown={ onKeyDown }
 			onMouseEnter={ onMouseEnter }
 			onMouseLeave={ onMouseLeave }

package/src/components/list-view/branch.js

@@ -14,7 +14,7 @@ import { AsyncModeProvider, useSelect } from '@wordpress/data';
 import { Appender } from './appender';
 import ListViewBlock from './block';
 import { useListViewContext } from './context';
-import { isClientIdSelected } from './utils';
+import { getDragDisplacementValues, isClientIdSelected } from './utils';
 import { store as blockEditorStore } from '../../store';
 import useBlockDisplayInformation from '../use-block-display-information';
 
@@ -91,7 +91,6 @@ function ListViewBranch( props ) {
 		selectedClientIds,
 		level = 1,
 		path = '',
-		isBranchDragged = false,
 		isBranchSelected = false,
 		listPosition = 0,
 		fixedListWindow,
@@ -115,7 +114,14 @@ function ListViewBranch( props ) {
 		[ parentId ]
 	);
 
-	const { expandedState, draggedClientIds } = useListViewContext();
+	const {
+		blockDropPosition,
+		blockDropTargetIndex,
+		firstDraggedBlockIndex,
+		blockIndexes,
+		expandedState,
+		draggedClientIds,
+	} = useListViewContext();
 
 	if ( ! canParentExpand ) {
 		return null;
@@ -143,6 +149,21 @@ function ListViewBranch( props ) {
 					);
 				}
 
+				const isDragged = !! draggedClientIds?.includes( clientId );
+
+				// Determine the displacement of the block while dragging. This
+				// works out whether the current block should be displaced up or
+				// down, relative to the dragged blocks and the drop target.
+				const { displacement, isAfterDraggedBlocks, isNesting } =
+					getDragDisplacementValues( {
+						blockIndexes,
+						blockDropTargetIndex,
+						blockDropPosition,
+						clientId,
+						firstDraggedBlockIndex,
+						isDragged,
+					} );
+
 				const { itemInView } = fixedListWindow;
 				const blockInView = itemInView( nextPosition );
 
@@ -158,8 +179,6 @@ function ListViewBranch( props ) {
 						? expandedState[ clientId ] ?? isExpanded
 						: undefined;
 
-				const isDragged = !! draggedClientIds?.includes( clientId );
-
 				// Make updates to the selected or dragged blocks synchronous,
 				// but asynchronous for any other block.
 				const isSelected = isClientIdSelected(
@@ -178,7 +197,6 @@ function ListViewBranch( props ) {
 				const showBlock =
 					isDragged ||
 					blockInView ||
-					isBranchDragged ||
 					( isSelected && clientId === selectedClientIds[ 0 ] );
 				return (
 					<AsyncModeProvider key={ clientId } value={ ! isSelected }>
@@ -188,17 +206,20 @@ function ListViewBranch( props ) {
 								selectBlock={ selectBlock }
 								isSelected={ isSelected }
 								isBranchSelected={ isSelectedBranch }
-								isDragged={ isDragged || isBranchDragged }
+								isDragged={ isDragged }
 								level={ level }
 								position={ position }
 								rowCount={ rowCount }
 								siblingBlockCount={ blockCount }
 								showBlockMovers={ showBlockMovers }
 								path={ updatedPath }
-								isExpanded={ shouldExpand }
+								isExpanded={ isDragged ? false : shouldExpand }
 								listPosition={ nextPosition }
 								selectedClientIds={ selectedClientIds }
 								isSyncedBranch={ syncedBranch }
+								displacement={ displacement }
+								isAfterDraggedBlocks={ isAfterDraggedBlocks }
+								isNesting={ isNesting }
 							/>
 						) }
 						{ ! showBlock && (
@@ -206,7 +227,7 @@ function ListViewBranch( props ) {
 								<td className="block-editor-list-view-placeholder" />
 							</tr>
 						) }
-						{ hasNestedBlocks && shouldExpand && (
+						{ hasNestedBlocks && shouldExpand && ! isDragged && (
 							<ListViewBranch
 								parentId={ clientId }
 								blocks={ innerBlocks }
@@ -217,7 +238,6 @@ function ListViewBranch( props ) {
 								listPosition={ nextPosition + 1 }
 								fixedListWindow={ fixedListWindow }
 								isBranchSelected={ isSelectedBranch }
-								isBranchDragged={ isDragged || isBranchDragged }
 								selectedClientIds={ selectedClientIds }
 								isExpanded={ isExpanded }
 								isSyncedBranch={ syncedBranch }

package/src/components/list-view/drop-indicator.js

@@ -1,15 +1,40 @@
+/**
+ * External dependencies
+ */
+import classnames from 'classnames';
+
 /**
  * WordPress dependencies
  */
-import { Popover } from '@wordpress/components';
+import {
+	__experimentalHStack as HStack,
+	__experimentalTruncate as Truncate,
+	Popover,
+} from '@wordpress/components';
+
 import { getScrollContainer } from '@wordpress/dom';
 import { useCallback, useMemo } from '@wordpress/element';
 import { isRTL } from '@wordpress/i18n';
 
-export default function ListViewDropIndicator( {
+/**
+ * Internal dependencies
+ */
+import BlockIcon from '../block-icon';
+import useBlockDisplayInformation from '../use-block-display-information';
+import useBlockDisplayTitle from '../block-title/use-block-display-title';
+import ListViewExpander from './expander';
+
+export default function ListViewDropIndicatorPreview( {
+	draggedBlockClientId,
 	listViewRef,
 	blockDropTarget,
 } ) {
+	const blockInformation = useBlockDisplayInformation( draggedBlockClientId );
+	const blockTitle = useBlockDisplayTitle( {
+		clientId: draggedBlockClientId,
+		context: 'list-view',
+	} );
+
 	const { rootClientId, clientId, dropPosition } = blockDropTarget || {};
 
 	const [ rootBlockElement, blockElement ] = useMemo( () => {
@@ -35,7 +60,7 @@ export default function ListViewDropIndicator( {
 			: undefined;
 
 		return [ _rootBlockElement, _blockElement ];
-	}, [ rootClientId, clientId ] );
+	}, [ listViewRef, rootClientId, clientId ] );
 
 	// The targetElement is the element that the drop indicator will appear
 	// before or after. When dropping into an empty block list, blockElement
@@ -44,27 +69,6 @@ export default function ListViewDropIndicator( {
 
 	const rtl = isRTL();
 
-	const getDropIndicatorIndent = useCallback(
-		( targetElementRect ) => {
-			if ( ! rootBlockElement ) {
-				return 0;
-			}
-
-			// Calculate the indent using the block icon of the root block.
-			// Using a classname selector here might be flaky and could be
-			// improved.
-			const rootBlockIconElement = rootBlockElement.querySelector(
-				'.block-editor-block-icon'
-			);
-			const rootBlockIconRect =
-				rootBlockIconElement.getBoundingClientRect();
-			return rtl
-				? targetElementRect.right - rootBlockIconRect.left
-				: rootBlockIconRect.right - targetElementRect.left;
-		},
-		[ rootBlockElement, rtl ]
-	);
-
 	const getDropIndicatorWidth = useCallback(
 		( targetElementRect, indent ) => {
 			if ( ! targetElement ) {
@@ -143,12 +147,69 @@ export default function ListViewDropIndicator( {
 		}
 
 		const targetElementRect = targetElement.getBoundingClientRect();
-		const indent = getDropIndicatorIndent( targetElementRect );
 
 		return {
-			width: getDropIndicatorWidth( targetElementRect, indent ),
+			width: getDropIndicatorWidth( targetElementRect, 0 ),
 		};
-	}, [ getDropIndicatorIndent, getDropIndicatorWidth, targetElement ] );
+	}, [ getDropIndicatorWidth, targetElement ] );
+
+	const horizontalScrollOffsetStyle = useMemo( () => {
+		if ( ! targetElement ) {
+			return {};
+		}
+
+		const scrollContainer = getScrollContainer( targetElement );
+		const ownerDocument = targetElement.ownerDocument;
+		const windowScroll =
+			scrollContainer === ownerDocument.body ||
+			scrollContainer === ownerDocument.documentElement;
+
+		if ( scrollContainer && ! windowScroll ) {
+			const scrollContainerRect = scrollContainer.getBoundingClientRect();
+			const targetElementRect = targetElement.getBoundingClientRect();
+
+			const distanceBetweenContainerAndTarget = rtl
+				? scrollContainerRect.right - targetElementRect.right
+				: targetElementRect.left - scrollContainerRect.left;
+
+			if ( ! rtl && scrollContainerRect.left > targetElementRect.left ) {
+				return {
+					transform: `translateX( ${ distanceBetweenContainerAndTarget }px )`,
+				};
+			}
+
+			if ( rtl && scrollContainerRect.right < targetElementRect.right ) {
+				return {
+					transform: `translateX( ${
+						distanceBetweenContainerAndTarget * -1
+					}px )`,
+				};
+			}
+		}
+
+		return {};
+	}, [ rtl, targetElement ] );
+
+	const ariaLevel = useMemo( () => {
+		if ( ! rootBlockElement ) {
+			return 1;
+		}
+
+		const _ariaLevel = parseInt(
+			rootBlockElement.getAttribute( 'aria-level' ),
+			10
+		);
+
+		return _ariaLevel ? _ariaLevel + 1 : 1;
+	}, [ rootBlockElement ] );
+
+	const hasAdjacentSelectedBranch = useMemo( () => {
+		if ( ! targetElement ) {
+			return false;
+		}
+
+		return targetElement.classList.contains( 'is-branch-selected' );
+	}, [ targetElement ] );
 
 	const popoverAnchor = useMemo( () => {
 		const isValidDropPosition =
@@ -163,16 +224,15 @@ export default function ListViewDropIndicator( {
 			contextElement: targetElement,
 			getBoundingClientRect() {
 				const rect = targetElement.getBoundingClientRect();
-				const indent = getDropIndicatorIndent( rect );
 				// In RTL languages, the drop indicator should be positioned
 				// to the left of the target element, with the width of the
 				// indicator determining the indent at the right edge of the
 				// target element. In LTR languages, the drop indicator should
 				// end at the right edge of the target element, with the indent
 				// added to the position of the left edge of the target element.
-				let left = rtl ? rect.left : rect.left + indent;
+				// let left = rtl ? rect.left : rect.left + indent;
+				let left = rect.left;
 				let top = 0;
-				let bottom = 0;
 
 				// In deeply nested lists, where a scrollbar is present,
 				// the width of the drop indicator should be the width of
@@ -212,27 +272,19 @@ export default function ListViewDropIndicator( {
 				}
 
 				if ( dropPosition === 'top' ) {
-					top = rect.top;
-					bottom = rect.top;
+					top = rect.top - rect.height * 2;
 				} else {
 					// `dropPosition` is either `bottom` or `inside`
-					top = rect.bottom;
-					bottom = rect.bottom;
+					top = rect.top;
 				}
 
-				const width = getDropIndicatorWidth( rect, indent );
-				const height = bottom - top;
+				const width = getDropIndicatorWidth( rect, 0 );
+				const height = rect.height;
 
 				return new window.DOMRect( left, top, width, height );
 			},
 		};
-	}, [
-		targetElement,
-		dropPosition,
-		getDropIndicatorIndent,
-		getDropIndicatorWidth,
-		rtl,
-	] );
+	}, [ targetElement, dropPosition, getDropIndicatorWidth, rtl ] );
 
 	if ( ! targetElement ) {
 		return null;
@@ -243,13 +295,54 @@ export default function ListViewDropIndicator( {
 			animate={ false }
 			anchor={ popoverAnchor }
 			focusOnMount={ false }
-			className="block-editor-list-view-drop-indicator"
+			className="block-editor-list-view-drop-indicator--preview"
 			variant="unstyled"
+			flip={ false }
+			resize={ true }
 		>
 			<div
 				style={ style }
-				className="block-editor-list-view-drop-indicator__line"
-			/>
+				className={ classnames(
+					'block-editor-list-view-drop-indicator__line',
+					{
+						'block-editor-list-view-drop-indicator__line--darker':
+							hasAdjacentSelectedBranch,
+					}
+				) }
+			>
+				<div
+					className="block-editor-list-view-leaf"
+					aria-level={ ariaLevel }
+				>
+					<div
+						className={ classnames(
+							'block-editor-list-view-block-select-button',
+							'block-editor-list-view-block-contents'
+						) }
+						style={ horizontalScrollOffsetStyle }
+					>
+						<ListViewExpander onClick={ () => {} } />
+						<BlockIcon
+							icon={ blockInformation?.icon }
+							showColors
+							context="list-view"
+						/>
+						<HStack
+							alignment="center"
+							className="block-editor-list-view-block-select-button__label-wrapper"
+							justify="flex-start"
+							spacing={ 1 }
+						>
+							<span className="block-editor-list-view-block-select-button__title">
+								<Truncate ellipsizeMode="auto">
+									{ blockTitle }
+								</Truncate>
+							</span>
+						</HStack>
+					</div>
+					<div className="block-editor-list-view-block__menu-cell"></div>
+				</div>
+			</div>
 		</Popover>
 	);
 }

package/src/components/list-view/index.js

@@ -1,3 +1,8 @@
+/**
+ * External dependencies
+ */
+import classnames from 'classnames';
+
 /**
  * WordPress dependencies
  */
@@ -28,8 +33,9 @@ import { __ } from '@wordpress/i18n';
  */
 import ListViewBranch from './branch';
 import { ListViewContext } from './context';
-import ListViewDropIndicator from './drop-indicator';
+import ListViewDropIndicatorPreview from './drop-indicator';
 import useBlockSelection from './use-block-selection';
+import useListViewBlockIndexes from './use-list-view-block-indexes';
 import useListViewClientIds from './use-list-view-client-ids';
 import useListViewDropZone from './use-list-view-drop-zone';
 import useListViewExpandSelectedItem from './use-list-view-expand-selected-item';
@@ -105,6 +111,7 @@ function ListViewComponent(
 	const instanceId = useInstanceId( ListViewComponent );
 	const { clientIdsTree, draggedClientIds, selectedClientIds } =
 		useListViewClientIds( { blocks, rootClientId } );
+	const blockIndexes = useListViewBlockIndexes( clientIdsTree );
 
 	const { getBlock } = useSelect( blockEditorStore );
 	const { visibleBlockCount, shouldShowInnerBlocks } = useSelect(
@@ -132,6 +139,8 @@ function ListViewComponent(
 
 	const { ref: dropZoneRef, target: blockDropTarget } = useListViewDropZone( {
 		dropZoneElement,
+		expandedState,
+		setExpandedState,
 	} );
 	const elementRef = useRef();
 	const treeGridRef = useMergeRefs( [ elementRef, dropZoneRef, ref ] );
@@ -210,11 +219,55 @@ function ListViewComponent(
 		[ updateBlockSelection ]
 	);
 
+	const firstDraggedBlockClientId = draggedClientIds?.[ 0 ];
+
+	// Convert a blockDropTarget into indexes relative to the blocks in the list view.
+	// These values are used to determine which blocks should be displaced to make room
+	// for the drop indicator. See `ListViewBranch` and `getDragDisplacementValues`.
+	const { blockDropTargetIndex, blockDropPosition, firstDraggedBlockIndex } =
+		useMemo( () => {
+			let _blockDropTargetIndex, _firstDraggedBlockIndex;
+
+			if ( blockDropTarget?.clientId ) {
+				const foundBlockIndex =
+					blockIndexes[ blockDropTarget.clientId ];
+				// If dragging below or inside the block, treat the drop target as the next block.
+				_blockDropTargetIndex =
+					foundBlockIndex === undefined ||
+					blockDropTarget?.dropPosition === 'top'
+						? foundBlockIndex
+						: foundBlockIndex + 1;
+			} else if ( blockDropTarget === null ) {
+				// A `null` value is used to indicate that the user is dragging outside of the list view.
+				_blockDropTargetIndex = null;
+			}
+
+			if ( firstDraggedBlockClientId ) {
+				const foundBlockIndex =
+					blockIndexes[ firstDraggedBlockClientId ];
+				_firstDraggedBlockIndex =
+					foundBlockIndex === undefined ||
+					blockDropTarget?.dropPosition === 'top'
+						? foundBlockIndex
+						: foundBlockIndex + 1;
+			}
+
+			return {
+				blockDropTargetIndex: _blockDropTargetIndex,
+				blockDropPosition: blockDropTarget?.dropPosition,
+				firstDraggedBlockIndex: _firstDraggedBlockIndex,
+			};
+		}, [ blockDropTarget, blockIndexes, firstDraggedBlockClientId ] );
+
 	const contextValue = useMemo(
 		() => ( {
+			blockDropPosition,
+			blockDropTargetIndex,
+			blockIndexes,
 			draggedClientIds,
 			expandedState,
 			expand,
+			firstDraggedBlockIndex,
 			collapse,
 			BlockSettingsMenu,
 			listViewInstanceId: instanceId,
@@ -225,9 +278,13 @@ function ListViewComponent(
 			rootClientId,
 		} ),
 		[
+			blockDropPosition,
+			blockDropTargetIndex,
+			blockIndexes,
 			draggedClientIds,
 			expandedState,
 			expand,
+			firstDraggedBlockIndex,
 			collapse,
 			BlockSettingsMenu,
 			instanceId,
@@ -267,7 +324,8 @@ function ListViewComponent(
 
 	return (
 		<AsyncModeProvider value={ true }>
-			<ListViewDropIndicator
+			<ListViewDropIndicatorPreview
+				draggedBlockClientId={ firstDraggedBlockClientId }
 				listViewRef={ elementRef }
 				blockDropTarget={ blockDropTarget }
 			/>
@@ -278,7 +336,11 @@ function ListViewComponent(
 			) }
 			<TreeGrid
 				id={ id }
-				className="block-editor-list-view-tree"
+				className={ classnames( 'block-editor-list-view-tree', {
+					'is-dragging':
+						draggedClientIds?.length > 0 &&
+						blockDropTargetIndex !== undefined,
+				} ) }
 				aria-label={ __( 'Block navigation structure' ) }
 				ref={ treeGridRef }
 				onCollapseRow={ collapseRow }
@@ -286,6 +348,15 @@ function ListViewComponent(
 				onFocusRow={ focusRow }
 				applicationAriaLabel={ __( 'Block navigation structure' ) }
 				aria-describedby={ describedById }
+				style={ {
+					'--wp-admin--list-view-dragged-items-height':
+						draggedClientIds?.length
+							? `${
+									BLOCK_LIST_ITEM_HEIGHT *
+									( draggedClientIds.length - 1 )
+							  }px`
+							: null,
+				} }
 			>
 				<ListViewContext.Provider value={ contextValue }>
 					<ListViewBranch

package/src/components/list-view/leaf.js

@@ -21,6 +21,7 @@ const AnimatedTreeGridRow = animated( TreeGridRow );
 const ListViewLeaf = forwardRef(
 	(
 		{
+			isDragged,
 			isSelected,
 			position,
 			level,
@@ -33,8 +34,7 @@ const ListViewLeaf = forwardRef(
 		ref
 	) => {
 		const animationRef = useMovingAnimation( {
-			isSelected,
-			adjustScrolling: false,
+			clientId: props[ 'data-block' ],
 			enableAnimation: true,
 			triggerAnimationOnChange: path,
 		} );