The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.
TypeScript clickhousemysqlnextjsopen-sourceplanetscaleprismatailwindcsstinybirdtypescriptupstashvercel
import { localPoint } from "@visx/event";
import {
TooltipWithBounds,
useTooltipInPortal,
useTooltip as useVisxTooltip,
} from "@visx/tooltip";
import { bisector } from "d3-array";
import { useCallback, useContext, useEffect, useMemo, useRef } from "react";
import { ChartTooltipSyncContext } from "./tooltip-sync";
import {
ChartContext,
ChartTooltipContext,
Datum,
Series,
TimeSeriesDatum,
} from "./types";
const bisectDate = bisector<Datum, Date>((d) => new Date(d.date)).left;
export type TooltipOptions<T extends Datum> = {
seriesId?: Series["id"];
chartContext: ChartContext<T>;
renderInPortal?: boolean;
snapToX?: boolean;
snapToY?: boolean;
defaultIndex?: number;
onHoverDateChange?: (date: Date | null) => void;
};
export function useTooltip<T extends Datum>({
seriesId,
chartContext,
renderInPortal = false,
snapToY = false,
snapToX = true,
defaultIndex,
onHoverDateChange,
}: TooltipOptions<T>): ChartTooltipContext {
const { series, data, xScale, yScale, margin } = chartContext;
const tooltipSyncContext = useContext(ChartTooltipSyncContext);
const visxTooltipInPortal = useTooltipInPortal({
scroll: true,
detectBounds: true,
debounce: 200,
});
const defaultTooltipDatum =
defaultIndex !== undefined ? data[defaultIndex] : undefined;
const defaultTooltipData = useMemo(
() =>
defaultTooltipDatum !== undefined
? {
tooltipData: defaultTooltipDatum,
tooltipLeft: snapToX ? xScale(defaultTooltipDatum.date) : 0,
tooltipTop: snapToY
? yScale(
series
.find((s) => s.id === seriesId)!
.valueAccessor(defaultTooltipDatum),
)
: 0,
}
: undefined,
[defaultTooltipDatum, snapToX, snapToY, xScale, yScale, series, seriesId],
);
const visxTooltip = useVisxTooltip<TimeSeriesDatum<T>>();
// Throttle tooltip updates to animation frames to avoid excessive React
// state updates on every mousemove event.
const tooltipFrameRef = useRef<number | null>(null);
const pendingTooltipRef = useRef<{
tooltipData: TimeSeriesDatum<T>;
tooltipLeft: number;
tooltipTop: number;
} | null>(null);
const scheduleTooltipUpdate = useCallback(
(next: {
tooltipData: TimeSeriesDatum<T>;
tooltipLeft: number;
tooltipTop: number;
}) => {
pendingTooltipRef.current = next;
if (tooltipFrameRef.current !== null) return;
tooltipFrameRef.current = window.requestAnimationFrame(() => {
tooltipFrameRef.current = null;
const current = pendingTooltipRef.current;
if (!current) return;
visxTooltip.showTooltip({
tooltipData: current.tooltipData,
tooltipLeft: current.tooltipLeft ?? 0,
tooltipTop: current.tooltipTop,
});
});
},
[visxTooltip.showTooltip],
);
useEffect(
() => () => {
if (tooltipFrameRef.current !== null) {
window.cancelAnimationFrame(tooltipFrameRef.current);
}
},
[],
);
useEffect(() => {
if (defaultTooltipData) {
scheduleTooltipUpdate({
tooltipData: defaultTooltipData.tooltipData,
tooltipLeft: defaultTooltipData.tooltipLeft ?? 0,
tooltipTop: defaultTooltipData.tooltipTop,
});
}
}, [defaultTooltipData, scheduleTooltipUpdate]);
// Sync w/ other charts within the same ChartTooltipSync context
useEffect(() => {
if (
tooltipSyncContext.tooltipDate &&
visxTooltip.tooltipData?.date.getTime() !==
tooltipSyncContext.tooltipDate.getTime()
) {
const d = data.find(
(d) => d.date.getTime() === tooltipSyncContext.tooltipDate?.getTime(),
);
if (!d) return;
scheduleTooltipUpdate({
tooltipData: d,
tooltipLeft: xScale(d.date) ?? 0,
tooltipTop: snapToY
? yScale(series.find((s) => s.id === seriesId)!.valueAccessor(d))
: 0,
});
onHoverDateChange?.(d.date);
} else if (
tooltipSyncContext.tooltipDate === null &&
visxTooltip.tooltipData?.date
) {
visxTooltip.hideTooltip();
onHoverDateChange?.(null);
}
}, [
tooltipSyncContext.tooltipDate,
visxTooltip.tooltipData,
snapToX,
snapToY,
xScale,
yScale,
]);
const handleTooltip = useCallback(
(
event:
| React.TouchEvent<SVGRectElement>
| React.MouseEvent<SVGRectElement>,
) => {
const lp = localPoint(event) || { x: 0 };
const x = lp.x - margin.left;
const x0 =
"invert" in xScale
? xScale.invert(x)
: (xScale.domain()[
Math.round((x - xScale.step() * 0.75) / xScale.step())
] as Date | undefined);
if (x0 === undefined) {
console.log("x0 is undefined", { defaultTooltipData });
if (defaultTooltipData) visxTooltip.showTooltip(defaultTooltipData);
else visxTooltip.hideTooltip();
return;
}
if (data.length === 0) {
visxTooltip.hideTooltip();
return;
}
const index = bisectDate(data, x0, 1);
const d0 = data[index - 1];
const d1 = data[index];
let d = d0;
if (d1?.date) {
d =
x0.valueOf() - d0.date.valueOf() > d1.date.valueOf() - x0.valueOf()
? d1
: d0;
}
scheduleTooltipUpdate({
tooltipData: d,
tooltipLeft: snapToX ? xScale(d.date) ?? 0 : x,
tooltipTop: snapToY
? yScale(series.find((s) => s.id === seriesId)!.valueAccessor(d))
: 0,
});
tooltipSyncContext.setTooltipDate?.(d.date);
onHoverDateChange?.(d.date);
},
[
seriesId,
data,
xScale,
yScale,
series,
defaultTooltipData,
scheduleTooltipUpdate,
tooltipSyncContext.setTooltipDate,
],
);
const TooltipWrapper = renderInPortal
? visxTooltipInPortal.TooltipInPortal
: TooltipWithBounds;
return {
handleTooltip,
TooltipWrapper,
containerRef: visxTooltipInPortal.containerRef,
...visxTooltip,
hideTooltip: () => {
tooltipSyncContext.setTooltipDate?.(null);
defaultTooltipData
? visxTooltip.showTooltip(defaultTooltipData)
: visxTooltip.hideTooltip();
onHoverDateChange?.(null);
},
};
}