Skip to content
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

Jump to bottom

fix: [@radix-ui/react-tooltip] tooltip performance issue #2720

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: [@radix-ui/react-tooltip] tooltip performance issue #2720

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 8 additions & 8 deletions packages/react/tooltip/src/Tooltip.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const DEFAULT_DELAY_DURATION = 700;
const TOOLTIP_OPEN = 'tooltip.open';

type TooltipProviderContextValue = {
isOpenDelayed: boolean;
isOpenDelayedRef: React.MutableRefObject<boolean>;
delayDuration: number;
onOpen(): void;
onClose(): void;
Expand All @@ -43,7 +43,7 @@ type TooltipProviderContextValue = {
const [TooltipProviderContextProvider, useTooltipProviderContext] =
createTooltipContext<TooltipProviderContextValue>(PROVIDER_NAME);

interface TooltipProviderProps {
export interface TooltipProviderProps {
children: React.ReactNode;
/**
* The duration from when the pointer enters the trigger until the tooltip gets opened.
Expand Down Expand Up @@ -72,7 +72,7 @@ const TooltipProvider: React.FC<TooltipProviderProps> = (
disableHoverableContent = false,
children,
} = props;
const [isOpenDelayed, setIsOpenDelayed] = React.useState(true);
const isOpenDelayedRef = React.useRef(true);
const isPointerInTransitRef = React.useRef(false);
const skipDelayTimerRef = React.useRef(0);

Expand All @@ -84,16 +84,16 @@ const TooltipProvider: React.FC<TooltipProviderProps> = (
return (
<TooltipProviderContextProvider
scope={__scopeTooltip}
isOpenDelayed={isOpenDelayed}
isOpenDelayedRef={isOpenDelayedRef}
delayDuration={delayDuration}
onOpen={React.useCallback(() => {
window.clearTimeout(skipDelayTimerRef.current);
setIsOpenDelayed(false);
isOpenDelayedRef.current = false;
}, [])}
onClose={React.useCallback(() => {
window.clearTimeout(skipDelayTimerRef.current);
skipDelayTimerRef.current = window.setTimeout(
() => setIsOpenDelayed(true),
() => (isOpenDelayedRef.current = true),
skipDelayDuration
);
}, [skipDelayDuration])}
Expand Down Expand Up @@ -222,9 +222,9 @@ const Tooltip: React.FC<TooltipProps> = (props: ScopedProps<TooltipProps>) => {
trigger={trigger}
onTriggerChange={setTrigger}
onTriggerEnter={React.useCallback(() => {
if (providerContext.isOpenDelayed) handleDelayedOpen();
if (providerContext.isOpenDelayedRef.current) handleDelayedOpen();
else handleOpen();
}, [providerContext.isOpenDelayed, handleDelayedOpen, handleOpen])}
}, [providerContext.isOpenDelayedRef, handleDelayedOpen, handleOpen])}
onTriggerLeave={React.useCallback(() => {
if (disableHoverableContent) {
handleClose();
Expand Down
1 change: 1 addition & 0 deletions packages/react/tooltip/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ export {
} from './Tooltip';
export type {
TooltipProps,
TooltipProviderProps,
TooltipTriggerProps,
TooltipPortalProps,
TooltipContentProps,
Expand Down