Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

refactor(Chart): observe the container width from its ref callback, not an Effect (#9867)

Cindy Zhangc1e6a5e7838a
diff --git a/packages/lab/src/Chart/Chart.test.tsx b/packages/lab/src/Chart/Chart.test.tsx
index 53ae728e43..d6dd9f0883 100644
--- a/packages/lab/src/Chart/Chart.test.tsx
+++ b/packages/lab/src/Chart/Chart.test.tsx
@@ -171,6 +171,37 @@ describe('Chart measurement gate', () => {
});
});
+describe('Chart container observation', () => {
+ it('observes its container while mounted and stops on unmount', () => {
+ const observed = new Set<Element>();
+ vi.stubGlobal(
+ 'ResizeObserver',
+ class {
+ observe(element: Element) {
+ observed.add(element);
+ }
+ unobserve(element: Element) {
+ observed.delete(element);
+ }
+ disconnect() {
+ observed.clear();
+ }
+ },
+ );
+ const {container, unmount} = render(
+ <Chart data={data} xKey="month" yKeys={['revenue']}>
+ <g />
+ </Chart>,
+ );
+ const chartContainer = container.firstElementChild;
+ expect(chartContainer).not.toBeNull();
+ expect(observed.has(chartContainer!)).toBe(true);
+
+ unmount();
+ expect(observed.size).toBe(0);
+ });
+});
+
describe('useChart', () => {
it('throws a clear error when used outside <Chart>', () => {
// React reports the uncaught render error via console.error; keep the
diff --git a/packages/lab/src/Chart/Chart.tsx b/packages/lab/src/Chart/Chart.tsx
index 7bf559c2d8..36b0f75eb4 100644
--- a/packages/lab/src/Chart/Chart.tsx
+++ b/packages/lab/src/Chart/Chart.tsx
@@ -134,18 +134,19 @@ export function Chart({
const svgRef = useRef<SVGSVGElement>(null);
const [containerWidth, setContainerWidth] = useState(0);
- useLayoutEffect(() => {
- if (!containerRef.current) {
- return;
- }
+ const attachContainer = useCallback((container: HTMLDivElement) => {
+ containerRef.current = container;
const observer = new ResizeObserver(entries => {
const entry = entries[0];
if (entry) {
setContainerWidth(entry.contentRect.width);
}
});
- observer.observe(containerRef.current);
- return () => observer.disconnect();
+ observer.observe(container);
+ return () => {
+ observer.disconnect();
+ containerRef.current = null;
+ };
}, []);
// Block scroll/zoom on the container when interactive.
@@ -320,7 +321,7 @@ export function Chart({
data.length * Math.max(yKeys.length, 1) <= MAX_TABLE_POINTS;
return (
- <div ref={containerRef} style={containerStyle}>
+ <div ref={attachContainer} style={containerStyle}>
{containerWidth > 0 && (
<svg
ref={svgRef}