@automattic/charts 1.7.0 → 1.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/dist/index.cjs +358 -51
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.css +6 -4
  5. package/dist/index.d.cts +16 -0
  6. package/dist/index.d.ts +16 -0
  7. package/dist/index.js +358 -51
  8. package/dist/index.js.map +1 -1
  9. package/package.json +1 -1
  10. package/src/charts/bar-chart/bar-chart.tsx +196 -42
  11. package/src/charts/bar-chart/private/comparison-bars-geometry.ts +70 -0
  12. package/src/charts/bar-chart/private/comparison-bars.tsx +154 -0
  13. package/src/charts/bar-chart/private/comparison-constants.ts +33 -0
  14. package/src/charts/bar-chart/private/index.ts +9 -0
  15. package/src/charts/bar-chart/private/test/comparison-bars-geometry.test.ts +47 -0
  16. package/src/charts/bar-chart/private/test/comparison-bars.test.tsx +183 -0
  17. package/src/charts/bar-chart/private/use-bar-chart-options.ts +46 -5
  18. package/src/charts/bar-chart/test/bar-chart.test.tsx +191 -1
  19. package/src/charts/geo-chart/geo-chart.tsx +5 -9
  20. package/src/charts/pie-chart/pie-chart.module.scss +0 -4
  21. package/src/charts/pie-chart/pie-chart.tsx +3 -8
  22. package/src/charts/pie-semi-circle-chart/pie-semi-circle-chart.module.scss +0 -5
  23. package/src/charts/pie-semi-circle-chart/pie-semi-circle-chart.tsx +3 -8
  24. package/src/charts/private/center/center.module.scss +4 -0
  25. package/src/charts/private/center/center.tsx +33 -0
  26. package/src/charts/private/center/index.ts +2 -0
  27. package/src/charts/private/center/test/center.test.tsx +60 -0
  28. package/src/charts/private/svg-empty-state/svg-empty-state.module.scss +0 -2
  29. package/src/charts/private/svg-empty-state/svg-empty-state.tsx +2 -4
  30. package/src/providers/chart-context/global-charts-provider.tsx +2 -0
  31. package/src/providers/chart-context/test/chart-context.test.tsx +13 -1
  32. package/src/providers/chart-context/themes.ts +8 -0
  33. package/src/providers/chart-context/types.ts +2 -0
  34. package/src/types.ts +16 -0
  35. package/src/utils/get-styles.ts +36 -13
  36. package/src/utils/index.ts +6 -1
  37. package/src/utils/test/get-styles.test.ts +47 -1
