Skip to content

fix: Do not render tooltip descriptions if set to null #57

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
merged 1 commit into from
Jul 17, 2025
+34 −11
Merged

fix: Do not render tooltip descriptions if set to null #57

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
32 changes: 27 additions & 5 deletions src/cartesian-chart/__tests__/cartesian-chart-error-bars.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ describe("CartesianChart: errorbar series", () => {
expect(getAllTooltipSeries()).toHaveLength(1);
expect(getTooltipSeries(0).findKey().getElement().textContent).toBe("Column 1");
expect(getTooltipSeries(0).findValue().getElement().textContent).toBe("2");
expect(getTooltipSeries(0).findDescription().getElement().textContent).toBe("Error range1 - 3");
expect(getTooltipSeries(0).findDescription()!.getElement().textContent).toBe("Error range1 - 3");
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before, the ! were not necessary because the description could never be empty, but it should be able to.

});

test("attaches error series to the previous series by using `:previous` as value for `linkedTo`", async () => {
Expand All @@ -48,7 +48,7 @@ describe("CartesianChart: errorbar series", () => {
expect(getAllTooltipSeries()).toHaveLength(1);
expect(getTooltipSeries(0).findKey().getElement().textContent).toBe("Column 1");
expect(getTooltipSeries(0).findValue().getElement().textContent).toBe("2");
expect(getTooltipSeries(0).findDescription().getElement().textContent).toBe("Error range1 - 3");
expect(getTooltipSeries(0).findDescription()!.getElement().textContent).toBe("Error range1 - 3");
});

test("renders only the error range if error bar series name is not provided", async () => {
Expand All @@ -63,7 +63,7 @@ describe("CartesianChart: errorbar series", () => {
await highlightFirstPointAndWaitForTooltip();

expect(getAllTooltipSeries()).toHaveLength(1);
expect(getTooltipSeries(0).findDescription().getElement().textContent).toBe("1 - 3");
expect(getTooltipSeries(0).findDescription()!.getElement().textContent).toBe("1 - 3");
});

test("renders multiple error bars per series", async () => {
Expand All @@ -81,7 +81,7 @@ describe("CartesianChart: errorbar series", () => {
expect(getAllTooltipSeries()).toHaveLength(1);
expect(getTooltipSeries(0).findKey().getElement().textContent).toBe("Column 1");
expect(getTooltipSeries(0).findValue().getElement().textContent).toBe("2");
expect(getTooltipSeries(0).findDescription().getElement().textContent).toBe(
expect(getTooltipSeries(0).findDescription()!.getElement().textContent).toBe(
"Error range 1" + "1 - 3" + "Error range 2" + "0 - 4",
);
});
Expand All @@ -107,7 +107,29 @@ describe("CartesianChart: errorbar series", () => {
expect(getAllTooltipSeries()).toHaveLength(1);
expect(getTooltipSeries(0).findKey().getElement().textContent).toBe("Custom key Column 1");
expect(getTooltipSeries(0).findValue().getElement().textContent).toBe("Custom value 2");
expect(getTooltipSeries(0).findDescription().getElement().textContent).toBe("Custom description 1 - 3");
expect(getTooltipSeries(0).findDescription()!.getElement().textContent).toBe("Custom description 1 - 3");
});

test("does not render description if set to null", async () => {
renderCartesianChart({
highcharts,
series: [
{ type: "column", name: "Column 1", data: [2], id: "column-1" },
{ type: "errorbar", name: "Column 2", data: [{ low: 1, high: 3 }], linkedTo: "column-1" },
],
tooltip: {
point: () => ({
description: null,
}),
},
});

await highlightFirstPointAndWaitForTooltip();

expect(getAllTooltipSeries()).toHaveLength(1);
expect(getTooltipSeries(0).findKey().getElement().textContent).toBe("Column 1");
expect(getTooltipSeries(0).findValue().getElement().textContent).toBe("2");
expect(getTooltipSeries(0).findDescription()).toBe(null);
});
});

Expand Down
4 changes: 2 additions & 2 deletions src/cartesian-chart/__tests__/cartesian-chart-tooltip.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ describe("CartesianChart: tooltip", () => {
getTooltipSeries(0).findValue().find("button")!.click();
expect(onClickValue).toHaveBeenCalledWith("root");

expect(getTooltipSeries(0).findDescription().getElement().textContent).toBe("1 - 4");
expect(getTooltipSeries(0).findDescription()!.getElement().textContent).toBe("1 - 4");

expect(getTooltipSeries(1).findKey().getElement().textContent).toBe("Custom name for Threshold");
expect(getTooltipSeries(1).findValue().getElement().textContent).toBe("T");
Expand Down Expand Up @@ -217,7 +217,7 @@ describe("CartesianChart: tooltip", () => {

expectCustomSubItems();

expect(getTooltipSeries(0).findDescription().getElement().textContent).toBe("1 - 4");
expect(getTooltipSeries(0).findDescription()!.getElement().textContent).toBe("1 - 4");

expect(getTooltipSeries(1).findKey().getElement().textContent).toBe("Threshold");
expect(getTooltipSeries(1).findValue().getElement().textContent).toBe(""); // X threshold has no y value
Expand Down
9 changes: 5 additions & 4 deletions src/core/components/core-tooltip.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ function getTooltipContentCartesian(
const detailItems: ChartSeriesDetailItem[] = matchedItems.map((item) => {
const valueFormatter = getFormatter(item.point.series.yAxis);
const itemY = isXThreshold(item.point.series) ? null : (item.point.y ?? null);
const customContent = renderers.point ? renderers.point({ item }) : null;
const customContent = renderers.point ? renderers.point({ item }) : undefined;
return {
key: customContent?.key ?? item.point.series.name,
value: customContent?.value ?? valueFormatter(itemY),
Expand All @@ -159,8 +159,7 @@ function getTooltipContentCartesian(
expandableId: customContent?.expandable ? item.point.series.name : undefined,
highlighted: item.point.x === point?.x && item.point.y === point?.y,
description:
customContent?.description ??
(item.errorRanges.length ? (
customContent?.description === undefined && item.errorRanges.length ? (
<>
{item.errorRanges.map((errorBarPoint, index) => (
<div key={index} className={styles["error-range"]}>
Expand All @@ -171,7 +170,9 @@ function getTooltipContentCartesian(
</div>
))}
</>
) : null),
) : (
customContent?.description
),
};
});
// We only support cartesian charts with a single x axis.
Expand Down
Loading