Block editor: create useBlockRef and useBlockElement for better access #29573
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,7 +7,7 @@ import classnames from 'classnames'; | |
| * WordPress dependencies | ||
| */ | ||
| import { AsyncModeProvider, useSelect } from '@wordpress/data'; | ||
| import { useRef } from '@wordpress/element'; | ||
| import { useViewportMatch, useMergeRefs } from '@wordpress/compose'; | ||
|
|
||
| /** | ||
|
|
@@ -22,12 +22,8 @@ import { store as blockEditorStore } from '../../store'; | |
| import { usePreParsePatterns } from '../../utils/pre-parse-patterns'; | ||
| import { LayoutProvider, defaultLayout } from './layout'; | ||
|
|
||
| export default function BlockList( { className, __experimentalLayout } ) { | ||
| const ref = useRef(); | ||
| const insertionPoint = useInsertionPoint( ref ); | ||
| usePreParsePatterns(); | ||
|
|
||
|
|
@@ -53,7 +49,7 @@ export default function BlockList( { className, __experimentalLayout } ) { | |
| }, [] ); | ||
|
|
||
| return ( | ||
| <> | ||
| { insertionPoint } | ||
| <BlockPopover /> | ||
|
There was a problem hiding this comment. After this and #31134, we can move the popover and insertion point out of the BlockList component. |
||
| <div | ||
|
|
@@ -69,13 +65,9 @@ export default function BlockList( { className, __experimentalLayout } ) { | |
| } | ||
| ) } | ||
| > | ||
| <BlockListItems __experimentalLayout={ __experimentalLayout } /> | ||
| </div> | ||
| </> | ||
| ); | ||
| } | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { | ||
| useCallback, | ||
| useContext, | ||
| useLayoutEffect, | ||
| useMemo, | ||
| useRef, | ||
| useState, | ||
| } from '@wordpress/element'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import { BlockRefs } from '../../provider/block-refs-provider'; | ||
|
|
||
| /** @typedef {import('@wordpress/element').RefCallback} RefCallback */ | ||
| /** @typedef {import('@wordpress/element').RefObject} RefObject */ | ||
|
|
||
| /** | ||
| * Provides a ref to the BlockRefs context. | ||
| * | ||
| * @param {string} clientId The client ID of the element ref. | ||
| * | ||
| * @return {RefCallback} Ref callback. | ||
| */ | ||
| export function useBlockRefProvider( clientId ) { | ||
| const { refs, callbacks } = useContext( BlockRefs ); | ||
| const ref = useRef(); | ||
| useLayoutEffect( () => { | ||
| refs.set( clientId, ref ); | ||
| return () => { | ||
| refs.delete( clientId ); | ||
| }; | ||
| }, [] ); | ||
| return useCallback( ( element ) => { | ||
| // Update the ref in the provider. | ||
| ref.current = element; | ||
|
There was a problem hiding this comment. I wonder if we could just set the element in the context here instead of using an intermediary "ref". I thought the "ref" was useful for useBlockRef, but it doesn't seem to be the case anyway. There was a problem hiding this comment. We could through |
||
| // Call any update functions. | ||
| callbacks.forEach( ( id, setElement ) => { | ||
| if ( clientId === id ) { | ||
| setElement( element ); | ||
| } | ||
| } ); | ||
| }, [] ); | ||
| } | ||
|
|
||
| /** | ||
| * Gets a ref pointing to the current block element. Continues to return a | ||
| * stable ref even if the block client ID changes. | ||
| * | ||
| * @param {string} clientId The client ID to get a ref for. | ||
| * | ||
| * @return {RefObject} A ref containing the element. | ||
| */ | ||
| function useBlockRef( clientId ) { | ||
| const { refs } = useContext( BlockRefs ); | ||
| const freshClientId = useRef(); | ||
| freshClientId.current = clientId; | ||
| // Always return an object, even if no ref exists for a given client ID, so | ||
| // that `current` works at a later point. | ||
| return useMemo( | ||
| () => ( { | ||
| get current() { | ||
| return refs.get( freshClientId.current )?.current || null; | ||
| }, | ||
| } ), | ||
| [] | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Return the element for a given client ID. Updates whenever the element | ||
| * changes, becomes available, or disappears. | ||
| * | ||
| * @param {string} clientId The client ID to an element for. | ||
| * | ||
| * @return {Element|null} The block's wrapper element. | ||
| */ | ||
| function useBlockElement( clientId ) { | ||
| const { callbacks } = useContext( BlockRefs ); | ||
| const ref = useBlockRef( clientId ); | ||
| const [ element, setElement ] = useState( null ); | ||
|
|
||
| useLayoutEffect( () => { | ||
| if ( ! clientId ) { | ||
| return; | ||
| } | ||
|
|
||
| callbacks.set( setElement, clientId ); | ||
| return () => { | ||
| callbacks.delete( setElement ); | ||
| }; | ||
| }, [ clientId ] ); | ||
|
|
||
| return ref.current || element; | ||
| } | ||
|
|
||
| export { useBlockRef as __unstableUseBlockRef }; | ||
| export { useBlockElement as __unstableUseBlockElement }; | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remounting the component is better because the block element may change immediately from one to the other. Previously the block node would be undefined between client ID changes.