@@ -0,0 +1,183 @@
1
+ import { render, screen } from '@testing-library/react';
2
+ import { scaleBand, scaleLinear } from '@visx/scale';
3
+ import { DataContext } from '@visx/xychart';
4
+ import { ComparisonBars } from '../comparison-bars';
5
+ import type { DataPointDate, SeriesData } from '../../../../types';
6
+ import type { ComparisonSeriesEntry } from '../comparison-bars';
7
+
8
+ // Build the band scale over two categories (matches how BarGroup sets it up)
9
+ const categories = [ 'Jan', 'Feb' ];
10
+ const xScale = scaleBand( {
11
+ domain: categories,
12
+ range: [ 0, 200 ],
13
+ padding: 0.1,
14
+ } );
15
+
16
+ // Simple linear value scale: domain 0..100 -> range 200..0 (SVG coords, descending)
17
+ const yScale = scaleLinear( { domain: [ 0, 100 ], range: [ 200, 0 ] } );
18
+
19
+ // The primaryKeys in this test
20
+ const primaryKeys = [ 'current' ];
21
+ const groupPadding = 0.1;
22
+
23
+ // Build the same groupScale so tests can compute expected width
24
+ const groupScale = scaleBand( {
25
+ domain: primaryKeys,
26
+ range: [ 0, xScale.bandwidth() ],
27
+ padding: groupPadding,
28
+ } );
29
+
30
+ // Minimal DataContext value
31
+ const dataContextValue = {
32
+ xScale: xScale as never,
33
+ yScale: yScale as never,
34
+ horizontal: false,
35
+ // Other DataContext fields the component doesn't use
36
+ width: 200,
37
+ height: 200,
38
+ margin: { top: 0, right: 0, bottom: 0, left: 0 },
39
+ dataRegistry: {} as never,
40
+ registerData: () => undefined,
41
+ unregisterData: () => undefined,
42
+ setDimensions: () => undefined,
43
+ innerWidth: 200,
44
+ innerHeight: 200,
45
+ theme: {} as never,
46
+ colorScale: {} as never,
47
+ };
48
+
49
+ const seriesData: SeriesData = {
50
+ label: 'Comparison',
51
+ data: [
52
+ { label: 'Jan', value: 40 } as DataPointDate,
53
+ { label: 'Feb', value: 70 } as DataPointDate,
54
+ ] as DataPointDate[],
55
+ options: { type: 'comparison' },
56
+ };
57
+
58
+ const comparisonEntries: ComparisonSeriesEntry[] = [
59
+ { series: seriesData, index: 0, primaryKey: 'current', primaryIndex: 0 },
60
+ ];
61
+
62
+ const getElementStyles = () => ( {
63
+ color: '#f00',
64
+ barStyles: { widthFactor: 1.5, opacity: 0.5 },
65
+ lineStyles: {} as never,
66
+ glyph: undefined as never,
67
+ shapeStyles: {} as never,
68
+ } );
69
+
70
+ const resolveFill = () => '#f00';
71
+
72
+ const xAccessor = ( d: DataPointDate ) => d.label;
73
+ const yAccessor = ( d: DataPointDate ) => d.value ?? undefined;
74
+
75
+ describe( 'ComparisonBars', () => {
76
+ it( 'renders two shadow rects for two data points', () => {
77
+ render(
78
+ <svg>
79
+ <DataContext.Provider value={ dataContextValue }>
80
+ <ComparisonBars
81
+ comparisonEntries={ comparisonEntries }
82
+ primaryKeys={ primaryKeys }
83
+ groupPadding={ groupPadding }
84
+ horizontal={ false }
85
+ xAccessor={ xAccessor }
86
+ yAccessor={ yAccessor }
87
+ getElementStyles={ getElementStyles }
88
+ resolveFill={ resolveFill }
89
+ />
90
+ </DataContext.Provider>
91
+ </svg>
92
+ );
93
+
94
+ const rects = screen.getAllByTestId( /^bar-chart-comparison-0-/ );
95
+ expect( rects ).toHaveLength( 2 );
96
+ expect( rects[ 0 ] ).toHaveAttribute( 'fill', '#f00' );
97
+ expect( rects[ 0 ] ).toHaveAttribute( 'opacity', '0.5' );
98
+ // width == widthFactor (1.5) * groupScale.bandwidth()
99
+ expect( Number( rects[ 0 ].getAttribute( 'width' ) ) ).toBeCloseTo(
100
+ 1.5 * groupScale.bandwidth()
101
+ );
102
+ } );
103
+
104
+ it( 'wraps rects in a g with correct class and pointerEvents', () => {
105
+ render(
106
+ <svg>
107
+ <DataContext.Provider value={ dataContextValue }>
108
+ <ComparisonBars
109
+ comparisonEntries={ comparisonEntries }
110
+ primaryKeys={ primaryKeys }
111
+ groupPadding={ groupPadding }
112
+ horizontal={ false }
113
+ xAccessor={ xAccessor }
114
+ yAccessor={ yAccessor }
115
+ getElementStyles={ getElementStyles }
116
+ resolveFill={ resolveFill }
117
+ />
118
+ </DataContext.Provider>
119
+ </svg>
120
+ );
121
+
122
+ const g = screen.getByTestId( 'bar-chart-comparison-bars' );
123
+ expect( g ).toHaveClass( 'bar-chart__comparison-bars', { exact: true } );
124
+ expect( g ).toHaveAttribute( 'pointer-events', 'none' );
125
+ } );
126
+
127
+ it( 'shadow rect is horizontally centered on the primary bar slot at widthFactor × slot width', () => {
128
+ render(
129
+ <svg>
130
+ <DataContext.Provider value={ dataContextValue }>
131
+ <ComparisonBars
132
+ comparisonEntries={ comparisonEntries }
133
+ primaryKeys={ primaryKeys }
134
+ groupPadding={ groupPadding }
135
+ horizontal={ false }
136
+ xAccessor={ xAccessor }
137
+ yAccessor={ yAccessor }
138
+ getElementStyles={ getElementStyles }
139
+ resolveFill={ resolveFill }
140
+ />
141
+ </DataContext.Provider>
142
+ </svg>
143
+ );
144
+
145
+ const rects = screen.getAllByTestId( /^bar-chart-comparison-0-/ );
146
+ const rect = rects[ 0 ]; // 'Jan' datum
147
+
148
+ const slotThickness = groupScale.bandwidth();
149
+ const expectedWidth = 1.5 * slotThickness; // shadow = widthFactor × slot width
150
+ // Shadow x = bandStart + slotOffset + slotThickness/2 - shadowWidth/2
151
+ const bandStart = Number( xScale( 'Jan' ) );
152
+ const slotOffset = Number( groupScale( 'current' ) );
153
+ const expectedX = bandStart + slotOffset + slotThickness / 2 - expectedWidth / 2;
154
+ const expectedCenterX = expectedX + expectedWidth / 2;
155
+ const primarySlotCenterX = bandStart + slotOffset + slotThickness / 2;
156
+
157
+ expect( Number( rect.getAttribute( 'width' ) ) ).toBeCloseTo( expectedWidth );
158
+ expect( Number( rect.getAttribute( 'x' ) ) ).toBeCloseTo( expectedX );
159
+ // Center of shadow matches center of primary slot
160
+ expect( expectedCenterX ).toBeCloseTo( primarySlotCenterX );
161
+ } );
162
+
163
+ it( 'renders nothing when primaryKeys is empty', () => {
164
+ render(
165
+ <svg>
166
+ <DataContext.Provider value={ dataContextValue }>
167
+ <ComparisonBars
168
+ comparisonEntries={ comparisonEntries }
169
+ primaryKeys={ [] }
170
+ groupPadding={ groupPadding }
171
+ horizontal={ false }
172
+ xAccessor={ xAccessor }
173
+ yAccessor={ yAccessor }
174
+ getElementStyles={ getElementStyles }
175
+ resolveFill={ resolveFill }
176
+ />
177
+ </DataContext.Provider>
178
+ </svg>
179
+ );
180
+
181
+ expect( screen.queryByTestId( 'bar-chart-comparison-bars' ) ).not.toBeInTheDocument();
182
+ } );
183
+ } );
@@ -5,6 +5,11 @@ import type { EnhancedDataPoint } from '../../../hooks/use-zero-value-display';
5
5
  import type { DataPointDate, BaseChartProps, SeriesData } from '../../../types';
