Skip to content

fix: debounce legend tooltips #145

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
pan-kot merged 1 commit into from
Jan 6, 2026
Merged

fix: debounce legend tooltips #145

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions src/core/__tests__/chart-core-legend.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ const getItem = (index: number, options?: { active?: boolean; dimmed?: boolean }
const mouseOver = (element: HTMLElement) => element.dispatchEvent(new MouseEvent("mouseover", { bubbles: true }));
const mouseOut = (element: HTMLElement) => element.dispatchEvent(new MouseEvent("mouseout", { bubbles: true }));
const mouseLeavePause = () => new Promise((resolve) => setTimeout(resolve, 300));
const tooltipShowPause = () => new Promise((resolve) => setTimeout(resolve, 350));

describe("CoreChart: legend", () => {
test("renders no legend when legend.enabled=false", () => {
Expand Down Expand Up @@ -378,12 +379,14 @@ describe("CoreChart: legend", () => {
expect(wrapper.findLegend()!.findItemTooltip()).toBe(null);

act(() => mouseOver(getItem(0).getElement()));
await tooltipShowPause();

expect(wrapper.findLegend()!.findItemTooltip()).not.toBe(null);
expect(wrapper.findLegend()!.findItemTooltip()!.findHeader()!.getElement().textContent).toBe("L1");

act(() => mouseOut(getItem(0).getElement()));
act(() => mouseOver(getItem(2).getElement()));
await tooltipShowPause();

expect(wrapper.findLegend()!.findItemTooltip()).not.toBe(null);
expect(wrapper.findLegend()!.findItemTooltip()!.findHeader()!.getElement().textContent).toBe("Line 3");
Expand All @@ -394,7 +397,7 @@ describe("CoreChart: legend", () => {
expect(wrapper.findLegend()!.findItemTooltip()).toBe(null);
});

test("renders legend tooltip on focus in cartesian chart", () => {
test("renders legend tooltip on focus in cartesian chart", async () => {
const { wrapper } = renderChart({
highcharts,
options: {
Expand All @@ -412,11 +415,13 @@ describe("CoreChart: legend", () => {
expect(wrapper.findLegend()!.findItemTooltip()).toBe(null);

act(() => getItem(0).focus());
await tooltipShowPause();

expect(wrapper.findLegend()!.findItemTooltip()).not.toBe(null);
expect(wrapper.findLegend()!.findItemTooltip()!.findHeader()!.getElement().textContent).toBe("L1");

getItem(0).keydown({ keyCode: KeyCode.right });
await tooltipShowPause();

expect(wrapper.findLegend()!.findItemTooltip()).not.toBe(null);
expect(wrapper.findLegend()!.findItemTooltip()!.findHeader()!.getElement().textContent).toBe("L2");
Expand All @@ -436,13 +441,15 @@ describe("CoreChart: legend", () => {
expect(wrapper.findLegend()!.findItemTooltip()).toBe(null);

act(() => mouseOver(getItem(0).getElement()));
await tooltipShowPause();

expect(wrapper.findLegend()!.findItemTooltip()).not.toBe(null);
expect(wrapper.findLegend()!.findItemTooltip()).not.toBe(null);
expect(wrapper.findLegend()!.findItemTooltip()!.findHeader()!.getElement().textContent).toBe("P1");

act(() => mouseOut(getItem(0).getElement()));
act(() => mouseOver(getItem(2).getElement()));
await tooltipShowPause();

expect(wrapper.findLegend()!.findItemTooltip()).not.toBe(null);
expect(wrapper.findLegend()!.findItemTooltip()!.findHeader()!.getElement().textContent).toBe("Pie 3");
Expand All @@ -453,7 +460,7 @@ describe("CoreChart: legend", () => {
expect(wrapper.findLegend()!.findItemTooltip()).toBe(null);
});

test("renders legend tooltip on focus in pie chart", () => {
test("renders legend tooltip on focus in pie chart", async () => {
const { wrapper } = renderChart({
highcharts,
options: { series: series.filter((s) => s.type === "pie") },
Expand All @@ -467,11 +474,13 @@ describe("CoreChart: legend", () => {
expect(wrapper.findLegend()!.findItemTooltip()).toBe(null);

act(() => getItem(0).focus());
await tooltipShowPause();

expect(wrapper.findLegend()!.findItemTooltip()).not.toBe(null);
expect(wrapper.findLegend()!.findItemTooltip()!.findHeader()!.getElement().textContent).toBe("P1");

getItem(0).keydown({ keyCode: KeyCode.right });
await tooltipShowPause();

expect(wrapper.findLegend()!.findItemTooltip()).not.toBe(null);
expect(wrapper.findLegend()!.findItemTooltip()!.findHeader()!.getElement().textContent).toBe("P2");
Expand Down
3 changes: 2 additions & 1 deletion src/internal/components/chart-legend/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import { GetLegendTooltipContentProps, LegendItem, LegendTooltipContent } from "
import styles from "./styles.css.js";
import testClasses from "./test-classes/styles.css.js";

const TOOLTIP_SHOW_DELAY = 300;
const TOOLTIP_BLUR_DELAY = 50;
const HIGHLIGHT_LOST_DELAY = 50;
const SCROLL_DELAY = 100;
Expand Down Expand Up @@ -73,7 +74,7 @@ export const ChartLegend = ({
const control = new DebouncedCall();
return {
showTooltip(itemId: string) {
control.call(() => setTooltipItemId(itemId));
control.call(() => setTooltipItemId(itemId), TOOLTIP_SHOW_DELAY);
},
hideTooltip(lock = false) {
control.call(() => setTooltipItemId(null), TOOLTIP_BLUR_DELAY);
Expand Down
Loading