@brightlocal/ui-components 2.26.0 → 2.27.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/README.md +4 -2
- package/component-meta.json +3761 -360
- package/dist/blocks/progress-screen.cjs +1 -0
- package/dist/blocks/progress-screen.d.ts +109 -0
- package/dist/blocks/progress-screen.d.ts.map +1 -0
- package/dist/blocks/progress-screen.js +339 -0
- package/dist/blocks/sidebar.cjs +1 -1
- package/dist/blocks/sidebar.d.ts.map +1 -1
- package/dist/blocks/sidebar.js +155 -153
- package/dist/brand-illustration-motif.d.ts +1 -1
- package/dist/breadcrumb.cjs +1 -1
- package/dist/breadcrumb.d.ts.map +1 -1
- package/dist/breadcrumb.js +44 -40
- package/dist/button.cjs +1 -1
- package/dist/button.d.ts.map +1 -1
- package/dist/button.js +28 -28
- package/dist/chip.cjs +1 -1
- package/dist/chip.d.ts +1 -1
- package/dist/chip.d.ts.map +1 -1
- package/dist/chip.js +42 -41
- package/dist/combobox.cjs +3 -3
- package/dist/combobox.d.ts +4 -2
- package/dist/combobox.d.ts.map +1 -1
- package/dist/combobox.js +161 -161
- package/dist/data-table.cjs +1 -1
- package/dist/data-table.d.ts +138 -3
- package/dist/data-table.d.ts.map +1 -1
- package/dist/data-table.js +455 -309
- package/dist/global-layout.cjs +1 -1
- package/dist/global-layout.d.ts +31 -5
- package/dist/global-layout.d.ts.map +1 -1
- package/dist/global-layout.js +276 -194
- package/dist/index.cjs +1 -1
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +462 -451
- package/dist/lib/motion.cjs +1 -1
- package/dist/lib/motion.js +10 -8
- package/dist/link.cjs +1 -1
- package/dist/link.d.ts +8 -6
- package/dist/link.d.ts.map +1 -1
- package/dist/link.js +52 -20
- package/dist/list.cjs +1 -1
- package/dist/list.js +65 -63
- package/dist/progress.cjs +1 -1
- package/dist/progress.d.ts +61 -3
- package/dist/progress.d.ts.map +1 -1
- package/dist/progress.js +142 -65
- package/dist/route-progress.cjs +1 -0
- package/dist/route-progress.d.ts +103 -0
- package/dist/route-progress.d.ts.map +1 -0
- package/dist/route-progress.js +106 -0
- package/dist/sheet.cjs +1 -1
- package/dist/sheet.d.ts +35 -2
- package/dist/sheet.d.ts.map +1 -1
- package/dist/sheet.js +102 -65
- package/dist/sonner.cjs +1 -1
- package/dist/sonner.d.ts.map +1 -1
- package/dist/sonner.js +11 -15
- package/dist/spinner.cjs +1 -0
- package/dist/spinner.d.ts +57 -0
- package/dist/spinner.d.ts.map +1 -0
- package/dist/spinner.js +35 -0
- package/dist/stepper.cjs +1 -1
- package/dist/stepper.d.ts.map +1 -1
- package/dist/stepper.js +26 -25
- package/dist/table.cjs +1 -1
- package/dist/table.d.ts +1 -1
- package/dist/table.d.ts.map +1 -1
- package/dist/table.js +6 -2
- package/package.json +14 -2
- package/src/blocks/progress-screen.tsx +481 -0
- package/src/blocks/sidebar.tsx +22 -15
- package/src/components/breadcrumb.tsx +9 -4
- package/src/components/button.tsx +2 -5
- package/src/components/chip.tsx +4 -3
- package/src/components/combobox.tsx +15 -8
- package/src/components/data-table.tsx +333 -14
- package/src/components/global-layout.tsx +228 -62
- package/src/components/link.tsx +39 -5
- package/src/components/list.tsx +5 -5
- package/src/components/progress.tsx +217 -30
- package/src/components/route-progress.tsx +354 -0
- package/src/components/sheet.tsx +87 -5
- package/src/components/sonner.tsx +3 -12
- package/src/components/spinner.tsx +94 -0
- package/src/components/stepper.tsx +3 -4
- package/src/components/table.tsx +6 -2
- package/src/index.ts +3 -0
package/src/components/chip.tsx
CHANGED
|
@@ -2,9 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
import * as React from "react";
|
|
4
4
|
import { cva } from "class-variance-authority";
|
|
5
|
-
import { X
|
|
5
|
+
import { X } from "@brightlocal/icons";
|
|
6
6
|
|
|
7
7
|
import { cn } from "@brightlocal/ui-components/lib/utils";
|
|
8
|
+
import { Spinner } from "@brightlocal/ui-components/spinner";
|
|
8
9
|
import {
|
|
9
10
|
Tooltip,
|
|
10
11
|
TooltipContent,
|
|
@@ -173,7 +174,7 @@ const Chip = React.forwardRef<HTMLDivElement, ChipProps>(
|
|
|
173
174
|
ref
|
|
174
175
|
) => {
|
|
175
176
|
const isDisabled = disabled || loading;
|
|
176
|
-
const iconSize = size === "lg" ? 16 :
|
|
177
|
+
const iconSize = size === "lg" ? 16 : 14;
|
|
177
178
|
const labelRef = React.useRef<HTMLSpanElement>(null);
|
|
178
179
|
const [isTruncated, setIsTruncated] = React.useState(false);
|
|
179
180
|
|
|
@@ -232,7 +233,7 @@ const Chip = React.forwardRef<HTMLDivElement, ChipProps>(
|
|
|
232
233
|
data-slot="chip-loading"
|
|
233
234
|
role="status"
|
|
234
235
|
>
|
|
235
|
-
<
|
|
236
|
+
<Spinner size={size === "lg" ? "md" : "sm"} />
|
|
236
237
|
</span>
|
|
237
238
|
) : (
|
|
238
239
|
<button
|
|
@@ -22,6 +22,7 @@ import {
|
|
|
22
22
|
CommandList,
|
|
23
23
|
CommandSeparator,
|
|
24
24
|
} from "@brightlocal/ui-components/command";
|
|
25
|
+
import { Spinner } from "@brightlocal/ui-components/spinner";
|
|
25
26
|
|
|
26
27
|
/* -------------------------------------------------------------------------------------------------
|
|
27
28
|
* Combobox Context
|
|
@@ -1579,8 +1580,10 @@ export interface ComboboxLoadingProps {
|
|
|
1579
1580
|
/** Children - custom loading content */
|
|
1580
1581
|
children?: React.ReactNode;
|
|
1581
1582
|
/**
|
|
1582
|
-
* Loading
|
|
1583
|
-
*
|
|
1583
|
+
* Loading announcement for assistive technologies (visually hidden).
|
|
1584
|
+
* The default loading state is a spinner only — the surrounding combobox
|
|
1585
|
+
* makes the context unambiguous, so visible text would be noise.
|
|
1586
|
+
* @default "Loading suggestions"
|
|
1584
1587
|
*/
|
|
1585
1588
|
loadingText?: string;
|
|
1586
1589
|
}
|
|
@@ -1594,7 +1597,12 @@ function ComboboxLoading({
|
|
|
1594
1597
|
<div
|
|
1595
1598
|
aria-live="polite"
|
|
1596
1599
|
className={cn(
|
|
1597
|
-
|
|
1600
|
+
// The entrance fade doubles as a ~150ms appearance delay (`both`
|
|
1601
|
+
// holds the hidden start): a fetch that resolves faster than the
|
|
1602
|
+
// delay never flashes a spinner, which would read slower than no
|
|
1603
|
+
// indicator at all.
|
|
1604
|
+
"text-muted-foreground relative flex items-center justify-center gap-2 py-6 text-sm",
|
|
1605
|
+
"animate-entrance-fade entrance-delay-1",
|
|
1598
1606
|
className
|
|
1599
1607
|
)}
|
|
1600
1608
|
data-slot="combobox-loading"
|
|
@@ -1602,11 +1610,10 @@ function ComboboxLoading({
|
|
|
1602
1610
|
>
|
|
1603
1611
|
{children || (
|
|
1604
1612
|
<>
|
|
1605
|
-
<
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
|
|
1609
|
-
{loadingText ?? "Loading..."}
|
|
1613
|
+
<Spinner size="md" />
|
|
1614
|
+
<span className="sr-only">
|
|
1615
|
+
{loadingText ?? "Loading suggestions"}
|
|
1616
|
+
</span>
|
|
1610
1617
|
</>
|
|
1611
1618
|
)}
|
|
1612
1619
|
</div>
|
|
@@ -52,7 +52,14 @@ declare module "@tanstack/react-table" {
|
|
|
52
52
|
}
|
|
53
53
|
}
|
|
54
54
|
import { useVirtualizer } from "@tanstack/react-virtual";
|
|
55
|
-
import {
|
|
55
|
+
import {
|
|
56
|
+
ArrowDown,
|
|
57
|
+
ArrowUp,
|
|
58
|
+
ArrowUpDown,
|
|
59
|
+
ChevronRight,
|
|
60
|
+
Search,
|
|
61
|
+
X,
|
|
62
|
+
} from "@brightlocal/icons";
|
|
56
63
|
|
|
57
64
|
import { cn } from "@brightlocal/ui-components/lib/utils";
|
|
58
65
|
import { Button } from "./button";
|
|
@@ -223,6 +230,24 @@ export interface UseDataTableOptions<TData> {
|
|
|
223
230
|
enableExpanding?: boolean;
|
|
224
231
|
/** Advanced: return sub-rows for tree/expanding tables. */
|
|
225
232
|
getSubRows?: (originalRow: TData, index: number) => TData[] | undefined;
|
|
233
|
+
/**
|
|
234
|
+
* Advanced: allow a row to expand without providing sub-rows — the
|
|
235
|
+
* detail-panel pattern. Return `true` for rows that should show an
|
|
236
|
+
* expander. Pair with `renderExpandedContent` on `DataTable`. Without
|
|
237
|
+
* this (and without `getSubRows`), `row.getCanExpand()` is `false`.
|
|
238
|
+
*/
|
|
239
|
+
getRowCanExpand?: (row: Row<TData>) => boolean;
|
|
240
|
+
/**
|
|
241
|
+
* Advanced: whether expanded sub-rows count toward the page size when
|
|
242
|
+
* `enableExpanding` and `enablePagination` are combined. When `false`
|
|
243
|
+
* (default), each page holds `pageSize` top-level rows and expanded
|
|
244
|
+
* sub-rows render on their parent's page. Set `true` for TanStack's
|
|
245
|
+
* default, where sub-rows consume page slots and can spill onto later
|
|
246
|
+
* pages. Only applies with client-side `enablePagination`; without it
|
|
247
|
+
* (or with `manualPagination`) expansion order is unaffected.
|
|
248
|
+
* @default false
|
|
249
|
+
*/
|
|
250
|
+
paginateExpandedRows?: boolean;
|
|
226
251
|
|
|
227
252
|
// ---------- Controlled state (all optional) ----------
|
|
228
253
|
|
|
@@ -292,6 +317,8 @@ export function useDataTable<TData>(
|
|
|
292
317
|
pageCount,
|
|
293
318
|
enableExpanding = false,
|
|
294
319
|
getSubRows,
|
|
320
|
+
getRowCanExpand,
|
|
321
|
+
paginateExpandedRows = false,
|
|
295
322
|
getRowId,
|
|
296
323
|
pagination: paginationProp,
|
|
297
324
|
onPaginationChange: onPaginationChangeProp,
|
|
@@ -379,10 +406,19 @@ export function useDataTable<TData>(
|
|
|
379
406
|
onRowSelectionChange: setRowSelectionState,
|
|
380
407
|
}),
|
|
381
408
|
|
|
409
|
+
// Always forward the flag — TanStack defaults `enableExpanding` to true,
|
|
410
|
+
// so omitting it would leave `row.getCanExpand()` returning true and
|
|
411
|
+
// `DataTableExpandRowButton` interactive on tables without expanding.
|
|
412
|
+
enableExpanding,
|
|
382
413
|
...(enableExpanding && {
|
|
383
414
|
getExpandedRowModel: getExpandedRowModel(),
|
|
384
415
|
onExpandedChange: setExpandedState,
|
|
385
416
|
getSubRows,
|
|
417
|
+
...(getRowCanExpand && { getRowCanExpand }),
|
|
418
|
+
// Forward only with client-side pagination: `paginateExpandedRows:
|
|
419
|
+
// false` defers expansion to the pagination row model, so without one
|
|
420
|
+
// it would suppress row expansion entirely.
|
|
421
|
+
...(enablePagination && !manualPagination && { paginateExpandedRows }),
|
|
386
422
|
}),
|
|
387
423
|
|
|
388
424
|
state: {
|
|
@@ -461,6 +497,29 @@ export interface DataTableProps<TData> {
|
|
|
461
497
|
* Use for summary rows or totals. Pass a `<TableFooter>` with rows.
|
|
462
498
|
*/
|
|
463
499
|
footer?: React.ReactNode;
|
|
500
|
+
/**
|
|
501
|
+
* Compute an extra class name for a body row. Called for every data row,
|
|
502
|
+
* including expanded sub-rows (check `row.depth` / `row.getIsExpanded()`).
|
|
503
|
+
* Not called for skeleton, empty-state, or expanded detail-panel rows.
|
|
504
|
+
* Merged after the base row classes via `cn`, so a plain background
|
|
505
|
+
* class (for example `bg-red-50`) replaces the built-in expanded-zone tint.
|
|
506
|
+
*/
|
|
507
|
+
getRowClassName?: (row: Row<TData>) => string | undefined;
|
|
508
|
+
/**
|
|
509
|
+
* Render a full-width detail panel below each expanded row: an extra
|
|
510
|
+
* `<tr>` with a single cell spanning all visible columns. Designed for
|
|
511
|
+
* the detail-panel pattern (`getRowCanExpand` on `useDataTable`, no
|
|
512
|
+
* `getSubRows`); when combined with `getSubRows`, the panel renders
|
|
513
|
+
* between the parent row and its sub-rows. Return `null`/`undefined`
|
|
514
|
+
* to skip the panel for a given row. Not supported by
|
|
515
|
+
* `VirtualizedDataTable`.
|
|
516
|
+
*
|
|
517
|
+
* Lazy-load expensive detail: fetch on expand (trigger the request from
|
|
518
|
+
* `onExpandedChange` on `useDataTable`) and return
|
|
519
|
+
* `<DataTableExpandedSkeleton />` while the row's data is in flight so
|
|
520
|
+
* the panel keeps a stable height instead of jumping twice.
|
|
521
|
+
*/
|
|
522
|
+
renderExpandedContent?: (row: Row<TData>) => React.ReactNode;
|
|
464
523
|
}
|
|
465
524
|
|
|
466
525
|
/**
|
|
@@ -512,6 +571,8 @@ export function DataTable<TData>({
|
|
|
512
571
|
minWidth,
|
|
513
572
|
scrollRegionLabel,
|
|
514
573
|
footer,
|
|
574
|
+
getRowClassName,
|
|
575
|
+
renderExpandedContent,
|
|
515
576
|
}: DataTableProps<TData>) {
|
|
516
577
|
const columnCount = table.getVisibleLeafColumns().length;
|
|
517
578
|
const resolvedSkeletonCount =
|
|
@@ -553,7 +614,15 @@ export function DataTable<TData>({
|
|
|
553
614
|
{table.getRowModel().rows.length > 0 ? (
|
|
554
615
|
table
|
|
555
616
|
.getRowModel()
|
|
556
|
-
.rows.map((row) =>
|
|
617
|
+
.rows.map((row) => (
|
|
618
|
+
<DataTableRow
|
|
619
|
+
key={row.id}
|
|
620
|
+
columnCount={columnCount}
|
|
621
|
+
getRowClassName={getRowClassName}
|
|
622
|
+
renderExpandedContent={renderExpandedContent}
|
|
623
|
+
row={row}
|
|
624
|
+
/>
|
|
625
|
+
))
|
|
557
626
|
) : (
|
|
558
627
|
<TableRow>
|
|
559
628
|
<TableCell align="center" colSpan={columnCount} size="lg">
|
|
@@ -628,16 +697,70 @@ function DataTableHeaderRows<TData>({
|
|
|
628
697
|
/**
|
|
629
698
|
* Internal: render a single data (or pinned) row.
|
|
630
699
|
* Kept internal because pinned rows share the same visual contract as data rows.
|
|
700
|
+
*
|
|
701
|
+
* Addressable-row contract (styling and consumer CSS target these):
|
|
702
|
+
* - `data-depth` — row depth, `0` for top-level rows, on every data row
|
|
703
|
+
* (never on the detail-panel row, so depth selectors count data rows only).
|
|
704
|
+
* - `data-expanded="true" | "false"` — present only on rows that can expand;
|
|
705
|
+
* its presence marks an expandable row.
|
|
706
|
+
* - `data-slot="data-table-expanded-row"` — the full-width detail-panel row.
|
|
707
|
+
* - `data-state="selected"` — the pre-existing selection hook.
|
|
631
708
|
*/
|
|
632
|
-
function DataTableRow<TData>({
|
|
709
|
+
function DataTableRow<TData>({
|
|
710
|
+
row,
|
|
711
|
+
columnCount,
|
|
712
|
+
getRowClassName,
|
|
713
|
+
renderExpandedContent,
|
|
714
|
+
}: {
|
|
715
|
+
row: Row<TData>;
|
|
716
|
+
columnCount: number;
|
|
717
|
+
getRowClassName?: (row: Row<TData>) => string | undefined;
|
|
718
|
+
renderExpandedContent?: (row: Row<TData>) => React.ReactNode;
|
|
719
|
+
}) {
|
|
720
|
+
const canExpand = row.getCanExpand();
|
|
721
|
+
const expanded = row.getIsExpanded();
|
|
722
|
+
const panel =
|
|
723
|
+
renderExpandedContent && canExpand && expanded
|
|
724
|
+
? renderExpandedContent(row)
|
|
725
|
+
: null;
|
|
633
726
|
return (
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
727
|
+
<>
|
|
728
|
+
<TableRow
|
|
729
|
+
className={cn(
|
|
730
|
+
// Rows have no hover of their own — the chevron/action buttons are
|
|
731
|
+
// the interactive elements. Ghost buttons (the only bg-transparent
|
|
732
|
+
// variant) get bg-secondary on hover because their default
|
|
733
|
+
// hover:bg-accent is invisible on bg-muted rows (accent equals
|
|
734
|
+
// muted in light mode). Scoped to .bg-transparent so variant
|
|
735
|
+
// buttons in cells (primary, destructive, …) keep their own hover.
|
|
736
|
+
"[&_[data-slot=button].bg-transparent:hover]:bg-secondary",
|
|
737
|
+
// Surfaces are mutually exclusive: an expanded parent shares the
|
|
738
|
+
// table head's bg-muted at ANY depth; other expanded-zone rows
|
|
739
|
+
// (sub-rows) get the lighter accent wash.
|
|
740
|
+
canExpand && expanded ? "bg-muted" : row.depth > 0 && "bg-accent/50",
|
|
741
|
+
getRowClassName?.(row)
|
|
742
|
+
)}
|
|
743
|
+
data-depth={row.depth}
|
|
744
|
+
data-expanded={canExpand ? String(expanded) : undefined}
|
|
745
|
+
data-state={row.getIsSelected() ? "selected" : undefined}
|
|
746
|
+
>
|
|
747
|
+
{row.getVisibleCells().map((cell) => (
|
|
748
|
+
<TableCell key={cell.id}>
|
|
749
|
+
{flexRender(cell.column.columnDef.cell, cell.getContext())}
|
|
750
|
+
</TableCell>
|
|
751
|
+
))}
|
|
752
|
+
</TableRow>
|
|
753
|
+
{panel != null && (
|
|
754
|
+
// No data-depth here: panels are not data rows, and sharing the
|
|
755
|
+
// parent's depth would break depth-based selectors and counts.
|
|
756
|
+
<TableRow
|
|
757
|
+
className="bg-accent/50 [&_[data-slot=button].bg-transparent:hover]:bg-secondary"
|
|
758
|
+
data-slot="data-table-expanded-row"
|
|
759
|
+
>
|
|
760
|
+
<TableCell colSpan={columnCount}>{panel}</TableCell>
|
|
761
|
+
</TableRow>
|
|
762
|
+
)}
|
|
763
|
+
</>
|
|
641
764
|
);
|
|
642
765
|
}
|
|
643
766
|
|
|
@@ -676,10 +799,17 @@ function LoadingRows({
|
|
|
676
799
|
* Same contract as `DataTable` but renders only the visible rows using
|
|
677
800
|
* `@tanstack/react-virtual`. The outer wrapper becomes the scroll container,
|
|
678
801
|
* so a bounded `height` is required.
|
|
802
|
+
*
|
|
803
|
+
* `renderExpandedContent` is excluded: virtual indices map 1:1 to row-model
|
|
804
|
+
* rows, and injecting variable-height detail-panel rows would break index
|
|
805
|
+
* mapping and size estimation. Expanding via `getSubRows` still works —
|
|
806
|
+
* sub-rows are real row-model rows — as do `getRowClassName` and the
|
|
807
|
+
* addressable row attributes.
|
|
679
808
|
*/
|
|
680
|
-
export interface VirtualizedDataTableProps<
|
|
681
|
-
TData
|
|
682
|
-
|
|
809
|
+
export interface VirtualizedDataTableProps<TData> extends Omit<
|
|
810
|
+
DataTableProps<TData>,
|
|
811
|
+
"renderExpandedContent"
|
|
812
|
+
> {
|
|
683
813
|
/**
|
|
684
814
|
* Height of the scroll container in pixels. Required — virtualization
|
|
685
815
|
* needs a bounded viewport. Pass a CSS value via `className` instead
|
|
@@ -739,6 +869,7 @@ export function VirtualizedDataTable<TData>({
|
|
|
739
869
|
minWidth,
|
|
740
870
|
scrollRegionLabel,
|
|
741
871
|
footer,
|
|
872
|
+
getRowClassName,
|
|
742
873
|
height,
|
|
743
874
|
estimateSize = 48,
|
|
744
875
|
overscan = 5,
|
|
@@ -811,7 +942,14 @@ export function VirtualizedDataTable<TData>({
|
|
|
811
942
|
)}
|
|
812
943
|
{virtualItems.map((virtualItem) => {
|
|
813
944
|
const row = rows[virtualItem.index]!;
|
|
814
|
-
return
|
|
945
|
+
return (
|
|
946
|
+
<DataTableRow
|
|
947
|
+
key={row.id}
|
|
948
|
+
columnCount={columnCount}
|
|
949
|
+
getRowClassName={getRowClassName}
|
|
950
|
+
row={row}
|
|
951
|
+
/>
|
|
952
|
+
);
|
|
815
953
|
})}
|
|
816
954
|
{paddingBottom > 0 && (
|
|
817
955
|
<tr aria-hidden="true">
|
|
@@ -1557,6 +1695,187 @@ export function DataTableSelectRowCheckbox<TData>({
|
|
|
1557
1695
|
|
|
1558
1696
|
DataTableSelectRowCheckbox.displayName = "DataTableSelectRowCheckbox";
|
|
1559
1697
|
|
|
1698
|
+
/* -------------------------------------------------------------------------------------------------
|
|
1699
|
+
* DataTableExpandRowButton (row expansion toggle)
|
|
1700
|
+
* -----------------------------------------------------------------------------------------------*/
|
|
1701
|
+
|
|
1702
|
+
/**
|
|
1703
|
+
* Props for `DataTableExpandRowButton`.
|
|
1704
|
+
*/
|
|
1705
|
+
export interface DataTableExpandRowButtonProps<TData> {
|
|
1706
|
+
/** TanStack row instance. */
|
|
1707
|
+
row: Row<TData>;
|
|
1708
|
+
/**
|
|
1709
|
+
* Human-readable name of the row, interpolated into the accessible
|
|
1710
|
+
* labels so every toggle identifies its row to screen-reader users
|
|
1711
|
+
* ("Expand details for Brighton — North Laine"). Pass the row's
|
|
1712
|
+
* primary display value (e.g. `row.original.name`). Without it the
|
|
1713
|
+
* labels fall back to the generic "Expand row" / "Collapse row" —
|
|
1714
|
+
* fifty identical buttons — so always provide it when rows have a
|
|
1715
|
+
* natural name.
|
|
1716
|
+
*/
|
|
1717
|
+
rowName?: string;
|
|
1718
|
+
/**
|
|
1719
|
+
* Accessible label when the row is collapsed. Supports the `{name}`
|
|
1720
|
+
* placeholder, replaced with `rowName`.
|
|
1721
|
+
* @default "Expand details for {name}" when `rowName` is set, "Expand row" otherwise
|
|
1722
|
+
*/
|
|
1723
|
+
expandLabel?: string;
|
|
1724
|
+
/**
|
|
1725
|
+
* Accessible label when the row is expanded. Supports the `{name}`
|
|
1726
|
+
* placeholder, replaced with `rowName`.
|
|
1727
|
+
* @default "Collapse details for {name}" when `rowName` is set, "Collapse row" otherwise
|
|
1728
|
+
*/
|
|
1729
|
+
collapseLabel?: string;
|
|
1730
|
+
/** Data hook for automated testing. @default `expand-row-{row.id}` */
|
|
1731
|
+
dataHook?: string;
|
|
1732
|
+
/** Analytics element identifier. */
|
|
1733
|
+
trackingEl?: string;
|
|
1734
|
+
/** Analytics label. */
|
|
1735
|
+
trackingLabel?: string;
|
|
1736
|
+
/** Additional class name (external layout only). */
|
|
1737
|
+
className?: string;
|
|
1738
|
+
}
|
|
1739
|
+
|
|
1740
|
+
/**
|
|
1741
|
+
* Row expansion toggle: a ghost icon button with an animated chevron that
|
|
1742
|
+
* points right when collapsed and down when expanded. Rows that cannot
|
|
1743
|
+
* expand render an invisible spacer with the same footprint so cell
|
|
1744
|
+
* content stays aligned with expandable siblings. Requires
|
|
1745
|
+
* `enableExpanding` on `useDataTable` (with `getSubRows` for sub-rows or
|
|
1746
|
+
* `getRowCanExpand` for the detail-panel pattern).
|
|
1747
|
+
*/
|
|
1748
|
+
export function DataTableExpandRowButton<TData>({
|
|
1749
|
+
row,
|
|
1750
|
+
rowName,
|
|
1751
|
+
dataHook,
|
|
1752
|
+
trackingEl,
|
|
1753
|
+
trackingLabel,
|
|
1754
|
+
expandLabel,
|
|
1755
|
+
collapseLabel,
|
|
1756
|
+
className,
|
|
1757
|
+
}: DataTableExpandRowButtonProps<TData>) {
|
|
1758
|
+
if (!row.getCanExpand()) {
|
|
1759
|
+
// Spacer matches the iconOnly Button footprint (size-9) so leaf-row
|
|
1760
|
+
// cell content aligns with expandable siblings.
|
|
1761
|
+
return (
|
|
1762
|
+
<span
|
|
1763
|
+
aria-hidden="true"
|
|
1764
|
+
className={cn("inline-block size-9", className)}
|
|
1765
|
+
data-slot="data-table-expand-row-spacer"
|
|
1766
|
+
/>
|
|
1767
|
+
);
|
|
1768
|
+
}
|
|
1769
|
+
const expanded = row.getIsExpanded();
|
|
1770
|
+
// Resolve the accessible label. A custom template interpolates every
|
|
1771
|
+
// {name} occurrence; a template that needs {name} while rowName is
|
|
1772
|
+
// absent falls back to the defaults, so no toggle ever announces a
|
|
1773
|
+
// dangling label like "Expand details for ".
|
|
1774
|
+
const template = expanded ? collapseLabel : expandLabel;
|
|
1775
|
+
let label: string;
|
|
1776
|
+
if (template && (rowName !== undefined || !template.includes("{name}"))) {
|
|
1777
|
+
label = template.replaceAll("{name}", rowName ?? "");
|
|
1778
|
+
} else if (rowName !== undefined) {
|
|
1779
|
+
label = expanded
|
|
1780
|
+
? `Collapse details for ${rowName}`
|
|
1781
|
+
: `Expand details for ${rowName}`;
|
|
1782
|
+
} else {
|
|
1783
|
+
label = expanded ? "Collapse row" : "Expand row";
|
|
1784
|
+
}
|
|
1785
|
+
return (
|
|
1786
|
+
<Button
|
|
1787
|
+
iconOnly
|
|
1788
|
+
aria-expanded={expanded}
|
|
1789
|
+
aria-label={label}
|
|
1790
|
+
className={className}
|
|
1791
|
+
data-state={expanded ? "open" : "closed"}
|
|
1792
|
+
dataHook={dataHook || `expand-row-${row.id}`}
|
|
1793
|
+
size="sm"
|
|
1794
|
+
trackingEl={trackingEl}
|
|
1795
|
+
trackingLabel={trackingLabel}
|
|
1796
|
+
variant="ghost"
|
|
1797
|
+
onClick={row.getToggleExpandedHandler()}
|
|
1798
|
+
>
|
|
1799
|
+
<ChevronRight
|
|
1800
|
+
aria-hidden="true"
|
|
1801
|
+
className={cn(
|
|
1802
|
+
"duration-base transition-transform ease-in-out",
|
|
1803
|
+
expanded && "rotate-90"
|
|
1804
|
+
)}
|
|
1805
|
+
/>
|
|
1806
|
+
</Button>
|
|
1807
|
+
);
|
|
1808
|
+
}
|
|
1809
|
+
|
|
1810
|
+
DataTableExpandRowButton.displayName = "DataTableExpandRowButton";
|
|
1811
|
+
|
|
1812
|
+
/* -------------------------------------------------------------------------------------------------
|
|
1813
|
+
* DataTableExpandedSkeleton (loading state for a lazy-loaded detail panel)
|
|
1814
|
+
* -----------------------------------------------------------------------------------------------*/
|
|
1815
|
+
|
|
1816
|
+
/**
|
|
1817
|
+
* Props for `DataTableExpandedSkeleton`.
|
|
1818
|
+
*/
|
|
1819
|
+
export interface DataTableExpandedSkeletonProps {
|
|
1820
|
+
/**
|
|
1821
|
+
* Number of field-shaped placeholder lines. Match the number of
|
|
1822
|
+
* key-value fields the loaded panel will render so the row height
|
|
1823
|
+
* stays stable when the content arrives.
|
|
1824
|
+
* @default 3
|
|
1825
|
+
*/
|
|
1826
|
+
fields?: number;
|
|
1827
|
+
/**
|
|
1828
|
+
* Screen-reader announcement while the panel content loads.
|
|
1829
|
+
* @default "Loading details"
|
|
1830
|
+
*/
|
|
1831
|
+
loadingLabel?: string;
|
|
1832
|
+
/** Data hook for automated testing. @default "data-table-expanded-skeleton" */
|
|
1833
|
+
dataHook?: string;
|
|
1834
|
+
/** Additional class name (external layout only). */
|
|
1835
|
+
className?: string;
|
|
1836
|
+
}
|
|
1837
|
+
|
|
1838
|
+
/**
|
|
1839
|
+
* Loading state for a lazy-loaded expanded detail panel: field-shaped
|
|
1840
|
+
* skeleton lines (label + value) sized to match the definition-list
|
|
1841
|
+
* layout the loaded panel renders. Return it from
|
|
1842
|
+
* `renderExpandedContent` while the row's detail request is in flight —
|
|
1843
|
+
* fetch on expand via `onExpandedChange`, never with the table.
|
|
1844
|
+
*
|
|
1845
|
+
* @example
|
|
1846
|
+
* renderExpandedContent={(row) =>
|
|
1847
|
+
* details[row.id]
|
|
1848
|
+
* ? <LocationDetail detail={details[row.id]} />
|
|
1849
|
+
* : <DataTableExpandedSkeleton fields={4} />
|
|
1850
|
+
* }
|
|
1851
|
+
*/
|
|
1852
|
+
export function DataTableExpandedSkeleton({
|
|
1853
|
+
fields = 3,
|
|
1854
|
+
loadingLabel,
|
|
1855
|
+
dataHook,
|
|
1856
|
+
className,
|
|
1857
|
+
}: DataTableExpandedSkeletonProps) {
|
|
1858
|
+
return (
|
|
1859
|
+
<div
|
|
1860
|
+
// `relative` anchors the sr-only span's containing block.
|
|
1861
|
+
className={cn("relative flex flex-col gap-2 py-1", className)}
|
|
1862
|
+
data-hook={dataHook || "data-table-expanded-skeleton"}
|
|
1863
|
+
data-slot="data-table-expanded-skeleton"
|
|
1864
|
+
role="status"
|
|
1865
|
+
>
|
|
1866
|
+
<span className="sr-only">{loadingLabel ?? "Loading details"}</span>
|
|
1867
|
+
{Array.from({ length: fields }, (_, i) => (
|
|
1868
|
+
<div key={i} aria-hidden="true" className="flex items-center gap-4">
|
|
1869
|
+
<Skeleton className="h-4 w-24 shrink-0" />
|
|
1870
|
+
<Skeleton className="h-4 w-48 max-w-full" />
|
|
1871
|
+
</div>
|
|
1872
|
+
))}
|
|
1873
|
+
</div>
|
|
1874
|
+
);
|
|
1875
|
+
}
|
|
1876
|
+
|
|
1877
|
+
DataTableExpandedSkeleton.displayName = "DataTableExpandedSkeleton";
|
|
1878
|
+
|
|
1560
1879
|
/* -------------------------------------------------------------------------------------------------
|
|
1561
1880
|
* DataTableBulkActions (selection summary + bulk action bar)
|
|
1562
1881
|
* -----------------------------------------------------------------------------------------------*/
|