Skip to content

Tooltip: refactor using Popover's new anchor prop #43799

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ciampo merged 3 commits into from
Sep 5, 2022
Merged

Tooltip: refactor using Popover's new anchor prop #43799

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3871376
Tooltip: use Popover s new anchor prop
ciampo Sep 2, 2022
47bc39f
Use internal state to force re-renders when the anchor ref changes
ciampo Sep 2, 2022
16d345e
Simplify code
ciampo Sep 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions packages/components/src/tooltip/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import {
concatChildren,
useEffect,
useState,
useRef,
} from '@wordpress/element';
import { useDebounce, useMergeRefs } from '@wordpress/compose';

Expand Down Expand Up @@ -60,7 +59,7 @@ const getRegularElement = ( {
};

const addPopoverToGrandchildren = ( {
anchorRef,
anchor,
grandchildren,
isOver,
offset,
Expand All @@ -78,7 +77,7 @@ const addPopoverToGrandchildren = ( {
aria-hidden="true"
animate={ false }
offset={ offset }
anchorRef={ anchorRef }
anchor={ anchor }
__unstableShift
>
{ text }
Expand Down Expand Up @@ -124,13 +123,18 @@ function Tooltip( props ) {
const [ isMouseDown, setIsMouseDown ] = useState( false );
const [ isOver, setIsOver ] = useState( false );
const delayedSetIsOver = useDebounce( setIsOver, delay );
// Using internal state (instead of a ref) for the popover anchor to make sure
// that the component re-renders when the anchor updates.
const [ popoverAnchor, setPopoverAnchor ] = useState();

// Create a reference to the Tooltip's child, to be passed to the Popover
// so that the Tooltip can be correctly positioned. Also, merge with the
// existing ref for the first child, so that its ref is preserved.
const childRef = useRef( null );
const existingChildRef = Children.toArray( children )[ 0 ]?.ref;
const mergedChildRefs = useMergeRefs( [ childRef, existingChildRef ] );
const mergedChildRefs = useMergeRefs( [
setPopoverAnchor,
existingChildRef,
] );

const createMouseDown = ( event ) => {
// In firefox, the mouse down event is also fired when the select
Expand Down Expand Up @@ -253,7 +257,8 @@ function Tooltip( props ) {
: getRegularElement;

const popoverData = {
anchorRef: childRef,
// `anchor` should never be `null`
anchor: popoverAnchor ?? undefined,
isOver,
offset: 4,
position,
Expand Down