@carto/ps-react-ui 4.17.3 → 4.18.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.
- package/dist/category-Ct2BzADB.js +753 -0
- package/dist/category-Ct2BzADB.js.map +1 -0
- package/dist/change-column-Bhcxmp-r.js +1148 -0
- package/dist/change-column-Bhcxmp-r.js.map +1 -0
- package/dist/echart-B10dhEaM.js +262 -0
- package/dist/echart-B10dhEaM.js.map +1 -0
- package/dist/types/widgets-v2/actions/lock-selection/lock-selection.d.ts +15 -5
- package/dist/types/widgets-v2/category/components/category-legend.d.ts +18 -2
- package/dist/types/widgets-v2/category/components/category-row-stacked.d.ts +6 -1
- package/dist/types/widgets-v2/category/style.d.ts +8 -0
- package/dist/types/widgets-v2/echart/use-chart-selection.d.ts +10 -4
- package/dist/types/widgets-v2/histogram/index.d.ts +1 -1
- package/dist/types/widgets-v2/histogram/transforms.d.ts +11 -0
- package/dist/types/widgets-v2/histogram/types.d.ts +9 -0
- package/dist/types/widgets-v2/scatterplot/index.d.ts +1 -1
- package/dist/types/widgets-v2/scatterplot/transforms.d.ts +9 -0
- package/dist/types/widgets-v2/table/index.d.ts +1 -0
- package/dist/types/widgets-v2/table/transforms.d.ts +13 -0
- package/dist/types/widgets-v2/table/transforms.test.d.ts +1 -0
- package/dist/types/widgets-v2/timeseries/index.d.ts +1 -0
- package/dist/types/widgets-v2/timeseries/transforms.d.ts +10 -0
- package/dist/types/widgets-v2/timeseries/transforms.test.d.ts +1 -0
- package/dist/widgets-v2/actions.js +1 -1
- package/dist/widgets-v2/category.js +1 -1
- package/dist/widgets-v2/echart.js +1 -1
- package/dist/widgets-v2/echart.js.map +1 -1
- package/dist/widgets-v2/histogram.js +181 -158
- package/dist/widgets-v2/histogram.js.map +1 -1
- package/dist/widgets-v2/pie.js +155 -116
- package/dist/widgets-v2/pie.js.map +1 -1
- package/dist/widgets-v2/scatterplot.js +91 -85
- package/dist/widgets-v2/scatterplot.js.map +1 -1
- package/dist/widgets-v2/table.js +55 -45
- package/dist/widgets-v2/table.js.map +1 -1
- package/dist/widgets-v2/timeseries.js +96 -85
- package/dist/widgets-v2/timeseries.js.map +1 -1
- package/dist/widgets-v2.js +4 -4
- package/package.json +1 -1
- package/src/widgets-v2/actions/lock-selection/lock-selection.test.tsx +62 -0
- package/src/widgets-v2/actions/lock-selection/lock-selection.tsx +45 -13
- package/src/widgets-v2/category/category-ui.test.tsx +55 -0
- package/src/widgets-v2/category/category-ui.tsx +65 -6
- package/src/widgets-v2/category/components/category-legend.test.tsx +53 -2
- package/src/widgets-v2/category/components/category-legend.tsx +55 -12
- package/src/widgets-v2/category/components/category-row-stacked.test.tsx +7 -3
- package/src/widgets-v2/category/components/category-row-stacked.tsx +8 -3
- package/src/widgets-v2/category/style.ts +10 -2
- package/src/widgets-v2/echart/echart-ui.test.tsx +25 -0
- package/src/widgets-v2/echart/echart-ui.tsx +20 -0
- package/src/widgets-v2/echart/use-chart-selection.test.tsx +3 -1
- package/src/widgets-v2/echart/use-chart-selection.ts +10 -4
- package/src/widgets-v2/histogram/index.ts +4 -1
- package/src/widgets-v2/histogram/options.test.ts +86 -0
- package/src/widgets-v2/histogram/options.ts +50 -0
- package/src/widgets-v2/histogram/transforms.test.ts +36 -1
- package/src/widgets-v2/histogram/transforms.ts +23 -0
- package/src/widgets-v2/histogram/types.ts +9 -0
- package/src/widgets-v2/pie/options.test.ts +262 -0
- package/src/widgets-v2/pie/options.ts +80 -5
- package/src/widgets-v2/scatterplot/index.ts +4 -1
- package/src/widgets-v2/scatterplot/transforms.test.ts +38 -1
- package/src/widgets-v2/scatterplot/transforms.ts +23 -0
- package/src/widgets-v2/table/index.ts +1 -0
- package/src/widgets-v2/table/transforms.test.ts +40 -0
- package/src/widgets-v2/table/transforms.ts +26 -0
- package/src/widgets-v2/timeseries/index.ts +1 -0
- package/src/widgets-v2/timeseries/transforms.test.ts +49 -0
- package/src/widgets-v2/timeseries/transforms.ts +31 -0
- package/dist/category-CGS_eHr4.js +0 -719
- package/dist/category-CGS_eHr4.js.map +0 -1
- package/dist/change-column-CiVAjOUB.js +0 -1143
- package/dist/change-column-CiVAjOUB.js.map +0 -1
- package/dist/echart-Bdvbfx9s.js +0 -250
- package/dist/echart-Bdvbfx9s.js.map +0 -1
|
@@ -1,4 +1,10 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import {
|
|
2
|
+
useCallback,
|
|
3
|
+
useEffect,
|
|
4
|
+
useMemo,
|
|
5
|
+
useRef,
|
|
6
|
+
type ComponentType,
|
|
7
|
+
} from 'react'
|
|
2
8
|
import { IconButton, type SvgIconProps } from '@mui/material'
|
|
3
9
|
import { Lock as LockIcon } from '@mui/icons-material'
|
|
4
10
|
import { LockOpen as LockOpenIcon } from '@mui/icons-material'
|
|
@@ -20,28 +26,40 @@ const LOCK_SELECTION_DESCRIPTOR = {
|
|
|
20
26
|
|
|
21
27
|
export type LockSelectionKey = string | number
|
|
22
28
|
|
|
23
|
-
export interface LockSelectionProps
|
|
29
|
+
export interface LockSelectionProps<
|
|
30
|
+
K extends LockSelectionKey = LockSelectionKey,
|
|
31
|
+
> {
|
|
24
32
|
/**
|
|
25
33
|
* Currently-selected items (destination-owned). On lock, this set is
|
|
26
34
|
* snapshotted into `lockedItems` via `onLockChange`.
|
|
27
35
|
*/
|
|
28
|
-
selection: readonly
|
|
36
|
+
selection: readonly K[]
|
|
29
37
|
/**
|
|
30
38
|
* Currently-locked items (destination-owned). When non-empty, the widget's
|
|
31
39
|
* data is filtered to these items via the registered transform.
|
|
32
40
|
*/
|
|
33
|
-
lockedItems: readonly
|
|
41
|
+
lockedItems: readonly K[]
|
|
34
42
|
/**
|
|
35
43
|
* Fires when the user toggles the lock. The destination is responsible for
|
|
36
44
|
* persisting the new locked set (and re-feeding it via `lockedItems`).
|
|
37
45
|
*/
|
|
38
|
-
onLockChange: (next: readonly
|
|
46
|
+
onLockChange: (next: readonly K[]) => void
|
|
39
47
|
labels?: Partial<LockSelectionLabels>
|
|
40
48
|
/** Lock icon (default: `LockIcon`). */
|
|
41
49
|
lockIcon?: ComponentType<SvgIconProps>
|
|
42
50
|
/** Unlock icon (default: `LockOpenIcon`). */
|
|
43
51
|
unlockIcon?: ComponentType<SvgIconProps>
|
|
44
52
|
iconProps?: SvgIconProps
|
|
53
|
+
/**
|
|
54
|
+
* Data transform applied while locked. Defaults to {@link filterByLockedItems}
|
|
55
|
+
* (keeps only `{name, ...}` items whose `name` is in `lockedItems`, across a
|
|
56
|
+
* `X[][]` series shape — matches Bar/Pie/Category/Timeseries data). Widgets
|
|
57
|
+
* whose data shape or selection identity differs (bin index, composite
|
|
58
|
+
* point key, flat rows) pass their own — e.g. Histogram's
|
|
59
|
+
* `filterHistogramByLockedBins`, Scatterplot's
|
|
60
|
+
* `filterScatterplotByLockedPoints`, Table's `filterTableByLockedRows`.
|
|
61
|
+
*/
|
|
62
|
+
filterFn?: (data: unknown, lockedItems: readonly K[]) => unknown
|
|
45
63
|
}
|
|
46
64
|
|
|
47
65
|
/**
|
|
@@ -52,7 +70,7 @@ export interface LockSelectionProps {
|
|
|
52
70
|
*
|
|
53
71
|
* The trigger is disabled when there is nothing to lock and nothing locked.
|
|
54
72
|
*/
|
|
55
|
-
export function LockSelection({
|
|
73
|
+
export function LockSelection<K extends LockSelectionKey = LockSelectionKey>({
|
|
56
74
|
selection,
|
|
57
75
|
lockedItems,
|
|
58
76
|
onLockChange,
|
|
@@ -60,7 +78,8 @@ export function LockSelection({
|
|
|
60
78
|
lockIcon: LockSvg = LockIcon,
|
|
61
79
|
unlockIcon: UnlockSvg = LockOpenIcon,
|
|
62
80
|
iconProps,
|
|
63
|
-
|
|
81
|
+
filterFn = filterByLockedItems,
|
|
82
|
+
}: LockSelectionProps<K>) {
|
|
64
83
|
const id = useWidgetId()
|
|
65
84
|
const _labels = { ...DEFAULT_LOCK_SELECTION_LABELS, ...labels }
|
|
66
85
|
const isLocked = lockedItems.length > 0
|
|
@@ -69,7 +88,7 @@ export function LockSelection({
|
|
|
69
88
|
// Pair memoized on lockedItems identity — useTransform re-registers the fn
|
|
70
89
|
// (which closes over the current locked set) whenever the destination feeds
|
|
71
90
|
// a new array. setEnabled drives the middleware-level `enabled` flag.
|
|
72
|
-
const pairs = useMemoPair(lockedItems)
|
|
91
|
+
const pairs = useMemoPair(lockedItems, filterFn)
|
|
73
92
|
const { enabled, setEnabled } = useTransform(id, pairs, {
|
|
74
93
|
initialEnabled: isLocked,
|
|
75
94
|
})
|
|
@@ -116,14 +135,27 @@ export function LockSelection({
|
|
|
116
135
|
|
|
117
136
|
/**
|
|
118
137
|
* Builds a stable `[{ descriptor, fn }]` pair where `fn` closes over the
|
|
119
|
-
* latest `lockedItems
|
|
120
|
-
* `
|
|
138
|
+
* latest `lockedItems` and reads `filterFn` from a ref kept fresh via
|
|
139
|
+
* `useEffect` (never mutated during render — that would break the compiler's
|
|
140
|
+
* memoization guarantees). `filterFn` is deliberately NOT a `useCallback`
|
|
141
|
+
* dep — callers (see `filterTableByLockedRows`'s JSDoc) are expected to pass
|
|
142
|
+
* an inline closure like `(data, locked) => filterTableByLockedRows(data,
|
|
143
|
+
* locked, keyColumn)`, which has a new identity every render; depending on
|
|
144
|
+
* it directly would rebuild the transform pair (and everything downstream
|
|
145
|
+
* of it) every render instead of only when `lockedItems` actually changes.
|
|
146
|
+
* `fn` itself is invoked later by the data pipeline, not during this
|
|
147
|
+
* component's render, so reading a ref there is safe.
|
|
121
148
|
*/
|
|
122
|
-
function useMemoPair(
|
|
123
|
-
lockedItems: readonly
|
|
149
|
+
function useMemoPair<K extends LockSelectionKey>(
|
|
150
|
+
lockedItems: readonly K[],
|
|
151
|
+
filterFn: (data: unknown, lockedItems: readonly K[]) => unknown,
|
|
124
152
|
): readonly TransformPair[] {
|
|
153
|
+
const filterFnRef = useRef(filterFn)
|
|
154
|
+
useEffect(() => {
|
|
155
|
+
filterFnRef.current = filterFn
|
|
156
|
+
})
|
|
125
157
|
const fn = useCallback(
|
|
126
|
-
(data: unknown) =>
|
|
158
|
+
(data: unknown) => filterFnRef.current(data, lockedItems),
|
|
127
159
|
[lockedItems],
|
|
128
160
|
)
|
|
129
161
|
return useMemo(() => [{ descriptor: LOCK_SELECTION_DESCRIPTOR, fn }], [fn])
|
|
@@ -338,6 +338,35 @@ describe('<CategoryUI>', () => {
|
|
|
338
338
|
// The text "A" is still present from the row label.
|
|
339
339
|
expect(screen.getAllByText('A')).toHaveLength(1)
|
|
340
340
|
})
|
|
341
|
+
|
|
342
|
+
it('clicking a legend item hides that series from the rows', () => {
|
|
343
|
+
render(
|
|
344
|
+
<CategoryUI
|
|
345
|
+
data={[[{ name: 'A', value: 10 }], [{ name: 'A', value: 5 }]]}
|
|
346
|
+
series={[{ name: '2024' }, { name: '2025' }]}
|
|
347
|
+
/>,
|
|
348
|
+
)
|
|
349
|
+
expect(screen.getByText('10')).toBeTruthy()
|
|
350
|
+
expect(screen.getByText('5')).toBeTruthy()
|
|
351
|
+
fireEvent.click(screen.getByText('2025'))
|
|
352
|
+
expect(screen.queryByText('5')).toBeNull()
|
|
353
|
+
expect(screen.getByText('10')).toBeTruthy()
|
|
354
|
+
})
|
|
355
|
+
|
|
356
|
+
it('hiding the last visible series reverts to showing all (never leaves it blank)', () => {
|
|
357
|
+
render(
|
|
358
|
+
<CategoryUI
|
|
359
|
+
data={[[{ name: 'A', value: 10 }], [{ name: 'A', value: 5 }]]}
|
|
360
|
+
series={[{ name: '2024' }, { name: '2025' }]}
|
|
361
|
+
/>,
|
|
362
|
+
)
|
|
363
|
+
fireEvent.click(screen.getByText('2025'))
|
|
364
|
+
expect(screen.queryByText('5')).toBeNull()
|
|
365
|
+
fireEvent.click(screen.getByText('2024'))
|
|
366
|
+
// Both would be hidden — guard reverts to showing every series instead.
|
|
367
|
+
expect(screen.getByText('10')).toBeTruthy()
|
|
368
|
+
expect(screen.getByText('5')).toBeTruthy()
|
|
369
|
+
})
|
|
341
370
|
})
|
|
342
371
|
|
|
343
372
|
// ── Selection visual ───────────────────────────────────────────────
|
|
@@ -716,6 +745,32 @@ describe('<CategoryUI>', () => {
|
|
|
716
745
|
expect(screen.getByText('Series 2: 32')).toBeTruthy()
|
|
717
746
|
})
|
|
718
747
|
|
|
748
|
+
it('numbers the "Series N" fallback by ORIGINAL series index, not by visible position, after hiding an earlier series via the legend', () => {
|
|
749
|
+
// 3 data series; series[2] is unnamed (metadata array shorter than
|
|
750
|
+
// data — a supported "gap" per this prop's own doc). Hiding series 0
|
|
751
|
+
// ("Women") via the legend leaves series 1 ("Men") and 2 (unnamed)
|
|
752
|
+
// visible — series 2's fallback must still read "Series 3" (its
|
|
753
|
+
// ORIGINAL index), not "Series 2" (its now-first visible position).
|
|
754
|
+
const THREE_SERIES = [
|
|
755
|
+
[{ name: 'A', value: 45 }],
|
|
756
|
+
[{ name: 'A', value: 32 }],
|
|
757
|
+
[{ name: 'A', value: 12 }],
|
|
758
|
+
]
|
|
759
|
+
render(
|
|
760
|
+
<CategoryUI
|
|
761
|
+
data={THREE_SERIES}
|
|
762
|
+
series={[{ name: 'Women' }, { name: 'Men' }]}
|
|
763
|
+
stacked
|
|
764
|
+
formatter={(n) => `${n}`}
|
|
765
|
+
/>,
|
|
766
|
+
)
|
|
767
|
+
const checkbox = screen.getByRole('checkbox', { name: 'Women' })
|
|
768
|
+
fireEvent.click(checkbox)
|
|
769
|
+
expect(screen.queryByText(/Women:/)).toBeNull()
|
|
770
|
+
expect(screen.getByText('Men: 32')).toBeTruthy()
|
|
771
|
+
expect(screen.getByText('Series 3: 12')).toBeTruthy()
|
|
772
|
+
})
|
|
773
|
+
|
|
719
774
|
it('stacked is a no-op for single-series data (still renders CategoryRowSingle)', () => {
|
|
720
775
|
const { container } = render(
|
|
721
776
|
<CategoryUI data={[[{ name: 'A', value: 10 }]]} stacked />,
|
|
@@ -281,6 +281,48 @@ export function CategoryUI({
|
|
|
281
281
|
[scrollMode],
|
|
282
282
|
)
|
|
283
283
|
|
|
284
|
+
// Which series are hidden via a legend click. Local UI-only state — not
|
|
285
|
+
// synced to `selection`/`onSelectionChange` (that's row-level filter
|
|
286
|
+
// selection, unrelated). Never allowed to reach "every series hidden":
|
|
287
|
+
// toggling the last visible one instead resets to "all visible" rather
|
|
288
|
+
// than leaving the widget blank.
|
|
289
|
+
const [hiddenSeries, setHiddenSeries] = useState<ReadonlySet<number>>(
|
|
290
|
+
() => new Set(),
|
|
291
|
+
)
|
|
292
|
+
// A reload with a different series breakdown invalidates hidden indices —
|
|
293
|
+
// index 2 may now point at an entirely different series. Reset rather
|
|
294
|
+
// than keep hiding whatever now occupies a stale index. Adjusted directly
|
|
295
|
+
// during render (React's documented "adjusting state when a prop changes"
|
|
296
|
+
// pattern) instead of in a `useEffect`, which would commit the stale
|
|
297
|
+
// hidden-set for one extra frame before the effect fires. Compared by a
|
|
298
|
+
// content-derived key, not the raw `series` reference — an inline
|
|
299
|
+
// `series={[...]}` literal (no useMemo) gets a new reference on every
|
|
300
|
+
// unrelated parent re-render, which would otherwise reset hiddenSeries
|
|
301
|
+
// right after the user hides one.
|
|
302
|
+
const seriesKey = JSON.stringify(series?.map((s) => s.name) ?? [])
|
|
303
|
+
const [prevSeriesKey, setPrevSeriesKey] = useState(seriesKey)
|
|
304
|
+
if (seriesKey !== prevSeriesKey) {
|
|
305
|
+
setPrevSeriesKey(seriesKey)
|
|
306
|
+
setHiddenSeries(new Set())
|
|
307
|
+
}
|
|
308
|
+
// Real number of data series — NOT `series?.length`, which is legend
|
|
309
|
+
// metadata and may legitimately be shorter than the actual series count
|
|
310
|
+
// (unnamed trailing series fall back to `Series N`). Using the metadata
|
|
311
|
+
// length here would trip the "never fully hidden" guard early whenever
|
|
312
|
+
// `series` is shorter than `data`.
|
|
313
|
+
const seriesCount = Math.max(data.length, 1)
|
|
314
|
+
const toggleSeries = useCallback(
|
|
315
|
+
(index: number) => {
|
|
316
|
+
setHiddenSeries((prev) => {
|
|
317
|
+
const next = new Set(prev)
|
|
318
|
+
if (next.has(index)) next.delete(index)
|
|
319
|
+
else next.add(index)
|
|
320
|
+
return next.size >= seriesCount ? new Set() : next
|
|
321
|
+
})
|
|
322
|
+
},
|
|
323
|
+
[seriesCount],
|
|
324
|
+
)
|
|
325
|
+
|
|
284
326
|
if (grouped.length === 0) return null
|
|
285
327
|
|
|
286
328
|
const hasCap =
|
|
@@ -290,6 +332,12 @@ export function CategoryUI({
|
|
|
290
332
|
|
|
291
333
|
const isMulti = data.length > 1
|
|
292
334
|
const hasLegend = isMulti && !!series && series.length > 0
|
|
335
|
+
// Invariant across every row in this render — only depends on
|
|
336
|
+
// `hiddenSeries`/`seriesCount`, not on any particular row's data — so
|
|
337
|
+
// it's computed once here instead of per row inside the render loop.
|
|
338
|
+
const visibleIdx = Array.from({ length: seriesCount }, (_, i) => i).filter(
|
|
339
|
+
(i) => !hiddenSeries.has(i),
|
|
340
|
+
)
|
|
293
341
|
|
|
294
342
|
// Fallback viewport height matches the documented "8 × ROW_HEIGHT_PX"
|
|
295
343
|
// (see the constants at the top of the file). Earlier code multiplied
|
|
@@ -323,6 +371,10 @@ export function CategoryUI({
|
|
|
323
371
|
// rows — no row-level opacity, no `rowSelected` bg tint.
|
|
324
372
|
const fill = (i: number): string =>
|
|
325
373
|
dimmed ? dimColor : colorAt(i, row.rowColors[i])
|
|
374
|
+
// Series hidden via the legend are dropped before reaching the
|
|
375
|
+
// row components — they render whatever arrays they're given
|
|
376
|
+
// with no notion of "hidden" themselves. `visibleIdx` is hoisted
|
|
377
|
+
// above this loop (same for every row).
|
|
326
378
|
if (isMulti) {
|
|
327
379
|
if (stacked) {
|
|
328
380
|
// Stacked-mode branch: one segmented bar per row. Toggling
|
|
@@ -341,9 +393,11 @@ export function CategoryUI({
|
|
|
341
393
|
key={String(row.name)}
|
|
342
394
|
name={row.name}
|
|
343
395
|
displayName={displayName}
|
|
344
|
-
values={row.values}
|
|
345
|
-
colors={
|
|
346
|
-
seriesNames={
|
|
396
|
+
values={visibleIdx.map((i) => row.values[i]!)}
|
|
397
|
+
colors={visibleIdx.map((i) => fill(i))}
|
|
398
|
+
seriesNames={visibleIdx.map(
|
|
399
|
+
(i) => series?.[i]?.name ?? `Series ${i + 1}`,
|
|
400
|
+
)}
|
|
347
401
|
formatter={fmt}
|
|
348
402
|
selected={selected}
|
|
349
403
|
onToggle={toggle}
|
|
@@ -356,8 +410,8 @@ export function CategoryUI({
|
|
|
356
410
|
key={String(row.name)}
|
|
357
411
|
name={row.name}
|
|
358
412
|
displayName={displayName}
|
|
359
|
-
values={row.values}
|
|
360
|
-
colors={
|
|
413
|
+
values={visibleIdx.map((i) => row.values[i]!)}
|
|
414
|
+
colors={visibleIdx.map((i) => fill(i))}
|
|
361
415
|
maxValue={maxValue}
|
|
362
416
|
formatter={fmt}
|
|
363
417
|
selected={selected}
|
|
@@ -392,7 +446,12 @@ export function CategoryUI({
|
|
|
392
446
|
)}
|
|
393
447
|
</Box>
|
|
394
448
|
{hasLegend && series && (
|
|
395
|
-
<CategoryLegend
|
|
449
|
+
<CategoryLegend
|
|
450
|
+
series={series}
|
|
451
|
+
colorAt={(i) => colorAt(i)}
|
|
452
|
+
hiddenSeries={hiddenSeries}
|
|
453
|
+
onToggle={toggleSeries}
|
|
454
|
+
/>
|
|
396
455
|
)}
|
|
397
456
|
</Box>
|
|
398
457
|
)
|
|
@@ -1,13 +1,21 @@
|
|
|
1
|
-
import { describe, it, expect } from 'vitest'
|
|
1
|
+
import { describe, it, expect, vi } from 'vitest'
|
|
2
2
|
import { render, screen } from '@testing-library/react'
|
|
3
|
+
import userEvent from '@testing-library/user-event'
|
|
3
4
|
import { CategoryLegend } from './category-legend'
|
|
4
5
|
|
|
5
6
|
const noColors = () => undefined
|
|
7
|
+
const noHidden = new Set<number>()
|
|
8
|
+
const noop = vi.fn()
|
|
6
9
|
|
|
7
10
|
describe('<CategoryLegend>', () => {
|
|
8
11
|
it('renders nothing when series is empty', () => {
|
|
9
12
|
const { container } = render(
|
|
10
|
-
<CategoryLegend
|
|
13
|
+
<CategoryLegend
|
|
14
|
+
series={[]}
|
|
15
|
+
colorAt={noColors}
|
|
16
|
+
hiddenSeries={noHidden}
|
|
17
|
+
onToggle={noop}
|
|
18
|
+
/>,
|
|
11
19
|
)
|
|
12
20
|
expect(container.firstChild).toBeNull()
|
|
13
21
|
})
|
|
@@ -17,6 +25,8 @@ describe('<CategoryLegend>', () => {
|
|
|
17
25
|
<CategoryLegend
|
|
18
26
|
series={[{ name: '2024' }, { name: '2025' }]}
|
|
19
27
|
colorAt={(i) => (i === 0 ? 'rgb(1, 1, 1)' : 'rgb(2, 2, 2)')}
|
|
28
|
+
hiddenSeries={noHidden}
|
|
29
|
+
onToggle={noop}
|
|
20
30
|
/>,
|
|
21
31
|
)
|
|
22
32
|
expect(screen.getByText('2024')).toBeTruthy()
|
|
@@ -28,6 +38,8 @@ describe('<CategoryLegend>', () => {
|
|
|
28
38
|
<CategoryLegend
|
|
29
39
|
series={[{ name: 'S1', color: 'rgb(99, 0, 0)' }]}
|
|
30
40
|
colorAt={() => 'rgb(0, 0, 0)'}
|
|
41
|
+
hiddenSeries={noHidden}
|
|
42
|
+
onToggle={noop}
|
|
31
43
|
/>,
|
|
32
44
|
)
|
|
33
45
|
const dot = Array.from(container.querySelectorAll('div')).find(
|
|
@@ -41,6 +53,8 @@ describe('<CategoryLegend>', () => {
|
|
|
41
53
|
<CategoryLegend
|
|
42
54
|
series={[{ name: 'S1' }]}
|
|
43
55
|
colorAt={() => 'rgb(7, 7, 7)'}
|
|
56
|
+
hiddenSeries={noHidden}
|
|
57
|
+
onToggle={noop}
|
|
44
58
|
/>,
|
|
45
59
|
)
|
|
46
60
|
const dot = Array.from(container.querySelectorAll('div')).find(
|
|
@@ -48,4 +62,41 @@ describe('<CategoryLegend>', () => {
|
|
|
48
62
|
)
|
|
49
63
|
expect(dot).toBeTruthy()
|
|
50
64
|
})
|
|
65
|
+
|
|
66
|
+
it('clicking a legend item calls onToggle with its series index', async () => {
|
|
67
|
+
const onToggle = vi.fn()
|
|
68
|
+
render(
|
|
69
|
+
<CategoryLegend
|
|
70
|
+
series={[{ name: '2024' }, { name: '2025' }]}
|
|
71
|
+
colorAt={noColors}
|
|
72
|
+
hiddenSeries={noHidden}
|
|
73
|
+
onToggle={onToggle}
|
|
74
|
+
/>,
|
|
75
|
+
)
|
|
76
|
+
await userEvent.click(screen.getByText('2025'))
|
|
77
|
+
expect(onToggle).toHaveBeenCalledWith(1)
|
|
78
|
+
})
|
|
79
|
+
|
|
80
|
+
it('marks a hidden series as aria-checked=false (dimmed)', () => {
|
|
81
|
+
render(
|
|
82
|
+
<CategoryLegend
|
|
83
|
+
series={[{ name: '2024' }, { name: '2025' }]}
|
|
84
|
+
colorAt={noColors}
|
|
85
|
+
hiddenSeries={new Set([1])}
|
|
86
|
+
onToggle={noop}
|
|
87
|
+
/>,
|
|
88
|
+
)
|
|
89
|
+
expect(
|
|
90
|
+
screen
|
|
91
|
+
.getByText('2024')
|
|
92
|
+
.closest('[role="checkbox"]')
|
|
93
|
+
?.getAttribute('aria-checked'),
|
|
94
|
+
).toBe('true')
|
|
95
|
+
expect(
|
|
96
|
+
screen
|
|
97
|
+
.getByText('2025')
|
|
98
|
+
.closest('[role="checkbox"]')
|
|
99
|
+
?.getAttribute('aria-checked'),
|
|
100
|
+
).toBe('false')
|
|
101
|
+
})
|
|
51
102
|
})
|
|
@@ -13,27 +13,70 @@ export interface CategoryLegendProps {
|
|
|
13
13
|
* same source).
|
|
14
14
|
*/
|
|
15
15
|
colorAt: (index: number) => string | undefined
|
|
16
|
+
/**
|
|
17
|
+
* Series indices currently hidden from the chart. Renders dimmed.
|
|
18
|
+
* Optional — defaults to none hidden. Added after this component's first
|
|
19
|
+
* release; kept optional (not required) so it stays a non-breaking
|
|
20
|
+
* addition for any direct consumer of `CategoryLegend` (a public
|
|
21
|
+
* subpath export) that predates the hide feature.
|
|
22
|
+
*/
|
|
23
|
+
hiddenSeries?: ReadonlySet<number>
|
|
24
|
+
/**
|
|
25
|
+
* Fires with the series index when its legend item is clicked. Optional
|
|
26
|
+
* — omitting it renders a legend with no hide affordance (same
|
|
27
|
+
* reasoning as `hiddenSeries`).
|
|
28
|
+
*/
|
|
29
|
+
onToggle?: (index: number) => void
|
|
16
30
|
}
|
|
17
31
|
|
|
32
|
+
const NO_HIDDEN_SERIES: ReadonlySet<number> = new Set()
|
|
33
|
+
|
|
18
34
|
/**
|
|
19
35
|
* Sticky color legend rendered below a multi-series Category list.
|
|
20
|
-
* Per-series `color` overrides the matching `colorAt(i)` result.
|
|
36
|
+
* Per-series `color` overrides the matching `colorAt(i)` result. Clicking an
|
|
37
|
+
* item toggles that series' visibility in the rows above (mirrors ECharts'
|
|
38
|
+
* native legend click-to-hide).
|
|
21
39
|
*/
|
|
22
|
-
export function CategoryLegend({
|
|
40
|
+
export function CategoryLegend({
|
|
41
|
+
series,
|
|
42
|
+
colorAt,
|
|
43
|
+
hiddenSeries = NO_HIDDEN_SERIES,
|
|
44
|
+
onToggle,
|
|
45
|
+
}: CategoryLegendProps) {
|
|
23
46
|
if (series.length === 0) return null
|
|
24
47
|
return (
|
|
25
48
|
<Box sx={styles.legend}>
|
|
26
|
-
{series.map((s, i) =>
|
|
27
|
-
|
|
49
|
+
{series.map((s, i) => {
|
|
50
|
+
const hidden = hiddenSeries.has(i)
|
|
51
|
+
return (
|
|
28
52
|
<Box
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
53
|
+
key={s.name}
|
|
54
|
+
// `checkbox`/`aria-checked`, not `button`/`aria-pressed` — this
|
|
55
|
+
// toggles a persistent visibility state (closer to a checkbox)
|
|
56
|
+
// AND keeps it out of `getByRole('button')` queries that count
|
|
57
|
+
// category ROWS throughout this widget's test suite.
|
|
58
|
+
role='checkbox'
|
|
59
|
+
aria-checked={!hidden}
|
|
60
|
+
tabIndex={0}
|
|
61
|
+
onClick={() => onToggle?.(i)}
|
|
62
|
+
onKeyDown={(e) => {
|
|
63
|
+
if (e.key === 'Enter' || e.key === ' ') {
|
|
64
|
+
e.preventDefault()
|
|
65
|
+
onToggle?.(i)
|
|
66
|
+
}
|
|
67
|
+
}}
|
|
68
|
+
sx={hidden ? styles.legendItemHidden : styles.legendItem}
|
|
69
|
+
>
|
|
70
|
+
<Box
|
|
71
|
+
sx={styles.legendDot}
|
|
72
|
+
style={{ backgroundColor: s.color ?? colorAt(i) }}
|
|
73
|
+
/>
|
|
74
|
+
<Typography variant='caption' sx={styles.legendLabel}>
|
|
75
|
+
{s.name}
|
|
76
|
+
</Typography>
|
|
77
|
+
</Box>
|
|
78
|
+
)
|
|
79
|
+
})}
|
|
37
80
|
</Box>
|
|
38
81
|
)
|
|
39
82
|
}
|
|
@@ -69,20 +69,24 @@ describe('<CategoryRowStacked>', () => {
|
|
|
69
69
|
expect(screen.getByText('Men: 32')).toBeTruthy()
|
|
70
70
|
})
|
|
71
71
|
|
|
72
|
-
it(
|
|
72
|
+
it("renders whatever seriesNames it is given — fallback resolution is the caller's responsibility", () => {
|
|
73
|
+
// The component has no notion of which series were hidden upstream, so
|
|
74
|
+
// it must not recompute a positional "Series N" fallback itself — the
|
|
75
|
+
// caller (category-ui.tsx) resolves names, including fallbacks, using
|
|
76
|
+
// each series' ORIGINAL index before this component ever sees them.
|
|
73
77
|
render(
|
|
74
78
|
<CategoryRowStacked
|
|
75
79
|
name='Cat'
|
|
76
80
|
values={[45, 32]}
|
|
77
81
|
colors={COLORS}
|
|
78
|
-
seriesNames={[]}
|
|
82
|
+
seriesNames={['Series 1', 'Series 3']}
|
|
79
83
|
formatter={(n) => String(n)}
|
|
80
84
|
selected={false}
|
|
81
85
|
onToggle={vi.fn()}
|
|
82
86
|
/>,
|
|
83
87
|
)
|
|
84
88
|
expect(screen.getByText('Series 1: 45')).toBeTruthy()
|
|
85
|
-
expect(screen.getByText('Series
|
|
89
|
+
expect(screen.getByText('Series 3: 32')).toBeTruthy()
|
|
86
90
|
})
|
|
87
91
|
|
|
88
92
|
it('per-row normalization: bar fills 100% with segments proportional to the row sum', () => {
|
|
@@ -13,7 +13,12 @@ export interface CategoryRowStackedProps {
|
|
|
13
13
|
values: readonly number[]
|
|
14
14
|
/** One color per series (palette + per-series overrides resolved upstream). */
|
|
15
15
|
colors: readonly string[]
|
|
16
|
-
/**
|
|
16
|
+
/**
|
|
17
|
+
* Series names for the breakdown row, one per visible series, already
|
|
18
|
+
* resolved by the caller (unnamed series fall back to `Series N` using
|
|
19
|
+
* their ORIGINAL series index — this component has no notion of which
|
|
20
|
+
* series were hidden, so it must not recompute a positional fallback).
|
|
21
|
+
*/
|
|
17
22
|
seriesNames: readonly string[]
|
|
18
23
|
formatter: (n: number) => string
|
|
19
24
|
selected: boolean
|
|
@@ -86,11 +91,11 @@ export function CategoryRowStacked({
|
|
|
86
91
|
{values.map((v, i) => (
|
|
87
92
|
// Series name is the stable identity for the breakdown line.
|
|
88
93
|
<Typography
|
|
89
|
-
key={`breakdown-${seriesNames[i]
|
|
94
|
+
key={`breakdown-${seriesNames[i]}`}
|
|
90
95
|
variant='body2'
|
|
91
96
|
sx={styles.stackedBreakdownItem}
|
|
92
97
|
>
|
|
93
|
-
{`${seriesNames[i]
|
|
98
|
+
{`${seriesNames[i]}: ${formatter(v)}`}
|
|
94
99
|
</Typography>
|
|
95
100
|
))}
|
|
96
101
|
</Box>
|
|
@@ -260,10 +260,18 @@ export const styles = {
|
|
|
260
260
|
display: 'flex',
|
|
261
261
|
alignItems: 'center',
|
|
262
262
|
gap: 1,
|
|
263
|
+
cursor: 'pointer',
|
|
264
|
+
},
|
|
265
|
+
legendItemHidden: {
|
|
266
|
+
display: 'flex',
|
|
267
|
+
alignItems: 'center',
|
|
268
|
+
gap: 1,
|
|
269
|
+
cursor: 'pointer',
|
|
270
|
+
opacity: 0.5,
|
|
263
271
|
},
|
|
264
272
|
legendDot: {
|
|
265
|
-
width:
|
|
266
|
-
height:
|
|
273
|
+
width: 14,
|
|
274
|
+
height: 14,
|
|
267
275
|
borderRadius: '50%',
|
|
268
276
|
},
|
|
269
277
|
legendLabel: {
|
|
@@ -11,6 +11,7 @@ const mockChart = {
|
|
|
11
11
|
resize: vi.fn(),
|
|
12
12
|
on: vi.fn(),
|
|
13
13
|
off: vi.fn(),
|
|
14
|
+
dispatchAction: vi.fn(),
|
|
14
15
|
// Stubbed for the edge-label clamp; tests override per-case.
|
|
15
16
|
convertToPixel: vi.fn((_finder: unknown, index: number) =>
|
|
16
17
|
index === 0 ? 4 : 296,
|
|
@@ -39,6 +40,15 @@ function fireFinished(): void {
|
|
|
39
40
|
}
|
|
40
41
|
}
|
|
41
42
|
|
|
43
|
+
/** Invoke the `legendselectchanged` listener the bridge bound on the mock chart. */
|
|
44
|
+
function fireLegendSelectChanged(selected: Record<string, boolean>): void {
|
|
45
|
+
for (const [event, handler] of mockChart.on.mock.calls) {
|
|
46
|
+
if (event === 'legendselectchanged') {
|
|
47
|
+
;(handler as (params: unknown) => void)({ selected })
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
|
|
42
52
|
// Resize observer mock — capture the callback so tests can trigger it.
|
|
43
53
|
let resizeCb: (() => void) | null = null
|
|
44
54
|
const observeResizeSpy = vi.fn((_node: HTMLElement, cb: () => void) => {
|
|
@@ -60,6 +70,7 @@ beforeEach(() => {
|
|
|
60
70
|
mockChart.resize.mockReset()
|
|
61
71
|
mockChart.on.mockReset()
|
|
62
72
|
mockChart.off.mockReset()
|
|
73
|
+
mockChart.dispatchAction.mockReset()
|
|
63
74
|
mockChart.convertToPixel.mockClear()
|
|
64
75
|
mockChart.getWidth.mockClear()
|
|
65
76
|
initSpy.mockClear()
|
|
@@ -219,6 +230,20 @@ describe('<EchartUI>', () => {
|
|
|
219
230
|
expect(mockChart.dispose).toHaveBeenCalledTimes(1)
|
|
220
231
|
})
|
|
221
232
|
|
|
233
|
+
it('restores every legend item when a legend click hides the last one', () => {
|
|
234
|
+
render(<EchartUI option={{}} />)
|
|
235
|
+
fireLegendSelectChanged({ A: false, B: false, C: false })
|
|
236
|
+
expect(mockChart.dispatchAction).toHaveBeenCalledWith({
|
|
237
|
+
type: 'legendAllSelect',
|
|
238
|
+
})
|
|
239
|
+
})
|
|
240
|
+
|
|
241
|
+
it('does nothing while at least one legend item stays visible', () => {
|
|
242
|
+
render(<EchartUI option={{}} />)
|
|
243
|
+
fireLegendSelectChanged({ A: true, B: false, C: false })
|
|
244
|
+
expect(mockChart.dispatchAction).not.toHaveBeenCalled()
|
|
245
|
+
})
|
|
246
|
+
|
|
222
247
|
it('clamps overflowing edge labels on `finished` (category x-axis)', () => {
|
|
223
248
|
render(<EchartUI option={categoryOption} />)
|
|
224
249
|
mockChart.setOption.mockClear()
|
|
@@ -114,8 +114,28 @@ export function EchartUI({
|
|
|
114
114
|
)
|
|
115
115
|
}
|
|
116
116
|
chart.on('finished', onFinished)
|
|
117
|
+
// Never let the legend end up with every item hidden — a user can click
|
|
118
|
+
// series off one by one until the chart goes blank. `selected` on this
|
|
119
|
+
// event is always the FULL name→boolean map (not just the clicked item),
|
|
120
|
+
// so "every value false" reliably means "nothing left visible". Restore
|
|
121
|
+
// all of them instead. `legendAllSelect` fires its own `legendselectall`
|
|
122
|
+
// event, not `legendselectchanged`, so this can't re-trigger itself.
|
|
123
|
+
// Always-on and independent of the consumer's `onEvents` — applies to
|
|
124
|
+
// every ECharts widget in the library for free. A widget that disables
|
|
125
|
+
// legend clicks entirely (e.g. Pie's `selectedMode: false`) never fires
|
|
126
|
+
// `legendselectchanged`, so this is a no-op there.
|
|
127
|
+
const onLegendSelectChanged = (params: unknown): void => {
|
|
128
|
+
const { selected } = params as { selected?: Record<string, boolean> }
|
|
129
|
+
if (!selected) return
|
|
130
|
+
const names = Object.keys(selected)
|
|
131
|
+
if (names.length > 0 && names.every((name) => !selected[name])) {
|
|
132
|
+
chart.dispatchAction({ type: 'legendAllSelect' })
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
chart.on('legendselectchanged', onLegendSelectChanged)
|
|
117
136
|
return () => {
|
|
118
137
|
chart.off('finished', onFinished)
|
|
138
|
+
chart.off('legendselectchanged', onLegendSelectChanged)
|
|
119
139
|
// Notify observers *before* disposal so any queued imperative
|
|
120
140
|
// dispatches (e.g. ZoomToggle's `setOption` cleanup) see the
|
|
121
141
|
// instance disappear before its DOM is torn down.
|
|
@@ -61,7 +61,7 @@ describe('useChartSelection', () => {
|
|
|
61
61
|
expect(onSelectionChange).toHaveBeenLastCalledWith([3, 7, 11])
|
|
62
62
|
})
|
|
63
63
|
|
|
64
|
-
it('
|
|
64
|
+
it('collapses undefined/null/an explicit empty list to null, since no merger treats them differently', () => {
|
|
65
65
|
const { result, rerender } = renderHook(
|
|
66
66
|
({ selection }: { selection?: readonly string[] }) =>
|
|
67
67
|
useChartSelection<string>({
|
|
@@ -81,6 +81,8 @@ describe('useChartSelection', () => {
|
|
|
81
81
|
expect(result.current.selection).toBeNull()
|
|
82
82
|
rerender({ selection: ['A'] })
|
|
83
83
|
expect(result.current.selection).toEqual(['A'])
|
|
84
|
+
rerender({ selection: undefined })
|
|
85
|
+
expect(result.current.selection).toBeNull()
|
|
84
86
|
})
|
|
85
87
|
|
|
86
88
|
it('is a no-op when `onSelectionChange` is missing', () => {
|