6
6
  import type { TickFormatter } from '@visx/axis';
7
7
 
8
+ /** Outer padding of the category band scale (space at the chart edges). */
9
+ export const BASE_BAND_PADDING = 0.2;
10
+ /** Inner padding of the category band scale (the base gap between ticks). */
11
+ export const BASE_BAND_PADDING_INNER = 0.1;
12
+
8
13
  const formatDateTick = ( timestamp: number ) => {
9
14
  const date = new Date( timestamp );
10
15
  return date.toLocaleDateString( undefined, {
@@ -39,8 +44,8 @@ export function useBarChartOptions(
39
44
  const defaultOptions = useMemo( () => {
40
45
  const bandScale = {
41
46
  type: 'band' as const,
42
- padding: 0.2,
43
- paddingInner: 0.1,
47
+ padding: BASE_BAND_PADDING,
48
+ paddingInner: BASE_BAND_PADDING_INNER,
44
49
  };
45
50
  const linearScale = {
46
51
  type: 'linear' as const,
@@ -97,8 +102,44 @@ export function useBarChartOptions(
97
102
  yScale: baseYScale,
98
103
  } = defaultOptions[ orientationKey ];
99
104
 
100
- const xScale = { ...baseXScale, ...( options.xScale || {} ) };
101
- const yScale = { ...baseYScale, ...( options.yScale || {} ) };
105
+ // When comparison series are present, visx only sees primary BarSeries and computes
106
+ // a too-narrow domain. Compute an explicit domain spanning all series so comparison
107
+ // shadows aren't clipped. Skip when the user has already provided an explicit domain.
108
+ let valueScaleDomainOverride: { domain?: [ number, number ] } = {};
109
+ const hasComparisonSeries = data.some( s => s.options?.type === 'comparison' );
110
+ if ( hasComparisonSeries ) {
111
+ const valueAxisIsY = ! horizontal;
112
+ const userDomain = valueAxisIsY ? options.yScale?.domain : options.xScale?.domain;
113
+ if ( ! userDomain ) {
114
+ const allValues: number[] = [];
115
+ data.forEach( series => {
116
+ series.data.forEach( d => {
117
+ const enhanced = d as { visualValue?: number };
118
+ const v =
119
+ enhanced.visualValue !== undefined ? enhanced.visualValue : ( d.value as number );
120
+ if ( typeof v === 'number' && Number.isFinite( v ) ) {
121
+ allValues.push( v );
122
+ }
123
+ } );
124
+ } );
125
+ if ( allValues.length > 0 ) {
126
+ valueScaleDomainOverride = {
127
+ domain: [ Math.min( ...allValues ), Math.max( ...allValues ) ],
128
+ };
129
+ }
130
+ }
131
+ }
132
+
133
+ const xScale = {
134
+ ...baseXScale,
135
+ ...( options.xScale || {} ),
136
+ ...( horizontal ? valueScaleDomainOverride : {} ),
137
+ };
138
+ const yScale = {
139
+ ...baseYScale,
140
+ ...( options.yScale || {} ),
141
+ ...( ! horizontal ? valueScaleDomainOverride : {} ),
142
+ };
102
143
  const providedToolTipLabelFormatter = horizontal
103
144
  ? options.axis?.y?.tickFormat
104
145
  : options.axis?.x?.tickFormat;
@@ -137,5 +178,5 @@ export function useBarChartOptions(
137
178
  labelFormatter: providedToolTipLabelFormatter || defaultTooltipLabelFormatter,
138
179
  },
139
180
  };
140
- }, [ defaultOptions, options, horizontal ] );
181
+ }, [ defaultOptions, options, horizontal, data ] );
141
182
  }
@@ -1,7 +1,8 @@
1
- import { render, screen } from '@testing-library/react';
1
+ import { render, renderHook, screen } from '@testing-library/react';
2
2
  import userEvent from '@testing-library/user-event';
3
3
  import { GlobalChartsProvider } from '../../../providers';
4
4
  import BarChart from '../bar-chart';
5
+ import { useBarChartOptions } from '../private';
5
6
 
6
7
  // Mock useElementSize to return non-zero dimensions in jsdom so charts render
7
8
  const mockRefCallback = jest.fn();
@@ -233,6 +234,37 @@ describe( 'BarChart', () => {
233
234
  // Check that no pattern definitions container is present
234
235
  expect( screen.queryByTestId( 'bar-chart-patterns' ) ).not.toBeInTheDocument();
235
236
  } );
237
+
238
+ test( 'comparison shadow reuses the primary bar pattern when patterns are enabled', () => {
239
+ renderWithTheme( {
240
+ withPatterns: true,
241
+ data: [
242
+ {
243
+ label: 'This period',
244
+ group: 'views',
245
+ data: [
246
+ { label: 'Mon', value: 10 },
247
+ { label: 'Tue', value: 20 },
248
+ ],
249
+ },
250
+ {
251
+ label: 'Previous period',
252
+ group: 'views',
253
+ options: { type: 'comparison' as const },
254
+ data: [
255
+ { label: 'Mon', value: 15 },
256
+ { label: 'Tue', value: 25 },
257
+ ],
258
+ },
259
+ ],
260
+ } );
261
+
262
+ const shadow = screen.getAllByTestId( /^bar-chart-comparison-\d+-\d+$/ )[ 0 ];
263
+ const shadowFill = shadow.getAttribute( 'fill' );
264
+ // Shadow is filled with a pattern, not a solid color, and it references the PRIMARY
265
+ // series' pattern (index 0) rather than the comparison series' own index.
266
+ expect( shadowFill ).toMatch( /^url\(#bar-pattern-.+-0\)$/ );
267
+ } );
236
268
  } );
237
269
 
238
270
  describe( 'Keyboard Navigation Accessibility', () => {
@@ -346,6 +378,45 @@ describe( 'BarChart', () => {
346
378
  } );
347
379
  } );
348
380
 
381
+ describe( 'Comparison tooltip', () => {
382
+ test( 'tooltip shows both the primary and comparison values', async () => {
383
+ const user = userEvent.setup();
384
+ renderWithTheme( {
385
+ withTooltips: true,
386
+ data: [
387
+ {
388
+ label: 'This period',
389
+ group: 'views',
390
+ data: [
391
+ { date: new Date( '2024-01-01' ), value: 10, label: 'Jan 1' },
392
+ { date: new Date( '2024-01-02' ), value: 20, label: 'Jan 2' },
393
+ ],
394
+ },
395
+ {
396
+ label: 'Previous period',
397
+ group: 'views',
398
+ options: { type: 'comparison' as const },
399
+ data: [
400
+ { date: new Date( '2024-01-01' ), value: 15, label: 'Jan 1' },
401
+ { date: new Date( '2024-01-02' ), value: 25, label: 'Jan 2' },
402
+ ],
403
+ },
404
+ ],
405
+ } );
406
+
407
+ const chart = screen.getByRole( 'grid', { name: /bar chart/i } );
408
+ chart.focus();
409
+
410
+ await user.keyboard( '{ArrowRight}' );
411
+ const tooltip = screen.getByTestId( 'chart-tooltip-0' );
412
+ // Both the current and previous period values are shown.
413
+ expect( tooltip ).toHaveTextContent( 'This period' );
414
+ expect( tooltip ).toHaveTextContent( '10' );
415
+ expect( tooltip ).toHaveTextContent( 'Previous period' );
416
+ expect( tooltip ).toHaveTextContent( '15' );
417
+ } );
418
+ } );
419
+
349
420
  describe( 'Tab Key Navigation', () => {
350
421
  test( 'tab key exits navigation when reaching end of data points', async () => {
351
422
  const user = userEvent.setup();
@@ -754,6 +825,125 @@ describe( 'BarChart', () => {
754
825
  } );
755
826
  } );
756
827
 
828
+ describe( 'Comparison Series', () => {
829
+ it( 'renders a translucent shadow behind the primary bar for a comparison series', () => {
830
+ const data = [
831
+ {
832
+ label: 'This year',
833
+ group: 'views',
834
+ data: [
835
+ { label: 'Jan', value: 100 },
836
+ { label: 'Feb', value: 120 },
837
+ ],
838
+ },
839
+ {
840
+ label: 'Last year',
841
+ group: 'views',
842
+ options: { type: 'comparison' as const },
843
+ data: [
844
+ { label: 'Jan', value: 80 },
845
+ { label: 'Feb', value: 140 },
846
+ ],
847
+ },
848
+ ];
849
+ render( <BarChart data={ data } width={ 400 } height={ 300 } /> );
850
+
851
+ // two comparison shadow rects (one per data point)
852
+ // Match individual rect testids like bar-chart-comparison-1-0 (not the group wrapper)
853
+ const shadows = screen.getAllByTestId( /^bar-chart-comparison-\d+-\d+$/ );
854
+ expect( shadows ).toHaveLength( 2 );
855
+ expect( shadows[ 0 ] ).toHaveAttribute( 'opacity', '0.5' );
856
+
857
+ // primary bars still render for the single primary series (visx .visx-bar)
858
+ // eslint-disable-next-line testing-library/no-node-access
859
+ const bars = document.querySelectorAll( '.visx-bar' );
860
+ expect( bars.length ).toBeGreaterThanOrEqual( 2 );
861
+ } );
862
+
863
+ it( 'expands value-axis domain to include comparison values exceeding the primary max', () => {
864
+ // Comparison value 150 exceeds primary max 100.
865
+ // Without domain expansion the value-axis scale config has no explicit domain,
866
+ // so visx derives it from primary BarSeries only (max=100).
867
+ // With the fix, an explicit domain [min,150] is set on the value-axis scale config.
868
+ const data = [
869
+ {
870
+ label: 'This year',
871
+ group: 'views',
872
+ data: [ { label: 'Jan', value: 100 } ],
873
+ },
874
+ {
875
+ label: 'Last year',
876
+ group: 'views',
877
+ options: { type: 'comparison' as const },
878
+ data: [ { label: 'Jan', value: 150 } ],
879
+ },
880
+ ];
881
+
882
+ const { result } = renderHook( () => useBarChartOptions( data, false, {} ) );
883
+ const yScale = result.current.yScale as { domain?: number[] };
884
+ // domain must be set explicitly and its max must be >= 150
885
+ expect( yScale.domain ).toBeDefined();
886
+ expect( ( yScale.domain as number[] )[ 1 ] ).toBeGreaterThanOrEqual( 150 );
887
+ } );
888
+
889
+ it( 'counts only primary series for keyboard navigation when a comparison series is present', async () => {
890
+ const user = userEvent.setup();
891
+ // 2 primary + 1 comparison. totalPoints should be 2*2=4, not 3*2=6.
892
+ // If comparison is counted, the 5th ArrowRight would reference a phantom series
893
+ // and could throw or show an undefined tooltip key.
894
+ const data = [
895
+ {
896
+ label: 'Series A',
897
+ group: 'g',
898
+ data: [
899
+ { label: 'Jan', value: 10 },
900
+ { label: 'Feb', value: 20 },
901
+ ],
902
+ },
903
+ {
904
+ label: 'Series B',
905
+ group: 'g2',
906
+ data: [
907
+ { label: 'Jan', value: 15 },
908
+ { label: 'Feb', value: 25 },
909
+ ],
910
+ },
911
+ {
912
+ label: 'Last year',
913
+ group: 'g',
914
+ options: { type: 'comparison' as const },
915
+ data: [
916
+ { label: 'Jan', value: 8 },
917
+ { label: 'Feb', value: 18 },
918
+ ],
919
+ },
920
+ ];
921
+ render(
922
+ <GlobalChartsProvider>
923
+ <BarChart data={ data } width={ 400 } height={ 300 } withTooltips />
924
+ </GlobalChartsProvider>
925
+ );
926
+
927
+ const chart = screen.getByRole( 'grid', { name: /bar chart/i } );
928
+ chart.focus();
929
+
930
+ // Navigate through all 4 primary slots (2 series × 2 data points)
931
+ for ( let i = 0; i < 4; i++ ) {
932
+ await user.keyboard( '{ArrowRight}' );
933
+ }
934
+
935
+ // If totalPoints was 6 (counted comparison), tooltip 4 would still show.
936
+ // With correct totalPoints=4, navigation wraps and tooltip 0 is shown again,
937
+ // not phantom slot 4 (which would reference data[2], a comparison series).
938
+ // Either way, there must be no crash and navigation must stay in bounds.
939
+ const tooltips = screen.queryAllByTestId( /^chart-tooltip-/ );
940
+ expect( tooltips ).toHaveLength( 1 );
941
+ // The visible tooltip must belong to a primary series
942
+ const tooltipText = tooltips[ 0 ].textContent ?? '';
943
+ expect( [ 'Series A', 'Series B' ].some( k => tooltipText.includes( k ) ) ).toBe( true );
944
+ } );
945
+ } );
946
+
757
947
  describe( 'Interactive Legend', () => {
758
948
  it( 'filters series when interactive legend is enabled and series is toggled', async () => {
759
949
  const user = userEvent.setup();
@@ -2,7 +2,6 @@
2
2
  * External dependencies
3
3
  */
4
4
  import { __ } from '@wordpress/i18n';
5
- import { Stack } from '@wordpress/ui';
6
5
  import clsx from 'clsx';
7
6
  import { FC, useContext, useMemo } from 'react';
8
7
  import { Chart } from 'react-google-charts';
@@ -13,6 +12,7 @@ import { GlobalChartsContext, GlobalChartsProvider, useGlobalChartsContext } fro
13
12
  import { lightenHexColor, normalizeColorToHex } from '../../utils/color-utils';
14
13
  import { resolveCssVariable } from '../../utils/resolve-css-var';
15
14
  import { sanitizeHtml } from '../../utils/sanitize-html';
15
+ import { Center } from '../private/center';
16
16
  import { withResponsive } from '../private/with-responsive';
17
17
  import styles from './geo-chart.module.scss';
18
18
  import { GeoChartProps } from './types';
@@ -60,15 +60,13 @@ const GeoChartInternal: FC< GeoChartProps > = ( {
60
60
 
61
61
  // Render loading placeholder
62
62
  const loadingPlaceholder = (
63
- <Stack
64
- align="center"
65
- justify="center"
63
+ <Center
66
64
  className={ clsx( 'geo-chart', styles.container, className ) }
67
65
  data-testid="geo-chart-loading"
68
66
  style={ { width, height } }
69
67
  >
70
68
  { renderPlaceholder ? renderPlaceholder() : __( 'Loading map', 'jetpack-charts' ) }
71
- </Stack>
69
+ </Center>
72
70
  );
73
71
 
74
72
  // Google charts doesn't accept CSS variables, so we need to convert them to hex colors
@@ -149,9 +147,7 @@ const GeoChartInternal: FC< GeoChartProps > = ( {
149
147
  );
150
148
 
151
149
  return (
152
- <Stack
153
- align="center"
154
- justify="center"
150
+ <Center
155
151
  className={ clsx( 'geo-chart', styles.container, className ) }
156
152
  data-testid="geo-chart"
157
153
  style={ { width, height, backgroundColor } }
@@ -164,7 +160,7 @@ const GeoChartInternal: FC< GeoChartProps > = ( {
164
160
  options={ options }
165
161
  loader={ loadingPlaceholder }
166
162
  />
167
- </Stack>
163
+ </Center>
168
164
  );
169
165
  };
170
166
 
@@ -7,8 +7,4 @@
7
7
  width: 100%;
8
8
  }
9
9
 
10
- &__centering {
11
- width: 100%;
12
- height: 100%;
13
- }
14
10
  }
@@ -2,7 +2,6 @@ import { Group } from '@visx/group';
2
2
  import { Pie } from '@visx/shape';
3
3
  import { useTooltip, useTooltipInPortal } from '@visx/tooltip';
4
4
  import { __ } from '@wordpress/i18n';
5
- import { Stack } from '@wordpress/ui';
6
5
  import clsx from 'clsx';
7
6
  import { useCallback, useContext, useMemo } from 'react';
8
7
  import { Legend, useChartLegendItems } from '../../components/legend';
@@ -22,6 +21,7 @@ import {
22
21
  } from '../../providers';
23
22
  import { attachSubComponents, resolveFontSize } from '../../utils';
24
23
  import { getStringWidth } from '../../visx/text';
24
+ import { Center } from '../private/center';
25
25
  import { ChartSVG, ChartHTML, useChartChildren } from '../private/chart-composition';
26
26
  import { ChartLayout } from '../private/chart-layout';
27
27
  import { RadialWipeAnimation } from '../private/radial-wipe-animation/';
@@ -358,12 +358,7 @@ const PieChartInternal = ( {
358
358
  : 0;
359
359
 
360
360
  return (
361
- <Stack
362
- ref={ containerRef }
363
- align="center"
364
- justify="center"
365
- className={ styles[ 'pie-chart__centering' ] }
366
- >
361
+ <Center ref={ containerRef }>
367
362
  <svg
368
363
  viewBox={ `0 0 ${ width } ${ height }` }
369
364
  preserveAspectRatio="xMidYMid meet"
@@ -493,7 +488,7 @@ const PieChartInternal = ( {
493
488
  { ! allSegmentsHidden && svgChildren }
494
489
  </Group>
495
490
  </svg>
496
- </Stack>
491
+ </Center>
497
492
  );
498
493
  } }
499
494
  </ChartLayout>
@@ -5,11 +5,6 @@
5
5
  width: 100%;
6
6
  }
7
7
 
8
- &__centering {
9
- width: 100%;
10
- height: 100%;
11
- }
12
-
13
8
  .label {
14
9
  font-weight: var(--wpds-typography-font-weight-medium, 499);
15
10
  font-size: var(--wpds-typography-font-size-lg, 16px);
@@ -3,7 +3,6 @@ import { Pie } from '@visx/shape';
3
3
  import { Text } from '@visx/text';
4
4
  import { useTooltip, useTooltipInPortal } from '@visx/tooltip';
5
5
  import { __ } from '@wordpress/i18n';
6
- import { Stack } from '@wordpress/ui';
7
6
  import clsx from 'clsx';
8
7
  import { useCallback, useContext, useMemo } from 'react';
9
8
  import { Legend, useChartLegendItems } from '../../components/legend';
@@ -21,6 +20,7 @@ import {
21
20
  GlobalChartsContext,
22
21
  } from '../../providers';
23
22
  import { attachSubComponents } from '../../utils';
23
+ import { Center } from '../private/center';
24
24
  import { ChartSVG, ChartHTML, useChartChildren } from '../private/chart-composition';
25
25
  import { ChartLayout } from '../private/chart-layout';
26
26
  import { RadialWipeAnimation } from '../private/radial-wipe-animation';
@@ -397,12 +397,7 @@ const PieSemiCircleChartInternal: FC< PieSemiCircleChartProps > = ( {
397
397
  const innerRadius = radius * ( 1 - thickness );
398
398
 
399
399
  return (
400
- <Stack
401
- ref={ containerRef }
402
- align="center"
403
- justify="center"
404
- className={ styles[ 'pie-semi-circle-chart__centering' ] }
405
- >
400
+ <Center ref={ containerRef }>
406
401
  <svg
407
402
  width={ width }
408
403
  height={ height }
@@ -491,7 +486,7 @@ const PieSemiCircleChartInternal: FC< PieSemiCircleChartProps > = ( {
491
486
  ) }
492
487
  </Group>
493
488
  </svg>
494
- </Stack>
489
+ </Center>
495
490
  );
496
491
  } }
497
492
  </ChartLayout>
@@ -0,0 +1,4 @@
1
+ .center {
2
+ width: 100%;
3
+ height: 100%;
4
+ }
@@ -0,0 +1,33 @@
1
+ import { Stack } from '@wordpress/ui';
2
+ import clsx from 'clsx';
3
+ import { forwardRef, type ComponentPropsWithoutRef } from 'react';
4
+ import styles from './center.module.scss';
5
+
6
+ export type CenterProps = ComponentPropsWithoutRef< typeof Stack >;
7
+
8
+ /**
9
+ * Centers its children on both axes and fills its parent.
10
+ *
11
+ * A thin wrapper around `Stack` with `align="center"` and `justify="center"`
12
+ * defaults (both overridable) plus `width: 100%; height: 100%`. Reads more
13
+ * honestly than a `Stack` with both axes centered, and lets call sites drop
14
+ * ad-hoc `*__centering` classes. Forwards its ref and spreads remaining props
15
+ * onto the underlying `Stack`.
16
+ *
17
+ * @param props - Stack props; `align`/`justify` default to `"center"`.
18
+ * @param ref - Forwarded to the underlying element.
19
+ * @return The centered layout element.
20
+ */
21
+ export const Center = forwardRef< HTMLDivElement, CenterProps >(
22
+ ( { align = 'center', justify = 'center', className, ...props }, ref ) => (
23
+ <Stack
24
+ ref={ ref }
25
+ align={ align }
26
+ justify={ justify }
27
+ className={ clsx( styles.center, className ) }
28
+ { ...props }
29
+ />
30
+ )
31
+ );
32
+
33
+ Center.displayName = 'Center';
@@ -0,0 +1,2 @@
1
+ export { Center } from './center';
2
+ export type { CenterProps } from './center';