@cdc/chart 4.26.7 → 4.26.10

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 (255) hide show
  1. package/CONFIG.md +502 -368
  2. package/dist/cdcchart-CYc-Kayd.es.js +22488 -0
  3. package/dist/cdcchart-DCKn8NmI.es.js +20695 -0
  4. package/dist/cdcchart-Dyui9nk_.es.js +45828 -0
  5. package/dist/cdcchart.js +4 -97406
  6. package/examples/__data__/vega-remote-data.json +6 -0
  7. package/examples/dendrogram.json +18 -0
  8. package/examples/feature/bar/bar-chart-race-annual-change.json +68 -0
  9. package/examples/feature/heatmap/average-age-categorical.json +2 -2
  10. package/examples/feature/heatmap/calendar-heatmap.json +2 -2
  11. package/examples/feature/heatmap/cell-values-bottom-axis.json +2 -2
  12. package/examples/feature/heatmap/sparse-aggregation.json +2 -2
  13. package/examples/feature/line/line-chart-race.json +50 -0
  14. package/examples/feature/sankey/sankey-example-data.json +40 -1441
  15. package/examples/feature/sankey/sankey_chart_data.csv +9 -20
  16. package/examples/network.json +31 -0
  17. package/examples/private/box-plot.json +573 -0
  18. package/examples/private/custom-color-issue.json +625 -0
  19. package/examples/private/custom-colors.json +522 -0
  20. package/examples/private/cutoff.json +10750 -0
  21. package/examples/private/overlay-legend.json +485 -0
  22. package/examples/private/pie-test.json +469 -0
  23. package/examples/vega-remote.json +22 -0
  24. package/package.json +11 -5
  25. package/src/CdcChartComponent.tsx +405 -208
  26. package/src/_stories/Chart.BarRace.stories.tsx +443 -0
  27. package/src/_stories/Chart.BoxPlotNumericSort.stories.tsx +189 -0
  28. package/src/_stories/Chart.BoxPlotStatsParity.stories.tsx +207 -0
  29. package/src/_stories/Chart.ColorDistribution.stories.tsx +299 -0
  30. package/src/_stories/Chart.DataCutoff.stories.tsx +147 -0
  31. package/src/_stories/Chart.DataTableDownloadFilename.stories.tsx +60 -0
  32. package/src/_stories/Chart.Dendrogram.stories.tsx +373 -0
  33. package/src/_stories/Chart.Forecast.CILegend.stories.tsx +236 -0
  34. package/src/_stories/Chart.HeatMap.stories.tsx +170 -4
  35. package/src/_stories/Chart.Legend.AxisAlign.stories.tsx +119 -0
  36. package/src/_stories/Chart.LineRace.stories.tsx +149 -0
  37. package/src/_stories/Chart.Network.stories.tsx +432 -0
  38. package/src/_stories/Chart.PaletteConversion.Editor.stories.tsx +208 -0
  39. package/src/_stories/Chart.Patterns.smoke.stories.tsx +31 -0
  40. package/src/_stories/Chart.PercentageValue.stories.tsx +311 -0
  41. package/src/_stories/Chart.PieLabels.stories.tsx +4 -2
  42. package/src/_stories/Chart.RankByValueMutation.stories.tsx +206 -0
  43. package/src/_stories/Chart.RequiredFields.stories.tsx +681 -0
  44. package/src/_stories/Chart.Sankey.stories.tsx +417 -0
  45. package/src/_stories/Chart.SeriesColorAssignments.stories.tsx +47 -0
  46. package/src/_stories/Chart.SmallMultiplesNumericTileOrder.stories.tsx +137 -0
  47. package/src/_stories/Chart.TooltipSeriesLabels.stories.tsx +43 -0
  48. package/src/_stories/Chart.VegaRemoteData.stories.tsx +31 -0
  49. package/src/_stories/ChartAnnotation.Editor.stories.tsx +78 -0
  50. package/src/_stories/ChartAxisTitles.smoke.stories.tsx +48 -0
  51. package/src/_stories/ChartBar.Editor.stories.tsx +499 -57
  52. package/src/_stories/ChartBrush.Editor.stories.tsx +46 -67
  53. package/src/_stories/ChartBrush.Regression.stories.tsx +135 -0
  54. package/src/_stories/ChartEditor.Editor.stories.tsx +33 -3
  55. package/src/_stories/ChartLine.EffectCompatibility.stories.tsx +120 -0
  56. package/src/_stories/_mock/annotation_event-line_mock.json +2 -2
  57. package/src/_stories/_mock/editor-test-configs.json +20 -10
  58. package/src/_stories/_mock/editor-test-datasets.json +38 -42
  59. package/src/_stories/_mock/heatmap-average-age-categorical.json +2 -2
  60. package/src/_stories/_mock/heatmap.json +2 -2
  61. package/src/_stories/_mock/legend-axis-align-stacked-bar.json +125 -0
  62. package/src/_stories/_mock/sankey_mock.json +23 -27
  63. package/src/components/Annotations/components/AnnotationDraggable.styles.css +52 -0
  64. package/src/components/Annotations/components/AnnotationDraggable.tsx +639 -139
  65. package/src/components/Annotations/components/AnnotationDropdown.styles.css +44 -4
  66. package/src/components/Annotations/components/AnnotationDropdown.tsx +10 -32
  67. package/src/components/Annotations/helpers/resolveAnnotationLayout.ts +212 -0
  68. package/src/components/Annotations/tests/AnnotationDraggable.test.tsx +612 -19
  69. package/src/components/Annotations/tests/AnnotationDropdown.test.tsx +50 -0
  70. package/src/components/Annotations/tests/resolveAnnotationLayout.test.ts +203 -0
  71. package/src/components/Axis/BottomAxis.tsx +1 -1
  72. package/src/components/Axis/Categorical.Axis.tsx +3 -3
  73. package/src/components/Axis/RightAxis.tsx +21 -13
  74. package/src/components/BarChart/components/BarChart.Horizontal.tsx +38 -6
  75. package/src/components/BarChart/components/BarChart.StackedHorizontal.tsx +12 -3
  76. package/src/components/BarChart/components/BarChart.StackedVertical.test.ts +28 -0
  77. package/src/components/BarChart/components/BarChart.StackedVertical.tsx +29 -25
  78. package/src/components/BarChart/components/BarChart.Vertical.tsx +37 -26
  79. package/src/components/BarChart/components/PortionPatternOverlay.tsx +61 -0
  80. package/src/components/BarChart/components/context.tsx +6 -0
  81. package/src/components/BarChart/helpers/getPatternUrl.ts +2 -5
  82. package/src/components/BarChart/helpers/index.ts +8 -0
  83. package/src/components/BarChart/helpers/portionPattern.ts +243 -0
  84. package/src/components/BarChart/helpers/tests/addMinimumBarHeights.test.ts +42 -0
  85. package/src/components/BarChart/helpers/tests/getPatternUrl.test.ts +13 -0
  86. package/src/components/BarChart/helpers/tests/portionPattern.test.ts +280 -0
  87. package/src/components/BarChart/helpers/tests/useBarChart.test.tsx +104 -0
  88. package/src/components/BarChart/helpers/useBarChart.ts +60 -59
  89. package/src/components/BarChartRace/BarChartRace.test.tsx +199 -0
  90. package/src/components/BarChartRace/BarChartRace.tsx +230 -0
  91. package/src/components/BarChartRace/BarChartRaceFallback.test.tsx +61 -0
  92. package/src/components/BarChartRace/BarChartRaceFallback.tsx +48 -0
  93. package/src/components/BarChartRace/bar-chart-race.css +160 -0
  94. package/src/components/BarChartRace/helpers.test.ts +114 -0
  95. package/src/components/BarChartRace/helpers.ts +185 -0
  96. package/src/components/BarChartRace/index.ts +3 -0
  97. package/src/components/BoxPlot/helpers/index.ts +11 -82
  98. package/src/components/Brush/BrushSelector.tsx +9 -23
  99. package/src/components/Brush/MiniChartPreview.tsx +33 -1
  100. package/src/components/Dendrogram/components/Dendrogram.tsx +374 -0
  101. package/src/components/Dendrogram/dendrogram.css +113 -0
  102. package/src/components/Dendrogram/helpers/layoutDendrogram.test.ts +95 -0
  103. package/src/components/Dendrogram/helpers/layoutDendrogram.ts +56 -0
  104. package/src/components/Dendrogram/helpers/prepareDendrogramData.test.ts +135 -0
  105. package/src/components/Dendrogram/helpers/prepareDendrogramData.ts +166 -0
  106. package/src/components/Dendrogram/helpers/resolveDendrogramLabels.test.ts +196 -0
  107. package/src/components/Dendrogram/helpers/resolveDendrogramLabels.ts +418 -0
  108. package/src/components/Dendrogram/index.tsx +1 -0
  109. package/src/components/Dendrogram/types/index.ts +66 -0
  110. package/src/components/EditorPanel/EditorPanel.tsx +1005 -760
  111. package/src/components/EditorPanel/components/Panels/Panel.Annotate.tsx +50 -5
  112. package/src/components/EditorPanel/components/Panels/Panel.Dendrogram.css +10 -0
  113. package/src/components/EditorPanel/components/Panels/Panel.Dendrogram.tsx +211 -0
  114. package/src/components/EditorPanel/components/Panels/Panel.ForestPlotSettings.tsx +19 -8
  115. package/src/components/EditorPanel/components/Panels/Panel.General.tsx +88 -54
  116. package/src/components/EditorPanel/components/Panels/Panel.Network.css +9 -0
  117. package/src/components/EditorPanel/components/Panels/Panel.Network.tsx +202 -0
  118. package/src/components/EditorPanel/components/Panels/Panel.PatternSettings.tsx +233 -33
  119. package/src/components/EditorPanel/components/Panels/Panel.Radar.tsx +6 -1
  120. package/src/components/EditorPanel/components/Panels/Panel.Sankey.tsx +89 -105
  121. package/src/components/EditorPanel/components/Panels/Panel.Series.tsx +2 -2
  122. package/src/components/EditorPanel/components/Panels/Panel.SmallMultiples.tsx +1 -1
  123. package/src/components/EditorPanel/components/Panels/Panel.Visual.tsx +8 -66
  124. package/src/components/EditorPanel/components/Panels/RacingControls.test.tsx +131 -0
  125. package/src/components/EditorPanel/components/Panels/RacingControls.tsx +185 -0
  126. package/src/components/EditorPanel/components/Panels/SeriesColorAssignments.tsx +2 -2
  127. package/src/components/EditorPanel/components/Panels/index.tsx +4 -0
  128. package/src/components/EditorPanel/helpers/getVisualizationTypeConfigUpdate.ts +20 -7
  129. package/src/components/EditorPanel/helpers/tests/getVisualizationTypeConfigUpdate.test.ts +25 -2
  130. package/src/components/EditorPanel/helpers/updateFieldRankByValue.ts +2 -1
  131. package/src/components/EditorPanel/useEditorPermissions.test.tsx +62 -0
  132. package/src/components/EditorPanel/useEditorPermissions.ts +70 -24
  133. package/src/components/Forecasting/Forecasting.tsx +15 -6
  134. package/src/components/HeatMap/components/HeatMap.tsx +511 -178
  135. package/src/components/HeatMap/heatmap.constants.ts +7 -3
  136. package/src/components/HeatMap/heatmap.css +101 -2
  137. package/src/components/HeatMap/helpers/layout.ts +80 -0
  138. package/src/components/HeatMap/tests/HeatMap.test.tsx +339 -16
  139. package/src/components/HeatMap/tests/helpers.test.ts +79 -0
  140. package/src/components/Legend/Legend.Component.tsx +110 -90
  141. package/src/components/Legend/LegendGroup/LegendGroup.styles.css +7 -0
  142. package/src/components/Legend/LegendGroup/LegendGroup.tsx +47 -34
  143. package/src/components/Legend/helpers/createFormatLabels.test.ts +226 -0
  144. package/src/components/Legend/helpers/createFormatLabels.tsx +45 -51
  145. package/src/components/LineChart/components/LineChart.Circle.tsx +3 -3
  146. package/src/components/LineChart/helpers.test.ts +126 -38
  147. package/src/components/LineChart/helpers.ts +9 -4
  148. package/src/components/LineChart/index.tsx +69 -24
  149. package/src/components/LineChart/tests/LineChart.test.tsx +630 -0
  150. package/src/components/LineChartRace/LineChartRace.test.tsx +275 -0
  151. package/src/components/LineChartRace/LineChartRace.tsx +134 -0
  152. package/src/components/LineChartRace/LineChartRaceFallback.tsx +28 -0
  153. package/src/components/LineChartRace/helpers.test.ts +88 -0
  154. package/src/components/LineChartRace/helpers.ts +157 -0
  155. package/src/components/LineChartRace/index.ts +3 -0
  156. package/src/components/LineChartRace/line-chart-race.css +16 -0
  157. package/src/components/LinearChart/ValueAxisAnchors.tsx +58 -0
  158. package/src/components/LinearChart/VisualizationRenderer.tsx +18 -23
  159. package/src/components/LinearChart/tests/LinearChart.test.tsx +412 -13
  160. package/src/components/LinearChart/tests/VisualizationRenderer.test.tsx +141 -0
  161. package/src/components/LinearChart/tests/mockConfigContext.ts +2 -1
  162. package/src/components/LinearChart.tsx +81 -51
  163. package/src/components/Network/components/Network.tsx +372 -0
  164. package/src/components/Network/helpers/layoutNetwork.test.ts +68 -0
  165. package/src/components/Network/helpers/layoutNetwork.ts +87 -0
  166. package/src/components/Network/helpers/prepareNetworkData.test.ts +116 -0
  167. package/src/components/Network/helpers/prepareNetworkData.ts +101 -0
  168. package/src/components/Network/helpers/resolveNetworkLabels.test.ts +112 -0
  169. package/src/components/Network/helpers/resolveNetworkLabels.ts +206 -0
  170. package/src/components/Network/index.tsx +3 -0
  171. package/src/components/Network/network.css +107 -0
  172. package/src/components/Network/types/index.ts +56 -0
  173. package/src/components/PairedBarChart.jsx +5 -10
  174. package/src/components/PairedBarChart.test.tsx +71 -0
  175. package/src/components/PieChart/PieChart.tsx +9 -8
  176. package/src/components/RacingChartRenderer.tsx +44 -0
  177. package/src/components/Regions/components/Regions.test.tsx +179 -0
  178. package/src/components/Regions/components/Regions.tsx +104 -69
  179. package/src/components/Regions/index.tsx +2 -3
  180. package/src/components/Sankey/components/Sankey.tsx +264 -437
  181. package/src/components/Sankey/helpers/getSankeyTooltip.ts +12 -0
  182. package/src/components/Sankey/helpers/prepareSankeyData.test.ts +71 -0
  183. package/src/components/Sankey/helpers/prepareSankeyData.ts +90 -0
  184. package/src/components/Sankey/sankey.scss +57 -116
  185. package/src/components/Sankey/types/index.ts +41 -4
  186. package/src/components/ScatterPlot/ScatterPlot.jsx +28 -4
  187. package/src/components/ScatterPlot/ScatterPlot.test.tsx +60 -0
  188. package/src/components/SmallMultiples/SmallMultiples.tsx +12 -12
  189. package/src/components/SmallMultiples/tests/SmallMultipleTile.test.tsx +7 -5
  190. package/src/components/raceTiming.ts +18 -0
  191. package/src/data/initial-state.js +77 -31
  192. package/src/helpers/applyChartTypeContract.ts +71 -0
  193. package/src/helpers/axisLabelFontSize.ts +2 -2
  194. package/src/helpers/boxPlotStats.ts +60 -0
  195. package/src/helpers/bumpChartTooltip.ts +2 -1
  196. package/src/helpers/calculateHorizontalBarCategoryLabelWidth.test.ts +37 -0
  197. package/src/helpers/calculateHorizontalBarCategoryLabelWidth.ts +3 -2
  198. package/src/helpers/calculateRightYAxisWidth.ts +60 -0
  199. package/src/helpers/colorAssignmentHelpers.ts +2 -2
  200. package/src/helpers/createNewChartConfig.ts +56 -0
  201. package/src/helpers/dataDrivenYAxisCategories.ts +18 -0
  202. package/src/helpers/forecastLegend.ts +88 -0
  203. package/src/helpers/getBoxPlotConfig.ts +18 -37
  204. package/src/helpers/getChartTypeDefaultPalette.ts +29 -0
  205. package/src/helpers/getColorCodeCategoryColorMap.ts +26 -0
  206. package/src/helpers/getColorScale.ts +31 -22
  207. package/src/helpers/getDynamicYAxisCategories.ts +69 -0
  208. package/src/helpers/getMinMax.ts +9 -7
  209. package/src/helpers/getNewRuntime.ts +5 -2
  210. package/src/helpers/getStackedSeriesMax.ts +51 -0
  211. package/src/helpers/getV21ChartDistributionColors.ts +57 -0
  212. package/src/helpers/handleRankByValue.ts +15 -15
  213. package/src/helpers/seriesColumnSettings.ts +10 -0
  214. package/src/helpers/sizeHelpers.ts +4 -3
  215. package/src/helpers/smallMultiplesHelpers.ts +10 -13
  216. package/src/helpers/tests/applyChartTypeContract.test.ts +37 -0
  217. package/src/helpers/tests/boxPlotStats.test.ts +31 -0
  218. package/src/helpers/tests/bumpChartTooltip.test.ts +29 -0
  219. package/src/helpers/tests/calculateRightYAxisWidth.test.ts +105 -0
  220. package/src/helpers/tests/countNumOfTicks.test.ts +11 -0
  221. package/src/helpers/tests/createNewChartConfig.test.ts +182 -0
  222. package/src/helpers/tests/getBoxPlotConfig.test.ts +70 -0
  223. package/src/helpers/tests/getColorCodeCategoryColorMap.test.ts +113 -0
  224. package/src/helpers/tests/getColorScale.test.ts +226 -1
  225. package/src/helpers/tests/getDynamicYAxisCategories.test.ts +61 -0
  226. package/src/helpers/tests/getMinMax.test.ts +41 -0
  227. package/src/helpers/tests/getStackedSeriesMax.test.ts +26 -0
  228. package/src/helpers/tests/handleRankByValue.test.ts +55 -37
  229. package/src/helpers/tests/seriesColumnSettings.test.ts +23 -0
  230. package/src/helpers/tests/smallMultiplesHelpers.test.ts +37 -1
  231. package/src/helpers/tests/tooltipHelpers.test.ts +80 -0
  232. package/src/helpers/tooltipHelpers.ts +16 -0
  233. package/src/hooks/tests/useTooltip.test.tsx +353 -1
  234. package/src/hooks/usePrefersReducedMotion.ts +22 -0
  235. package/src/hooks/useReduceData.ts +4 -36
  236. package/src/hooks/useScales.ts +15 -0
  237. package/src/hooks/useTooltip.tsx +95 -64
  238. package/src/scss/main.scss +74 -2
  239. package/src/store/chart.reducer.ts +4 -3
  240. package/src/test/CdcChart.dataTable.test.tsx +490 -16
  241. package/src/test/CdcChart.dendrogram.test.tsx +277 -0
  242. package/src/test/CdcChart.finalization.test.tsx +143 -0
  243. package/src/test/CdcChart.network.test.tsx +271 -0
  244. package/src/types/ChartConfig.ts +91 -54
  245. package/src/types/ChartContext.ts +5 -0
  246. package/src/types/Horizon.ts +1 -1
  247. package/LICENSE +0 -201
  248. package/dist/cdcchart-BWVIUcAF.es.js +0 -4802
  249. package/src/_stories/Chart.Sankey.smoke.stories.tsx +0 -62
  250. package/src/components/Sankey/components/ColumnList.tsx +0 -19
  251. package/src/components/Sankey/helpers/getSankeyTooltip.tsx +0 -34
  252. package/src/components/Sankey/useSankeyAlert.tsx +0 -60
  253. package/src/data/legacy-defaults.ts +0 -18
  254. package/src/helpers/ensureSpecialChartAxisTypes.ts +0 -11
  255. package/src/helpers/tests/ensureSpecialChartAxisTypes.test.ts +0 -30
