Drop zone: rewrite with hooks (useDropZone) (#19514)

* Drop zone: rewrite with hooks * Add missing drop zones * Use hook for component * Oops * fix styling * fix unit tests * Simplify * Add style for appender drop target * Readd className prop * Add dropzone to block list instead of block * Add appender style * Clean up * Mark useDropZone unstable * Remove position classes
WordPress · Jan 10, 2020 · 1e0a6ce · 1e0a6ce
1 parent f26e083
commit 1e0a6ce
Show file tree

Hide file tree

Showing 15 changed files with 235 additions and 270 deletions.
diff --git a/packages/block-editor/src/components/block-drop-zone/index.js b/packages/block-editor/src/components/block-drop-zone/index.js
@@ -1,23 +1,14 @@
-/**
- * External dependencies
- */
-import classnames from 'classnames';
-
 /**
  * WordPress dependencies
  */
-import {
-	DropZone,
-	withFilters,
-} from '@wordpress/components';
+import { __unstableUseDropZone as useDropZone } from '@wordpress/components';
 import {
 	pasteHandler,
 	getBlockTransforms,
 	findTransform,
 } from '@wordpress/blocks';
-import { Component } from '@wordpress/element';
-import { withDispatch, withSelect } from '@wordpress/data';
-import { compose } from '@wordpress/compose';
+import { useDispatch, useSelect } from '@wordpress/data';
+import { useEffect, useState, useCallback } from '@wordpress/element';
 
 const parseDropEvent = ( event ) => {
 	let result = {
@@ -40,49 +31,63 @@ const parseDropEvent = ( event ) => {
 	return result;
 };
 
-class BlockDropZone extends Component {
-	constructor() {
-		super( ...arguments );
-
-		this.onFilesDrop = this.onFilesDrop.bind( this );
-		this.onHTMLDrop = this.onHTMLDrop.bind( this );
-		this.onDrop = this.onDrop.bind( this );
-	}
+export default function useBlockDropZone( { element, rootClientId } ) {
+	const [ clientId, setClientId ] = useState( null );
 
-	getInsertIndex( position ) {
-		const { clientId, rootClientId, getBlockIndex } = this.props;
-		if ( clientId !== undefined ) {
-			const index = getBlockIndex( clientId, rootClientId );
-			return ( position && position.y === 'top' ) ? index : index + 1;
-		}
+	function selector( select ) {
+		const {
+			getBlockIndex,
+			getClientIdsOfDescendants,
+			getSettings,
+			getTemplateLock,
+		} = select( 'core/block-editor' );
+		return {
+			getBlockIndex,
+			blockIndex: getBlockIndex( clientId, rootClientId ),
+			getClientIdsOfDescendants,
+			hasUploadPermissions: !! getSettings().mediaUpload,
+			isLockedAll: getTemplateLock( rootClientId ) === 'all',
+		};
 	}
 
-	onFilesDrop( files, position ) {
-		if ( ! this.props.hasUploadPermissions ) {
+	const {
+		getBlockIndex,
+		blockIndex,
+		getClientIdsOfDescendants,
+		hasUploadPermissions,
+		isLockedAll,
+	} = useSelect( selector, [ rootClientId, clientId ] );
+	const {
+		insertBlocks,
+		updateBlockAttributes,
+		moveBlockToPosition,
+	} = useDispatch( 'core/block-editor' );
+
+	const onFilesDrop = useCallback( ( files ) => {
+		if ( ! hasUploadPermissions ) {
 			return;
 		}
+
 		const transformation = findTransform(
 			getBlockTransforms( 'from' ),
 			( transform ) => transform.type === 'files' && transform.isMatch( files )
 		);
 
 		if ( transformation ) {
-			const insertIndex = this.getInsertIndex( position );
-			const blocks = transformation.transform( files, this.props.updateBlockAttributes );
-			this.props.insertBlocks( blocks, insertIndex );
+			const blocks = transformation.transform( files, updateBlockAttributes );
+			insertBlocks( blocks, blockIndex, rootClientId );
 		}
-	}
+	}, [ hasUploadPermissions, updateBlockAttributes, insertBlocks, blockIndex, rootClientId ] );
 
-	onHTMLDrop( HTML, position ) {
+	const onHTMLDrop = useCallback( ( HTML ) => {
 		const blocks = pasteHandler( { HTML, mode: 'BLOCKS' } );
 
 		if ( blocks.length ) {
-			this.props.insertBlocks( blocks, this.getInsertIndex( position ) );
+			insertBlocks( blocks, blockIndex, rootClientId );
 		}
-	}
+	}, [ insertBlocks, blockIndex, rootClientId ] );
 
-	onDrop( event, position ) {
-		const { rootClientId: dstRootClientId, clientId: dstClientId, getClientIdsOfDescendants, getBlockIndex } = this.props;
+	const onDrop = useCallback( ( event ) => {
 		const { srcRootClientId, srcClientId, srcIndex, type } = parseDropEvent( event );
 
 		const isBlockDropType = ( dropType ) => dropType === 'block';
@@ -95,75 +100,53 @@ class BlockDropZone extends Component {
 		const isSrcBlockAnAncestorOfDstBlock = ( src, dst ) => getClientIdsOfDescendants( [ src ] ).some( ( id ) => id === dst );
 
 		if ( ! isBlockDropType( type ) ||
-			isSameBlock( srcClientId, dstClientId ) ||
-			isSrcBlockAnAncestorOfDstBlock( srcClientId, dstClientId || dstRootClientId ) ) {
+			isSameBlock( srcClientId, clientId ) ||
+			isSrcBlockAnAncestorOfDstBlock( srcClientId, clientId || rootClientId ) ) {
 			return;
 		}
 
-		const dstIndex = dstClientId ? getBlockIndex( dstClientId, dstRootClientId ) : undefined;
-		const positionIndex = this.getInsertIndex( position );
+		const dstIndex = clientId ? getBlockIndex( clientId, rootClientId ) : undefined;
+		const positionIndex = blockIndex;
 		// If the block is kept at the same level and moved downwards,
 		// subtract to account for blocks shifting upward to occupy its old position.
-		const insertIndex = dstIndex && srcIndex < dstIndex && isSameLevel( srcRootClientId, dstRootClientId ) ? positionIndex - 1 : positionIndex;
-		this.props.moveBlockToPosition( srcClientId, srcRootClientId, insertIndex );
-	}
-
-	render() {
-		const { hasUploadPermissions, isLockedAll } = this.props;
-		if ( isLockedAll ) {
-			return null;
+		const insertIndex = dstIndex && srcIndex < dstIndex && isSameLevel( srcRootClientId, rootClientId ) ? positionIndex - 1 : positionIndex;
+		moveBlockToPosition( srcClientId, srcRootClientId, rootClientId, insertIndex );
+	}, [ getClientIdsOfDescendants, getBlockIndex, clientId, blockIndex, moveBlockToPosition, rootClientId ] );
+
+	const { position } = useDropZone( {
+		element,
+		onFilesDrop,
+		onHTMLDrop,
+		onDrop,
+		isDisabled: isLockedAll,
+		withPosition: true,
+	} );
+
+	useEffect( () => {
+		if ( position ) {
+			const { y } = position;
+			const rect = element.current.getBoundingClientRect();
+
+			const offset = y - rect.top;
+			const target = Array.from( element.current.children ).find( ( blockEl ) => {
+				return blockEl.offsetTop + ( blockEl.offsetHeight / 2 ) > offset;
+			} );
+
+			if ( ! target ) {
+				return;
+			}
+
+			const targetClientId = target.id.slice( 'block-'.length );
+
+			if ( ! targetClientId ) {
+				return;
+			}
+
+			setClientId( targetClientId );
 		}
-		const index = this.getInsertIndex();
-		const isAppender = index === undefined;
-		return (
-			<DropZone
-				className={ classnames( 'block-editor-block-drop-zone', {
-					'is-appender': isAppender,
-				} ) }
-				onHTMLDrop={ this.onHTMLDrop }
-				onDrop={ this.onDrop }
-				onFilesDrop={ hasUploadPermissions ? this.onFilesDrop : undefined }
-			/>
-		);
+	}, [ position ] );
+
+	if ( position ) {
+		return clientId;
 	}
 }
-
-export default compose(
-	withDispatch( ( dispatch, ownProps ) => {
-		const {
-			insertBlocks,
-			updateBlockAttributes,
-			moveBlockToPosition,
-		} = dispatch( 'core/block-editor' );
-
-		return {
-			insertBlocks( blocks, index ) {
-				const { rootClientId } = ownProps;
-
-				insertBlocks( blocks, index, rootClientId );
-			},
-			updateBlockAttributes( ...args ) {
-				updateBlockAttributes( ...args );
-			},
-			moveBlockToPosition( srcClientId, srcRootClientId, dstIndex ) {
-				const { rootClientId: dstRootClientId } = ownProps;
-				moveBlockToPosition( srcClientId, srcRootClientId, dstRootClientId, dstIndex );
-			},
-		};
-	} ),
-	withSelect( ( select, { rootClientId } ) => {
-		const {
-			getBlockIndex,
-			getClientIdsOfDescendants,
-			getSettings,
-			getTemplateLock,
-		} = select( 'core/block-editor' );
-		return {
-			getBlockIndex,
-			getClientIdsOfDescendants,
-			hasUploadPermissions: !! getSettings().mediaUpload,
-			isLockedAll: getTemplateLock( rootClientId ) === 'all',
-		};
-	} ),
-	withFilters( 'editor.BlockDropZone' )
-)( BlockDropZone );
diff --git a/packages/block-editor/src/components/block-drop-zone/style.scss b/packages/block-editor/src/components/block-drop-zone/style.scss
diff --git a/packages/block-editor/src/components/block-list-appender/index.js b/packages/block-editor/src/components/block-list-appender/index.js
@@ -2,6 +2,7 @@
  * External dependencies
  */
 import { last } from 'lodash';
+import classnames from 'classnames';
 
 /**
  * WordPress dependencies
@@ -25,6 +26,7 @@ function BlockListAppender( {
 	canInsertDefaultBlock,
 	isLocked,
 	renderAppender: CustomAppender,
+	className,
 } ) {
 	if ( isLocked || CustomAppender === false ) {
 		return null;
@@ -68,7 +70,7 @@ function BlockListAppender( {
 			// Prevent the block from being selected when the appender is
 			// clicked.
 			onFocus={ stopPropagation }
-			className="block-list-appender"
+			className={ classnames( 'block-list-appender', className ) }
 		>
 			{ appender }
 		</div>

diff --git a/packages/block-editor/src/components/block-list-appender/style.scss b/packages/block-editor/src/components/block-list-appender/style.scss
@@ -10,6 +10,16 @@
 	}
 }
 
+.block-list-appender.is-drop-target > div::before {
+	content: "";
+	position: absolute;
+	right: -$block-padding;
+	left: -$block-padding;
+	top: -$block-padding;
+	bottom: -$block-padding;
+	border: 3px solid theme(primary);
+}
+
 .block-list-appender > .block-editor-inserter {
 	display: block;
 }
diff --git a/packages/block-editor/src/components/block-list/block.js b/packages/block-editor/src/components/block-list/block.js
@@ -37,7 +37,6 @@ import { useShortcut } from '@wordpress/keyboard-shortcuts';
  * Internal dependencies
  */
 import BlockEdit from '../block-edit';
-import BlockDropZone from '../block-drop-zone';
 import BlockInvalidWarning from './block-invalid-warning';
 import BlockCrashWarning from './block-crash-warning';
 import BlockCrashBoundary from './block-crash-boundary';
@@ -307,14 +306,6 @@ function BlockListBlock( {
 			isFirstMultiSelected
 		);
 
-	// Insertion point can only be made visible if the block is at the
-	// the extent of a multi-selection, or not in a multi-selection.
-	const shouldShowInsertionPoint = ! isMultiSelecting && (
-		( isPartOfMultiSelection && isFirstMultiSelected ) ||
-		! isPartOfMultiSelection
-	);
-
-	const shouldRenderDropzone = shouldShowInsertionPoint;
 	const isDragging = isDraggingBlocks && ( isSelected || isPartOfMultiSelection );
 
 	// The wp-block className is important for editor styles.
@@ -417,10 +408,6 @@ function BlockListBlock( {
 					animationStyle
 			}
 		>
-			{ shouldRenderDropzone && <BlockDropZone
-				clientId={ clientId }
-				rootClientId={ rootClientId }
-			/> }
 			{ hasAncestorCapturingToolbars && ( shouldShowContextualToolbar || isToolbarForced ) && (
 				// If the parent Block is set to consume toolbars of the child Blocks
 				// then render the child Block's toolbar into the Slot provided

diff --git a/packages/block-editor/src/components/block-list/index.js b/packages/block-editor/src/components/block-list/index.js
@@ -7,6 +7,7 @@ import classnames from 'classnames';
  * WordPress dependencies
  */
 import { AsyncModeProvider, useSelect } from '@wordpress/data';
+import { useRef } from '@wordpress/element';
 
 /**
  * Internal dependencies
@@ -15,6 +16,7 @@ import BlockListBlock from './block';
 import BlockListAppender from '../block-list-appender';
 import __experimentalBlockListFooter from '../block-list-footer';
 import RootContainer from './root-container';
+import useBlockDropZone from '../block-drop-zone';
 
 /**
  * If the block count exceeds the threshold, we disable the reordering animation
@@ -79,8 +81,16 @@ function BlockList( {
 
 	const Container = rootClientId ? 'div' : RootContainer;
 
+	const ref = useRef();
+
+	const targetClientId = useBlockDropZone( {
+		element: ref,
+		rootClientId,
+	} );
+
 	return (
 		<Container
+			ref={ ref }
 			className={ classnames(
 				'block-editor-block-list__layout',
 				className
@@ -106,13 +116,15 @@ function BlockList( {
 							enableAnimation={ enableAnimation }
 							hasSelectedUI={ uiParts.hasSelectedUI }
 							hasMovers={ uiParts.hasMovers }
+							className={ clientId === targetClientId ? 'is-drop-target' : undefined }
 						/>
 					</AsyncModeProvider>
 				);
 			} ) }
 			<BlockListAppender
 				rootClientId={ rootClientId }
 				renderAppender={ renderAppender }
+				className={ targetClientId === null ? 'is-drop-target' : undefined }
 			/>
 			<__experimentalBlockListFooter.Slot />
 		</Container>