Skip to content

🪢 Open source agent evals & observability: Trace, evaluate, and improve LLM applications with one open platform.

fix(web): Make sure label doesn't overlap arc in PieChart (#18174)

Ben Bachem829cf03bb7d4
diff --git a/web/src/components/design-system/charts/PieChart/PieChart.stories.tsx b/web/src/components/design-system/charts/PieChart/PieChart.stories.tsx
index b241d10503..0cd8f41cd1 100644
--- a/web/src/components/design-system/charts/PieChart/PieChart.stories.tsx
+++ b/web/src/components/design-system/charts/PieChart/PieChart.stories.tsx
@@ -1,5 +1,5 @@
import preview from "../../../../../.storybook/preview";
-import { expect, spyOn, userEvent, within } from "storybook/test";
+import { expect, spyOn, userEvent, waitFor, within } from "storybook/test";
import { chartColors } from "../constants";
import { PieChart } from "./PieChart";
@@ -62,6 +62,83 @@ export const LongLabels = meta.story({
},
});
+export const CenterTextFits = meta.story({
+ name: "(Test) Center Text Fits",
+ args: {
+ data: [{ label: "Production", value: 2.722947 }],
+ valueFormatter: (value) => `$${value.toFixed(6)}`,
+ centerLabel: "Total cost",
+ },
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement);
+ const total = canvas.getByText("$2.722947");
+ const label = canvas.getByText("Total cost");
+ const svg = canvasElement.querySelector("svg");
+ if (!svg) throw new Error("Missing pie chart SVG");
+ const container = svg.parentElement;
+ if (!container) throw new Error("Missing chart container");
+
+ for (const size of [420, 160, 120, 320]) {
+ container.style.width = `${size}px`;
+ container.style.height = `${size}px`;
+
+ await waitFor(async () => {
+ const chart = svg.getBoundingClientRect();
+ await expect(Math.abs(chart.width - size)).toBeLessThan(1);
+ await expect(Math.abs(chart.height - size)).toBeLessThan(1);
+ if (size === 120) {
+ await expect(total).not.toBeVisible();
+ await expect(label).not.toBeVisible();
+ await expect(svg).toBeVisible();
+ return;
+ }
+ await expect(total).toBeVisible();
+ await expect(label).toBeVisible();
+ const centerX = chart.x + chart.width / 2;
+ const centerY = chart.y + chart.height / 2;
+ const radius = Math.min(chart.width, chart.height) * (2 / 7);
+
+ const fits = [total, label].every((element) => {
+ const rect = element.getBoundingClientRect();
+ return [rect.left, rect.right].every((x) =>
+ [rect.top, rect.bottom].every(
+ (y) => Math.hypot(x - centerX, y - centerY) <= radius + 1,
+ ),
+ );
+ });
+ await expect(fits).toBe(true);
+ });
+ }
+ },
+});
+
+export const OversizedCenterTextHidden = meta.story({
+ name: "(Test) Oversized Center Text Hidden",
+ args: {
+ data: [{ label: "Production", value: 1 }],
+ valueFormatter: () => "$123456789012345678901234567890.123456",
+ centerLabel: "Total cost across all production environments",
+ },
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement);
+ const total = canvas.getByText("$123456789012345678901234567890.123456");
+ const label = canvas.getByText(
+ "Total cost across all production environments",
+ );
+ const svg = canvasElement.querySelector("svg");
+ if (!svg?.parentElement) throw new Error("Missing pie chart container");
+
+ svg.parentElement.style.width = "160px";
+ svg.parentElement.style.height = "160px";
+
+ await waitFor(async () => {
+ await expect(total).not.toBeVisible();
+ await expect(label).not.toBeVisible();
+ await expect(svg).toBeVisible();
+ });
+ },
+});
+
export const KeyboardFocus = meta.story({
name: "(Test) Keyboard Focus",
play: async ({ canvasElement }) => {
diff --git a/web/src/components/design-system/charts/PieChart/PieChart.tsx b/web/src/components/design-system/charts/PieChart/PieChart.tsx
index a881fdeded..e0bf5f9138 100644
--- a/web/src/components/design-system/charts/PieChart/PieChart.tsx
+++ b/web/src/components/design-system/charts/PieChart/PieChart.tsx
@@ -1,17 +1,18 @@
"use client";
-import { useMemo } from "react";
+import { useLayoutEffect, useMemo, useState } from "react";
+import clsx from "clsx";
import { scaleOrdinal } from "d3-scale";
import { arc, pie, type PieArcDatum } from "d3-shape";
import { ChartContainer } from "@/src/components/design-system/internal/charts/ChartContainer";
import { ChartTooltip } from "@/src/components/design-system/internal/charts/ChartTooltip";
+import { useElementSize } from "@/src/hooks/useElementSize";
import {
chartColors,
INACTIVE_CHART_COLOR_STRENGTH,
CHART_TRANSITION_DURATION,
} from "@/src/components/design-system/charts/constants";
-import { cn } from "@/src/utils/tailwind";
export type PieChartDatum = {
label: string;
@@ -39,6 +40,14 @@ const SMALL_SLICE_THRESHOLD = 0.02;
const PAD_ANGLE = (2 * Math.PI) / 360;
const MIN_VISIBLE_ANGLE = 2 * Math.PI * 0.01;
const MIN_SLICE_ANGLE = PAD_ANGLE + MIN_VISIBLE_ANGLE;
+const MIN_CENTER_LABEL_CHART_SIZE = 160;
+const CENTER_LABEL_SIZES = [
+ "2xlarge",
+ "xlarge",
+ "large",
+ "medium",
+ "small",
+] as const;
const percentageFormatter = new Intl.NumberFormat(undefined, {
style: "percent",
maximumFractionDigits: 1,
@@ -148,6 +157,58 @@ function PieChartContent({
return "small";
}, [availableSize]);
+ const [centerTextRef, centerTextSize] = useElementSize<HTMLDivElement>();
+ const formattedTotal = valueFormatter(totalValue);
+ const [centerTextFit, setCenterTextFit] = useState<{
+ availableSize: number;
+ centerLabel: string;
+ formattedTotal: string;
+ size: typeof centerLabelSize | "hidden";
+ } | null>(null);
+ const fittedCenterLabelSize =
+ centerTextFit?.availableSize === availableSize &&
+ centerTextFit.centerLabel === centerLabel &&
+ centerTextFit.formattedTotal === formattedTotal
+ ? centerTextFit.size
+ : centerLabelSize;
+
+ useLayoutEffect(() => {
+ const element = centerTextRef.current;
+ if (!element) return;
+ if (fittedCenterLabelSize === "hidden") return;
+
+ const radius = ((availableSize * INNER_RADIUS) / VIEWBOX_SIZE) * 0.9;
+ // The rectangle's corners must fit the circular hole, not just its width.
+ const textRadius =
+ Math.hypot(element.offsetWidth, element.offsetHeight) / 2;
+ if (textRadius <= radius) return;
+
+ const nextSize =
+ CENTER_LABEL_SIZES[
+ CENTER_LABEL_SIZES.indexOf(fittedCenterLabelSize) + 1
+ ] ?? "hidden";
+
+ setCenterTextFit((current) => {
+ if (
+ current?.availableSize === availableSize &&
+ current.centerLabel === centerLabel &&
+ current.formattedTotal === formattedTotal &&
+ current.size === nextSize
+ ) {
+ return current;
+ }
+ return { availableSize, centerLabel, formattedTotal, size: nextSize };
+ });
+ }, [
+ availableSize,
+ fittedCenterLabelSize,
+ centerLabel,
+ formattedTotal,
+ centerTextRef,
+ centerTextSize?.width,
+ centerTextSize?.height,
+ ]);
+
return (
<ChartTooltip>
{({ activeIndex, getReferenceProps }) => (
@@ -212,39 +273,48 @@ function PieChartContent({
</svg>
<div
- className={cn(
- "pointer-events-none absolute inset-0 flex flex-col items-center justify-center",
- centerLabelSize === "2xlarge" && "gap-2",
- centerLabelSize === "xlarge" && "gap-1.5",
- centerLabelSize === "large" && "gap-1",
- centerLabelSize === "medium" && "gap-0.5",
+ className={clsx(
+ "pointer-events-none absolute inset-0 flex items-center justify-center",
+ availableSize < MIN_CENTER_LABEL_CHART_SIZE && "invisible",
+ fittedCenterLabelSize === "hidden" && "invisible",
)}
aria-hidden="true"
>
- <span
- className={cn(
- "text-foreground leading-none font-bold",
- centerLabelSize === "2xlarge" && "text-6xl",
- centerLabelSize === "xlarge" && "text-5xl",
- centerLabelSize === "large" && "text-3xl",
- centerLabelSize === "medium" && "text-xl",
- centerLabelSize === "small" && "text-sm",
- )}
- >
- {valueFormatter(totalValue)}
- </span>
- <span
- className={cn(
- "text-muted-foreground leading-none",
- centerLabelSize === "2xlarge" && "text-lg",
- centerLabelSize === "xlarge" && "text-base",
- centerLabelSize === "large" && "text-xs",
- centerLabelSize === "medium" && "text-[10px]",
- centerLabelSize === "small" && "text-[8px]",
+ <div
+ ref={centerTextRef}
+ className={clsx(
+ "flex shrink-0 flex-col items-center justify-center whitespace-nowrap",
+ fittedCenterLabelSize === "2xlarge" && "gap-2",
+ fittedCenterLabelSize === "xlarge" && "gap-1.5",
+ fittedCenterLabelSize === "large" && "gap-1",
+ fittedCenterLabelSize === "medium" && "gap-0.5",
)}
>
- {centerLabel}
- </span>
+ <span
+ className={clsx(
+ "text-foreground leading-none font-bold",
+ fittedCenterLabelSize === "2xlarge" && "text-6xl",
+ fittedCenterLabelSize === "xlarge" && "text-5xl",
+ fittedCenterLabelSize === "large" && "text-3xl",
+ fittedCenterLabelSize === "medium" && "text-xl",
+ fittedCenterLabelSize === "small" && "text-sm",
+ )}
+ >
+ {formattedTotal}
+ </span>
+ <span
+ className={clsx(
+ "text-muted-foreground leading-none",
+ fittedCenterLabelSize === "2xlarge" && "text-lg",
+ fittedCenterLabelSize === "xlarge" && "text-base",
+ fittedCenterLabelSize === "large" && "text-xs",
+ fittedCenterLabelSize === "medium" && "text-[10px]",
+ fittedCenterLabelSize === "small" && "text-[8px]",
+ )}
+ >
+ {centerLabel}
+ </span>
+ </div>
</div>
</>
)}
diff --git a/web/src/hooks/useElementSize.ts b/web/src/hooks/useElementSize.ts
index 7fcccfc576..b756cb027b 100644
--- a/web/src/hooks/useElementSize.ts
+++ b/web/src/hooks/useElementSize.ts
@@ -1,4 +1,5 @@
-import { useEffect, useRef, useState } from "react";
+import { useCallback, useRef, useState } from "react";
+import { useResizeObserver } from "@/src/hooks/useResizeObserver";
export type ElementSize = {
width: number;
@@ -9,29 +10,18 @@ export function useElementSize<TElement extends HTMLElement>() {
const ref = useRef<TElement>(null);
const [size, setSize] = useState<ElementSize>();
- useEffect(() => {
+ const updateSize = useCallback(() => {
const element = ref.current;
if (!element) {
return;
}
- const updateSize = () => {
- const { width, height } = element.getBoundingClientRect();
- setSize({ width, height });
- };
-
- updateSize();
-
- if (typeof ResizeObserver === "undefined") {
- return;
- }
-
- const resizeObserver = new ResizeObserver(updateSize);
- resizeObserver.observe(element);
-
- return () => resizeObserver.disconnect();
+ const { width, height } = element.getBoundingClientRect();
+ setSize({ width, height });
}, []);
+ useResizeObserver(ref, updateSize);
+
return [ref, size] as const;
}
diff --git a/web/src/hooks/useResizeObserver.clienttest.ts b/web/src/hooks/useResizeObserver.clienttest.ts
new file mode 100644
index 0000000000..cabba253a6
--- /dev/null
+++ b/web/src/hooks/useResizeObserver.clienttest.ts
@@ -0,0 +1,52 @@
+import { act, renderHook } from "@testing-library/react";
+import { afterEach, describe, expect, it, vi } from "vitest";
+
+import { useResizeObserver } from "./useResizeObserver";
+
+describe("useResizeObserver", () => {
+ afterEach(() => {
+ vi.unstubAllGlobals();
+ });
+
+ it("measures initially, responds to resize, and disconnects on unmount", () => {
+ const observe = vi.fn();
+ const disconnect = vi.fn();
+ let notifyResize = () => {};
+ vi.stubGlobal(
+ "ResizeObserver",
+ class {
+ constructor(callback: () => void) {
+ notifyResize = callback;
+ }
+ observe = observe;
+ disconnect = disconnect;
+ },
+ );
+ const ref = { current: document.createElement("div") };
+ const onResize = vi.fn();
+ const { unmount } = renderHook(() => useResizeObserver(ref, onResize));
+
+ expect(observe).toHaveBeenCalledWith(ref.current);
+ expect(onResize).toHaveBeenCalledTimes(1);
+ act(() => notifyResize());
+ expect(onResize).toHaveBeenCalledTimes(2);
+ unmount();
+ expect(disconnect).toHaveBeenCalledTimes(1);
+ });
+
+ it("still measures when ResizeObserver is unavailable", () => {
+ vi.stubGlobal("ResizeObserver", undefined);
+ const ref = { current: document.createElement("div") };
+ const onResize = vi.fn();
+ renderHook(() => useResizeObserver(ref, onResize));
+
+ expect(onResize).toHaveBeenCalledTimes(1);
+ });
+
+ it("does not measure a missing element", () => {
+ const onResize = vi.fn();
+ renderHook(() => useResizeObserver({ current: null }, onResize));
+
+ expect(onResize).not.toHaveBeenCalled();
+ });
+});
diff --git a/web/src/hooks/useResizeObserver.ts b/web/src/hooks/useResizeObserver.ts
new file mode 100644
index 0000000000..d308fbd087
--- /dev/null
+++ b/web/src/hooks/useResizeObserver.ts
@@ -0,0 +1,18 @@
+import { useEffect, type RefObject } from "react";
+
+export function useResizeObserver<TElement extends Element>(
+ ref: RefObject<TElement | null>,
+ onResize: () => void,
+) {
+ useEffect(() => {
+ const element = ref.current;
+ if (!element) return;
+
+ onResize();
+ if (typeof ResizeObserver === "undefined") return;
+
+ const observer = new ResizeObserver(onResize);
+ observer.observe(element);
+ return () => observer.disconnect();
+ }, [ref, onResize]);
+}