@@ -0,0 +1,199 @@
1
+ import React from 'react'
2
+ import { act, fireEvent, render, screen } from '@testing-library/react'
3
+ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
4
+ import ConfigContext from '../../ConfigContext'
5
+ import { createMockChartContext, createMockConfig } from '../LinearChart/tests/mockConfigContext'
6
+ import BarChartRace from './BarChartRace'
7
+ import { getBarRaceEligibility } from './helpers'
8
+
9
+ const data = [
10
+ { Year: '2020', Place: 'Alpha', Value: 10 },
11
+ { Year: '2020', Place: 'Beta', Value: 20 },
12
+ { Year: '2021', Place: 'Alpha', Value: 30 },
13
+ { Year: '2021', Place: 'Beta', Value: 15 }
14
+ ]
15
+
16
+ type RaceOptions = {
17
+ displayNumbersOnBar?: boolean
18
+ formatNumber?: ReturnType<typeof vi.fn>
19
+ labelPlacement?: string
20
+ }
21
+
22
+ const getRaceContext = (rows = data, options: RaceOptions = {}) => {
23
+ const baseConfig = createMockConfig()
24
+ const yAxis = { ...baseConfig.yAxis }
25
+ delete yAxis.labelPlacement
26
+ if (options.labelPlacement) yAxis.labelPlacement = options.labelPlacement
27
+ if (options.displayNumbersOnBar !== undefined) yAxis.displayNumbersOnBar = options.displayNumbersOnBar
28
+ const config = createMockConfig({
29
+ visualizationType: 'Bar',
30
+ visualizationSubType: 'racing',
31
+ orientation: 'horizontal',
32
+ barStyle: 'flat',
33
+ isLollipopChart: false,
34
+ barRace: { maxBars: 2, secondsPerFrame: 0.5 },
35
+ xAxis: { ...baseConfig.xAxis, type: 'categorical', dataKey: 'Year', label: 'Year' },
36
+ yAxis,
37
+ series: [{ dataKey: 'Value', dynamicCategory: 'Place', axis: 'left', type: 'Bar' }] as any,
38
+ columns: { Value: { name: 'Value', label: 'Value', prefix: '$', roundToPlace: 0 } } as any,
39
+ runtime: { ...baseConfig.runtime, seriesKeys: ['Alpha', 'Beta'], seriesLabelsAll: ['Alpha', 'Beta'] }
40
+ })
41
+ return createMockChartContext(config, {
42
+ transformedData: rows,
43
+ colorScale: category => (category === 'Alpha' ? '#005ea8' : '#712177'),
44
+ formatNumber:
45
+ options.formatNumber ?? ((value, _axis, _abbreviated, prefix = '', suffix = '') => `${prefix}${value}${suffix}`)
46
+ })
47
+ }
48
+
49
+ const renderRace = (rows = data, options: RaceOptions = {}) => {
50
+ const context = getRaceContext(rows, options)
51
+ const race = getBarRaceEligibility(context.config, rows)
52
+
53
+ return render(
54
+ <ConfigContext.Provider value={context}>
55
+ <BarChartRace parentWidth={700} race={race} />
56
+ </ConfigContext.Provider>
57
+ )
58
+ }
59
+
60
+ describe('BarChartRace', () => {
61
+ beforeEach(() => {
62
+ vi.useFakeTimers()
63
+ vi.stubGlobal('matchMedia', () => ({
64
+ matches: true,
65
+ addEventListener: vi.fn(),
66
+ removeEventListener: vi.fn()
67
+ }))
68
+ })
69
+
70
+ afterEach(() => {
71
+ vi.useRealTimers()
72
+ vi.unstubAllGlobals()
73
+ })
74
+
75
+ it('uses the on-axis label layout when label placement is missing', () => {
76
+ const { container } = renderRace()
77
+
78
+ expect(container.querySelector('.bar-chart-race')).toHaveClass('bar-chart-race--labels-on-axis')
79
+ expect(container.querySelector('.bar-chart-race__plot')).toHaveStyle({ height: '96px' })
80
+ })
81
+
82
+ it('uses the on-axis label layout when label placement is explicit', () => {
83
+ const { container } = renderRace(data, { labelPlacement: 'On Date/Category Axis' })
84
+
85
+ expect(container.querySelector('.bar-chart-race')).toHaveClass('bar-chart-race--labels-on-axis')
86
+ expect(container.querySelector('.bar-chart-race')).not.toHaveClass('bar-chart-race--labels-below-bar')
87
+ })
88
+
89
+ it('moves labels below bars and adds row spacing for the below-bar layout', () => {
90
+ const { container } = renderRace(data, { labelPlacement: 'Below Bar' })
91
+
92
+ expect(container.querySelector('.bar-chart-race')).toHaveClass('bar-chart-race--labels-below-bar')
93
+ expect(container.querySelector('.bar-chart-race__plot')).toHaveStyle({ height: '128px' })
94
+ })
95
+
96
+ it('keeps value labels after bars when display numbers on bar is disabled', () => {
97
+ const { container } = renderRace(data, { displayNumbersOnBar: false })
98
+
99
+ expect(container.querySelectorAll('.bar-chart-race__value')).toHaveLength(2)
100
+ expect(container.querySelectorAll('.bar-chart-race__value--after')).toHaveLength(2)
101
+ expect(container.querySelector('.bar-chart-race__value--inside')).not.toBeInTheDocument()
102
+ })
103
+
104
+ it('places displayed values inside fitting bars and after bars that are too short', () => {
105
+ const rows = [
106
+ { Year: '2020', Place: 'Short', Value: 1 },
107
+ { Year: '2020', Place: 'Long', Value: 100 },
108
+ { Year: '2021', Place: 'Short', Value: 2 },
109
+ { Year: '2021', Place: 'Long', Value: 90 }
110
+ ]
111
+ const { container } = renderRace(rows, { displayNumbersOnBar: true })
112
+
113
+ expect(container.querySelector('[data-category="Long"] .bar-chart-race__value')).toHaveClass(
114
+ 'bar-chart-race__value--inside'
115
+ )
116
+ expect(container.querySelector('[data-category="Short"] .bar-chart-race__value')).toHaveClass(
117
+ 'bar-chart-race__value--after'
118
+ )
119
+ })
120
+
121
+ it('starts paused, advances, pauses, and replays from the first frame', () => {
122
+ const { container } = renderRace()
123
+
124
+ const frame = container.querySelector('.bar-chart-race__frame')
125
+ const frameAxis = screen.getByRole('group', { name: 'Year axis' })
126
+ expect(frame).toHaveTextContent('2020')
127
+ expect(frameAxis).toHaveTextContent('2020')
128
+ expect(frameAxis).toHaveTextContent('2021')
129
+ expect(frameAxis.querySelector('[aria-current="step"]')).toHaveTextContent('2020')
130
+ const playButton = screen.getByRole('button', { name: 'Play' })
131
+ expect(container.querySelector('.bar-chart-race__header')?.firstElementChild).toBe(playButton)
132
+ expect(playButton.nextElementSibling).toBe(frame)
133
+ expect(playButton.querySelector('[data-icon="play"]')).toBeInTheDocument()
134
+ fireEvent.click(playButton)
135
+ expect(screen.getByRole('button', { name: 'Pause' }).querySelector('[data-icon="pause"]')).toBeInTheDocument()
136
+ act(() => vi.advanceTimersByTime(500))
137
+ expect(frame).toHaveTextContent('2021')
138
+ expect(frameAxis.querySelector('[aria-current="step"]')).toHaveTextContent('2021')
139
+ expect(screen.getByRole('button', { name: 'Replay' }).querySelector('[data-icon="replay"]')).toBeInTheDocument()
140
+
141
+ fireEvent.click(screen.getByRole('button', { name: 'Replay' }))
142
+ expect(frame).toHaveTextContent('2020')
143
+ expect(screen.getByRole('button', { name: 'Pause' })).toBeInTheDocument()
144
+ fireEvent.click(screen.getByRole('button', { name: 'Pause' }))
145
+ act(() => vi.advanceTimersByTime(500))
146
+ expect(frame).toHaveTextContent('2020')
147
+ })
148
+
149
+ it('uses stable category colors, column formatting, and the standard chart tooltip markup', () => {
150
+ const { container } = renderRace(data, { displayNumbersOnBar: true })
151
+ const alphaRow = container.querySelector('[data-category="Alpha"]') as HTMLElement
152
+
153
+ expect(alphaRow.querySelector('.bar-chart-race__bar')).toHaveStyle({ backgroundColor: '#005ea8' })
154
+ expect(alphaRow).toHaveTextContent('$10')
155
+ expect(alphaRow.dataset.tooltipHtml).toContain('class="tooltip-heading">2020')
156
+ expect(alphaRow.dataset.tooltipHtml).toContain('Alpha: $10')
157
+ expect(alphaRow.dataset.tooltipId).toContain('cdc-open-viz-tooltip-')
158
+ expect(container.querySelector('.bar-chart-race__tooltip')).not.toBeInTheDocument()
159
+ })
160
+
161
+ it('normalizes authored series axis names before applying value formatting', () => {
162
+ const formatNumber = vi.fn((value, _axis, _abbreviated, prefix = '', suffix = '') => `${prefix}${value}${suffix}`)
163
+ const { container } = renderRace(data, { formatNumber })
164
+
165
+ expect(container.querySelector('[data-category="Alpha"] .bar-chart-race__value')).toHaveTextContent('$10')
166
+ expect(formatNumber).toHaveBeenCalledWith(10, 'left', false, '$', undefined, 0)
167
+ })
168
+
169
+ it('clears playback timers when unmounted', () => {
170
+ const clearIntervalSpy = vi.spyOn(window, 'clearInterval')
171
+ const view = renderRace()
172
+ fireEvent.click(screen.getByRole('button', { name: 'Play' }))
173
+ view.unmount()
174
+ expect(clearIntervalSpy).toHaveBeenCalled()
175
+ })
176
+
177
+ it('resets to the first paused frame when visible data changes', () => {
178
+ const context = getRaceContext()
179
+ const race = getBarRaceEligibility(context.config, data)
180
+ const view = render(
181
+ <ConfigContext.Provider value={context}>
182
+ <BarChartRace parentWidth={700} race={race} />
183
+ </ConfigContext.Provider>
184
+ )
185
+ fireEvent.click(screen.getByRole('button', { name: 'Play' }))
186
+ act(() => vi.advanceTimersByTime(500))
187
+ expect(view.container.querySelector('.bar-chart-race__frame')).toHaveTextContent('2021')
188
+
189
+ const nextRows = [...data, { Year: '2022', Place: 'Alpha', Value: 50 }, { Year: '2022', Place: 'Beta', Value: 45 }]
190
+ view.rerender(
191
+ <ConfigContext.Provider value={{ ...context, transformedData: nextRows }}>
192
+ <BarChartRace parentWidth={700} race={getBarRaceEligibility(context.config, nextRows)} />
193
+ </ConfigContext.Provider>
194
+ )
195
+
196
+ expect(view.container.querySelector('.bar-chart-race__frame')).toHaveTextContent('2020')
197
+ expect(screen.getByRole('button', { name: 'Play' })).toBeInTheDocument()
198
+ })
199
+ })
@@ -0,0 +1,230 @@
1
+ import { useContext, useEffect, useState } from 'react'
2
+ import { animated, useTransition } from '@react-spring/web'
3
+ import { Tooltip as ReactTooltip } from 'react-tooltip'
4
+ import { getContrastColor } from '@cdc/core/helpers/cove/accessibility'
5
+ import { APP_FONT_COLOR } from '@cdc/core/helpers/constants'
6
+ import { getTextWidth } from '@cdc/core/helpers/getTextWidth'
7
+ import PlaybackButton from '@cdc/core/components/PlaybackButton'
8
+ import ConfigContext from '../../ConfigContext'
9
+ import { findColumnConfigByName, getSeriesColumnFormattingParams } from '../../helpers/seriesColumnSettings'
10
+ import { buildSeriesTooltipListHtml } from '../../helpers/tooltipHelpers'
11
+ import { clampRaceSecondsPerFrame } from '../raceTiming'
12
+ import usePrefersReducedMotion from '../../hooks/usePrefersReducedMotion'
13
+ import { type BarRaceEligibility } from './helpers'
14
+ import './bar-chart-race.css'
15
+
16
+ const AXIS_LABEL_ROW_HEIGHT = 48
17
+ const BELOW_BAR_LABEL_ROW_HEIGHT = 64
18
+
19
+ type Props = {
20
+ parentWidth: number
21
+ race: BarRaceEligibility
22
+ }
23
+
24
+ const BarChartRace = ({ parentWidth, race }: Props) => {
25
+ const { colorScale, config, formatNumber, setRaceTiming, transformedData = [] } = useContext(ConfigContext)
26
+ const [frameIndex, setFrameIndex] = useState(0)
27
+ const [isPlaying, setIsPlaying] = useState(false)
28
+ const [hasStarted, setHasStarted] = useState(false)
29
+ const prefersReducedMotion = usePrefersReducedMotion()
30
+ const secondsPerFrame = clampRaceSecondsPerFrame(config.barRace?.secondsPerFrame)
31
+ const totalSeconds = (race.frames.length - 1) * secondsPerFrame
32
+ const series = config.series[0]
33
+ const labelPlacement = config.yAxis?.labelPlacement || 'On Date/Category Axis'
34
+ const labelsBelowBar = labelPlacement === 'Below Bar'
35
+ const rowHeight = labelsBelowBar ? BELOW_BAR_LABEL_ROW_HEIGHT : AXIS_LABEL_ROW_HEIGHT
36
+ const tooltipId = `cdc-open-viz-tooltip-${config.runtime?.uniqueId || 'bar-race'}-race`
37
+ const frameSignature = JSON.stringify({
38
+ frameKey: config.xAxis?.dataKey,
39
+ series: config.series.map(item => [item.dataKey, item.dynamicCategory]),
40
+ rows: transformedData.map(row => [
41
+ row?.[config.xAxis?.dataKey],
42
+ ...config.series.flatMap(item => [row?.[item.dynamicCategory], row?.[item.dataKey]])
43
+ ])
44
+ })
45
+
46
+ useEffect(() => {
47
+ setFrameIndex(0)
48
+ setIsPlaying(false)
49
+ setHasStarted(false)
50
+ setRaceTiming?.(null)
51
+ }, [frameSignature])
52
+
53
+ useEffect(() => {
54
+ if (!isPlaying) return
55
+ if (secondsPerFrame === 0) {
56
+ setFrameIndex(Math.max(0, race.frames.length - 1))
57
+ setIsPlaying(false)
58
+ return
59
+ }
60
+ const timer = window.setInterval(() => {
61
+ setFrameIndex(currentFrame => {
62
+ if (currentFrame >= race.frames.length - 1) {
63
+ setIsPlaying(false)
64
+ return currentFrame
65
+ }
66
+ const nextFrame = currentFrame + 1
67
+ if (nextFrame >= race.frames.length - 1) setIsPlaying(false)
68
+ return nextFrame
69
+ })
70
+ }, secondsPerFrame * 1000)
71
+ return () => window.clearInterval(timer)
72
+ }, [isPlaying, race.frames.length, secondsPerFrame])
73
+
74
+ const frame = race.frames[Math.min(frameIndex, Math.max(0, race.frames.length - 1))]
75
+ const getCategoryColor = (seriesKey: string) => {
76
+ const runtimeCategory = config.runtime?.seriesKeys?.find(value => String(value).trim() === seriesKey) ?? seriesKey
77
+ return colorScale?.(runtimeCategory) || '#005ea8'
78
+ }
79
+ const formatValue = (item: (typeof frame.items)[number]) => {
80
+ const itemSeries = config.series.find(candidate => candidate.dataKey === item.dataKey) ?? series
81
+ const columnConfig = findColumnConfigByName(config.columns, item.dataKey)?.columnConfig
82
+ const columnFormatting = getSeriesColumnFormattingParams(columnConfig)
83
+ return (
84
+ formatNumber?.(
85
+ item.value,
86
+ String(itemSeries.axis || 'left').toLowerCase(),
87
+ false,
88
+ columnFormatting?.addColPrefix,
89
+ columnFormatting?.addColSuffix,
90
+ columnFormatting?.addColRoundTo
91
+ ) ?? String(item.value)
92
+ )
93
+ }
94
+ const getTooltipHtml = (item: (typeof frame.items)[number]) =>
95
+ buildSeriesTooltipListHtml({
96
+ config,
97
+ colorScale,
98
+ heading: frame.key,
99
+ seriesKey: item.seriesKey,
100
+ seriesText: `${item.category}: ${formatValue(item)}`
101
+ })
102
+ const barAreaWidth = Math.max(0, (labelsBelowBar ? parentWidth : parentWidth * 0.72) - 120)
103
+ const displayNumbersOnBar = Boolean(config.yAxis?.displayNumbersOnBar)
104
+ const isAtEnd = frameIndex === race.frames.length - 1
105
+ const frameAxisLabel = config.xAxis?.label || config.xAxis?.dataKey || 'Date/Category'
106
+
107
+ useEffect(() => {
108
+ if (!hasStarted || !frame?.key) return
109
+ setRaceTiming?.({
110
+ elapsedSeconds: frameIndex * secondsPerFrame,
111
+ frameKey: frame.key,
112
+ isPlaying,
113
+ totalSeconds
114
+ })
115
+ }, [frame?.key, frameIndex, hasStarted, isPlaying, secondsPerFrame, totalSeconds])
116
+
117
+ const transitions = useTransition(frame?.items ?? [], {
118
+ keys: item => item.category,
119
+ from: { opacity: 0, top: (frame?.items.length ?? 0) * rowHeight, width: 0 },
120
+ enter: item => ({
121
+ opacity: 1,
122
+ top: item.rank * rowHeight,
123
+ width: race.globalMax > 0 ? (item.value / race.globalMax) * barAreaWidth : 0
124
+ }),
125
+ update: item => ({
126
+ opacity: 1,
127
+ top: item.rank * rowHeight,
128
+ width: race.globalMax > 0 ? (item.value / race.globalMax) * barAreaWidth : 0
129
+ }),
130
+ leave: { opacity: 0, width: 0 },
131
+ immediate: prefersReducedMotion,
132
+ config: { tension: 170, friction: 26 }
133
+ })
134
+
135
+ if (!race.eligible || !frame) return null
136
+
137
+ const handlePlayback = () => {
138
+ setHasStarted(true)
139
+ if (isAtEnd) {
140
+ setFrameIndex(0)
141
+ setIsPlaying(true)
142
+ return
143
+ }
144
+ setIsPlaying(current => !current)
145
+ }
146
+
147
+ return (
148
+ <section
149
+ className={`bar-chart-race bar-chart-race--labels-${labelsBelowBar ? 'below-bar' : 'on-axis'}`}
150
+ aria-label={`Bar chart race for ${frame.key}`}
151
+ >
152
+ <div className='bar-chart-race__header'>
153
+ <PlaybackButton
154
+ isAtEnd={isAtEnd}
155
+ isPlaying={isPlaying}
156
+ className='bar-chart-race__playback'
157
+ onClick={handlePlayback}
158
+ />
159
+ <strong className='bar-chart-race__frame' aria-live='polite'>
160
+ {frame.key}
161
+ </strong>
162
+ </div>
163
+ <div className='bar-chart-race__plot' style={{ height: `${frame.items.length * rowHeight}px` }}>
164
+ {transitions((style, item) => {
165
+ const valueLabel = formatValue(item)
166
+ const barWidth = race.globalMax > 0 ? (item.value / race.globalMax) * barAreaWidth : 0
167
+ const measuredLabelWidth =
168
+ typeof CanvasRenderingContext2D === 'undefined'
169
+ ? undefined
170
+ : getTextWidth(valueLabel, 'normal 16px sans-serif')
171
+ const labelWidth = measuredLabelWidth || valueLabel.length * 8
172
+ const valueFitsInside = displayNumbersOnBar && labelWidth < barWidth - 5
173
+ const barColor = getCategoryColor(item.seriesKey)
174
+ const baseLabelColor = APP_FONT_COLOR || '#1c1d1f'
175
+ const insideLabelColor = getContrastColor(baseLabelColor, barColor) || baseLabelColor
176
+
177
+ return (
178
+ <animated.div
179
+ className='bar-chart-race__row'
180
+ data-category={item.category}
181
+ data-tooltip-id={tooltipId}
182
+ data-tooltip-html={getTooltipHtml(item)}
183
+ tabIndex={0}
184
+ style={{ opacity: style.opacity, top: style.top }}
185
+ >
186
+ <span className='bar-chart-race__category'>{item.category}</span>
187
+ <div className='bar-chart-race__bar-area'>
188
+ <animated.div
189
+ className={`bar-chart-race__bar${valueFitsInside ? ' bar-chart-race__bar--value-inside' : ''}`}
190
+ style={{ width: style.width, backgroundColor: barColor }}
191
+ >
192
+ <span
193
+ className={`bar-chart-race__value bar-chart-race__value--${valueFitsInside ? 'inside' : 'after'}`}
194
+ style={valueFitsInside ? { color: insideLabelColor } : undefined}
195
+ >
196
+ {valueLabel}
197
+ </span>
198
+ </animated.div>
199
+ </div>
200
+ </animated.div>
201
+ )
202
+ })}
203
+ </div>
204
+ <ReactTooltip
205
+ id={tooltipId}
206
+ variant='light'
207
+ arrowColor='rgba(0,0,0,0)'
208
+ className='tooltip'
209
+ style={{ background: `rgba(255,255,255, ${(config.tooltips?.opacity ?? 90) / 100})`, color: 'black' }}
210
+ />
211
+ <div className='bar-chart-race__frame-axis' role='group' aria-label={`${frameAxisLabel} axis`}>
212
+ <div className='bar-chart-race__frame-axis-ticks'>
213
+ {race.frames.map((raceFrame, index) => (
214
+ <span
215
+ className={`bar-chart-race__frame-axis-tick${index === frameIndex ? ' is-active' : ''}`}
216
+ aria-current={index === frameIndex ? 'step' : undefined}
217
+ key={raceFrame.key}
218
+ >
219
+ <span className='bar-chart-race__frame-axis-mark' aria-hidden='true' />
220
+ <span className='bar-chart-race__frame-axis-value'>{raceFrame.key}</span>
221
+ </span>
222
+ ))}
223
+ </div>
224
+ <span className='bar-chart-race__frame-axis-label'>{frameAxisLabel}</span>
225
+ </div>
226
+ </section>
227
+ )
228
+ }
229
+
230
+ export default BarChartRace
@@ -0,0 +1,61 @@
1
+ import React, { forwardRef, useContext, useEffect } from 'react'
2
+ import { render, screen } from '@testing-library/react'
3
+ import { describe, expect, it, vi } from 'vitest'
4
+ import ConfigContext from '../../ConfigContext'
5
+ import { createMockChartContext, createMockConfig } from '../LinearChart/tests/mockConfigContext'
6
+ import BarChartRaceFallback from './BarChartRaceFallback'
7
+
8
+ vi.mock('../LinearChart', () => ({
9
+ default: forwardRef<SVGAElement>((_props, ref) => {
10
+ const { config, updateConfig } = useContext(ConfigContext)
11
+
12
+ useEffect(() => {
13
+ updateConfig?.({ ...config, isLollipopChart: false })
14
+ }, []) // eslint-disable-line react-hooks/exhaustive-deps
15
+
16
+ return (
17
+ <svg
18
+ ref={ref}
19
+ data-testid='fallback-chart'
20
+ data-is-lollipop={String(config.isLollipopChart)}
21
+ data-orientation={config.orientation}
22
+ data-style={config.barStyle}
23
+ data-subtype={config.visualizationSubType}
24
+ />
25
+ )
26
+ })
27
+ }))
28
+
29
+ describe('BarChartRaceFallback', () => {
30
+ it('renders a regular horizontal projection without persisting its normalization', () => {
31
+ const baseConfig = createMockConfig()
32
+ const updateConfig = vi.fn()
33
+ const config = createMockConfig({
34
+ visualizationType: 'Bar',
35
+ visualizationSubType: 'racing',
36
+ orientation: 'vertical',
37
+ barStyle: 'rounded',
38
+ isLollipopChart: true,
39
+ xAxis: { ...baseConfig.xAxis, anchors: ['x-axis-anchor'] },
40
+ yAxis: { ...baseConfig.yAxis, anchors: ['y-axis-anchor'] }
41
+ })
42
+
43
+ render(
44
+ <ConfigContext.Provider value={createMockChartContext(config, { updateConfig })}>
45
+ <BarChartRaceFallback parentWidth={700} parentHeight={400} />
46
+ </ConfigContext.Provider>
47
+ )
48
+
49
+ expect(screen.getByTestId('fallback-chart')).toHaveAttribute('data-subtype', 'regular')
50
+ expect(screen.getByTestId('fallback-chart')).toHaveAttribute('data-orientation', 'horizontal')
51
+ expect(screen.getByTestId('fallback-chart')).toHaveAttribute('data-style', 'flat')
52
+ expect(screen.getByTestId('fallback-chart')).toHaveAttribute('data-is-lollipop', 'false')
53
+ expect(updateConfig).not.toHaveBeenCalled()
54
+ expect(config).toMatchObject({
55
+ barStyle: 'rounded',
56
+ isLollipopChart: true,
57
+ orientation: 'vertical',
58
+ visualizationSubType: 'racing'
59
+ })
60
+ })
61
+ })
@@ -0,0 +1,48 @@
1
+ import { forwardRef, useContext } from 'react'
2
+ import ConfigContext from '../../ConfigContext'
3
+ import LinearChart from '../LinearChart'
4
+
5
+ type Props = {
6
+ parentHeight: number
7
+ parentWidth: number
8
+ }
9
+
10
+ const BarChartRaceFallback = forwardRef<SVGAElement, Props>(({ parentHeight, parentWidth }, ref) => {
11
+ const context = useContext(ConfigContext)
12
+ const enteringFromVertical = context.config.orientation !== 'horizontal'
13
+ const fallbackConfig = {
14
+ ...context.config,
15
+ visualizationSubType: 'regular',
16
+ orientation: 'horizontal' as const,
17
+ isLollipopChart: false,
18
+ barStyle: 'flat' as const,
19
+ xAxis: enteringFromVertical
20
+ ? {
21
+ ...context.config.xAxis,
22
+ anchors: context.config.yAxis?.anchors ?? [],
23
+ hideAxis: true,
24
+ hideTicks: true
25
+ }
26
+ : context.config.xAxis,
27
+ yAxis: enteringFromVertical
28
+ ? {
29
+ ...context.config.yAxis,
30
+ anchors: context.config.xAxis?.anchors ?? [],
31
+ hideAxis: false,
32
+ hideTicks: false,
33
+ labelPlacement: context.config.yAxis?.labelPlacement || 'On Date/Category Axis'
34
+ }
35
+ : context.config.yAxis,
36
+ runtime: { ...context.config.runtime, horizontal: true }
37
+ }
38
+
39
+ return (
40
+ <ConfigContext.Provider value={{ ...context, config: fallbackConfig, updateConfig: () => {} }}>
41
+ <LinearChart ref={ref} parentWidth={parentWidth} parentHeight={parentHeight} />
42
+ </ConfigContext.Provider>
43
+ )
44
+ })
45
+
46
+ BarChartRaceFallback.displayName = 'BarChartRaceFallback'
47
+
48
+ export default BarChartRaceFallback