@brightlocal/ui-components 3.2.0 → 3.4.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/AI_USAGE.md +10 -0
- package/README.md +3 -1
- package/component-meta.json +1458 -380
- package/deprecations.json +44 -0
- package/dist/_virtual/_rolldown/runtime.cjs +1 -0
- package/dist/accordion.cjs +1 -1
- package/dist/accordion.js +73 -102
- package/dist/alert-dialog.cjs +1 -1
- package/dist/alert-dialog.d.ts +6 -4
- package/dist/alert-dialog.d.ts.map +1 -1
- package/dist/alert-dialog.js +85 -133
- package/dist/alert.cjs +1 -1
- package/dist/alert.d.ts +4 -4
- package/dist/alert.d.ts.map +1 -1
- package/dist/alert.js +106 -168
- package/dist/aspect-ratio.cjs +1 -1
- package/dist/aspect-ratio.js +13 -16
- package/dist/avatar.cjs +1 -1
- package/dist/avatar.js +30 -45
- package/dist/badge.cjs +1 -1
- package/dist/badge.d.ts +23 -1
- package/dist/badge.d.ts.map +1 -1
- package/dist/badge.js +90 -91
- package/dist/banner.cjs +1 -1
- package/dist/banner.js +102 -148
- package/dist/blocks/empty-state.cjs +1 -1
- package/dist/blocks/empty-state.d.ts +20 -3
- package/dist/blocks/empty-state.d.ts.map +1 -1
- package/dist/blocks/empty-state.js +73 -140
- package/dist/blocks/input-list.cjs +2 -2
- package/dist/blocks/input-list.d.ts +2 -2
- package/dist/blocks/input-list.d.ts.map +1 -1
- package/dist/blocks/input-list.js +138 -178
- package/dist/blocks/progress-state.cjs +1 -1
- package/dist/blocks/progress-state.js +223 -347
- package/dist/blocks/sidebar.cjs +1 -1
- package/dist/blocks/sidebar.d.ts +11 -6
- package/dist/blocks/sidebar.d.ts.map +1 -1
- package/dist/blocks/sidebar.js +763 -1092
- package/dist/brand-illustration-motif.cjs +1 -1
- package/dist/brand-illustration-motif.js +40 -61
- package/dist/breadcrumb.cjs +1 -1
- package/dist/breadcrumb.js +62 -102
- package/dist/button-group.cjs +1 -1
- package/dist/button-group.js +23 -31
- package/dist/button.cjs +1 -1
- package/dist/button.d.ts +4 -2
- package/dist/button.d.ts.map +1 -1
- package/dist/button.js +149 -189
- package/dist/calendar.cjs +1 -1
- package/dist/calendar.d.ts +87 -3
- package/dist/calendar.d.ts.map +1 -1
- package/dist/calendar.js +116 -173
- package/dist/callout.cjs +1 -1
- package/dist/callout.js +73 -96
- package/dist/card.cjs +1 -1
- package/dist/card.d.ts +10 -4
- package/dist/card.d.ts.map +1 -1
- package/dist/card.js +233 -316
- package/dist/carousel.cjs +1 -1
- package/dist/carousel.d.ts +3 -3
- package/dist/carousel.d.ts.map +1 -1
- package/dist/carousel.js +174 -268
- package/dist/centred-layout.cjs +1 -1
- package/dist/centred-layout.js +27 -48
- package/dist/chart-empty.cjs +1 -1
- package/dist/chart-empty.js +18 -27
- package/dist/chart.cjs +7 -7
- package/dist/chart.d.ts +23 -13
- package/dist/chart.d.ts.map +1 -1
- package/dist/chart.js +445 -651
- package/dist/checkbox.cjs +1 -1
- package/dist/checkbox.js +36 -69
- package/dist/chip.cjs +1 -1
- package/dist/chip.js +116 -173
- package/dist/collapsible.cjs +1 -1
- package/dist/collapsible.d.ts.map +1 -1
- package/dist/collapsible.js +35 -41
- package/dist/combobox.cjs +3 -3
- package/dist/combobox.d.ts +14 -4
- package/dist/combobox.d.ts.map +1 -1
- package/dist/combobox.js +439 -638
- package/dist/command.cjs +1 -1
- package/dist/command.d.ts.map +1 -1
- package/dist/command.js +273 -420
- package/dist/context-menu.cjs +1 -1
- package/dist/context-menu.d.ts +5 -5
- package/dist/context-menu.d.ts.map +1 -1
- package/dist/context-menu.js +121 -191
- package/dist/data-table.cjs +1 -1
- package/dist/data-table.d.ts +280 -129
- package/dist/data-table.d.ts.map +1 -1
- package/dist/data-table.js +687 -948
- package/dist/date-picker.cjs +1 -1
- package/dist/date-picker.d.ts +15 -4
- package/dist/date-picker.d.ts.map +1 -1
- package/dist/date-picker.js +156 -231
- package/dist/delta.cjs +1 -0
- package/dist/delta.d.ts +79 -0
- package/dist/delta.d.ts.map +1 -0
- package/dist/delta.js +62 -0
- package/dist/description-list.cjs +1 -0
- package/dist/description-list.d.ts +142 -0
- package/dist/description-list.d.ts.map +1 -0
- package/dist/description-list.js +173 -0
- package/dist/description.cjs +1 -1
- package/dist/description.js +11 -20
- package/dist/dialog.cjs +1 -1
- package/dist/dialog.d.ts +1 -1
- package/dist/dialog.d.ts.map +1 -1
- package/dist/dialog.js +76 -116
- package/dist/drawer.cjs +1 -1
- package/dist/drawer.d.ts +11 -11
- package/dist/drawer.d.ts.map +1 -1
- package/dist/drawer.js +76 -134
- package/dist/dropdown-menu.cjs +1 -1
- package/dist/dropdown-menu.d.ts +6 -6
- package/dist/dropdown-menu.d.ts.map +1 -1
- package/dist/dropdown-menu.js +179 -300
- package/dist/field.cjs +1 -1
- package/dist/field.d.ts +9 -9
- package/dist/field.d.ts.map +1 -1
- package/dist/field.js +166 -286
- package/dist/global-layout.cjs +1 -1
- package/dist/global-layout.js +203 -342
- package/dist/grid.cjs +1 -1
- package/dist/grid.js +16 -29
- package/dist/header.cjs +1 -1
- package/dist/header.js +21 -38
- package/dist/height-transition.cjs +1 -1
- package/dist/height-transition.js +38 -55
- package/dist/hooks/use-breakpoint.cjs +1 -1
- package/dist/hooks/use-breakpoint.js +9 -9
- package/dist/hooks/use-debounce.cjs +1 -1
- package/dist/hooks/use-debounce.js +12 -11
- package/dist/hooks/use-delayed-pending.cjs +1 -1
- package/dist/hooks/use-delayed-pending.js +8 -9
- package/dist/hooks/use-filter-search-params.cjs +1 -0
- package/dist/hooks/use-filter-search-params.d.ts +93 -0
- package/dist/hooks/use-filter-search-params.d.ts.map +1 -0
- package/dist/hooks/use-filter-search-params.js +122 -0
- package/dist/hooks/use-mobile.cjs +1 -1
- package/dist/hooks/use-mobile.js +6 -6
- package/dist/hooks/use-overlay-pointer-lock.cjs +1 -1
- package/dist/hooks/use-overlay-pointer-lock.js +8 -9
- package/dist/hooks/use-prefers-reduced-motion.cjs +1 -1
- package/dist/hooks/use-prefers-reduced-motion.js +5 -8
- package/dist/hover-card.cjs +1 -1
- package/dist/hover-card.d.ts +1 -1
- package/dist/hover-card.d.ts.map +1 -1
- package/dist/hover-card.js +30 -62
- package/dist/index.cjs +1 -1
- package/dist/index.d.ts +7 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +658 -614
- package/dist/info-tooltip.cjs +1 -1
- package/dist/info-tooltip.js +22 -36
- package/dist/input-chip.cjs +1 -1
- package/dist/input-chip.d.ts +32 -3
- package/dist/input-chip.d.ts.map +1 -1
- package/dist/input-chip.js +181 -230
- package/dist/input-group.cjs +1 -1
- package/dist/input-group.js +174 -221
- package/dist/input-otp.cjs +1 -1
- package/dist/input-otp.d.ts +3 -3
- package/dist/input-otp.d.ts.map +1 -1
- package/dist/input-otp.js +102 -146
- package/dist/input-password.cjs +1 -1
- package/dist/input-password.d.ts +12 -16
- package/dist/input-password.d.ts.map +1 -1
- package/dist/input-password.js +139 -171
- package/dist/input.cjs +1 -1
- package/dist/input.d.ts.map +1 -1
- package/dist/input.js +51 -73
- package/dist/label.cjs +1 -1
- package/dist/label.js +20 -38
- package/dist/lib/block-illustration.cjs +1 -1
- package/dist/lib/block-illustration.d.ts +1 -1
- package/dist/lib/block-illustration.d.ts.map +1 -1
- package/dist/lib/block-illustration.js +16 -18
- package/dist/lib/compose-event-handlers.cjs +1 -0
- package/dist/lib/compose-event-handlers.d.ts +9 -0
- package/dist/lib/compose-event-handlers.d.ts.map +1 -0
- package/dist/lib/compose-event-handlers.js +8 -0
- package/dist/lib/download-file.cjs +1 -0
- package/dist/lib/download-file.d.ts +14 -0
- package/dist/lib/download-file.d.ts.map +1 -0
- package/dist/lib/download-file.js +40 -0
- package/dist/lib/empty-canvas.cjs +1 -1
- package/dist/lib/empty-canvas.js +28 -56
- package/dist/lib/empty-chip.cjs +1 -1
- package/dist/lib/empty-chip.d.ts +14 -3
- package/dist/lib/empty-chip.d.ts.map +1 -1
- package/dist/lib/empty-chip.js +15 -11
- package/dist/lib/field-aria.cjs +1 -0
- package/dist/lib/field-aria.d.ts +34 -0
- package/dist/lib/field-aria.d.ts.map +1 -0
- package/dist/lib/field-aria.js +52 -0
- package/dist/lib/image-file-info.cjs +1 -0
- package/dist/lib/image-file-info.d.ts +25 -0
- package/dist/lib/image-file-info.d.ts.map +1 -0
- package/dist/lib/image-file-info.js +67 -0
- package/dist/lib/media-viewer-content.cjs +1 -0
- package/dist/lib/media-viewer-content.d.ts +102 -0
- package/dist/lib/media-viewer-content.d.ts.map +1 -0
- package/dist/lib/media-viewer-content.js +650 -0
- package/dist/lib/media-viewer-internal.cjs +1 -0
- package/dist/lib/media-viewer-internal.d.ts +98 -0
- package/dist/lib/media-viewer-internal.d.ts.map +1 -0
- package/dist/lib/media-viewer-internal.js +61 -0
- package/dist/lib/media-viewer-motion.cjs +1 -0
- package/dist/lib/media-viewer-motion.d.ts +40 -0
- package/dist/lib/media-viewer-motion.d.ts.map +1 -0
- package/dist/lib/media-viewer-motion.js +37 -0
- package/dist/lib/motion.cjs +1 -1
- package/dist/lib/motion.d.ts +8 -0
- package/dist/lib/motion.d.ts.map +1 -1
- package/dist/lib/motion.js +14 -8
- package/dist/lib/optical-center.cjs +1 -1
- package/dist/lib/optical-center.d.ts +1 -1
- package/dist/lib/optical-center.d.ts.map +1 -1
- package/dist/lib/optical-center.js +12 -5
- package/dist/lib/spring-settle.cjs +1 -1
- package/dist/lib/spring-settle.js +1 -1
- package/dist/lib/table-internal.cjs +1 -0
- package/dist/lib/table-internal.d.ts +62 -0
- package/dist/lib/table-internal.d.ts.map +1 -0
- package/dist/lib/table-internal.js +18 -0
- package/dist/lib/use-controllable.cjs +1 -0
- package/dist/lib/use-controllable.d.ts +12 -0
- package/dist/lib/use-controllable.d.ts.map +1 -0
- package/dist/lib/use-controllable.js +15 -0
- package/dist/lib/use-dev-warning.cjs +1 -1
- package/dist/lib/utils.cjs +1 -1
- package/dist/lib/utils.js +26 -33
- package/dist/link.cjs +1 -1
- package/dist/link.d.ts +1 -1
- package/dist/link.js +78 -124
- package/dist/list.cjs +1 -1
- package/dist/list.d.ts +224 -39
- package/dist/list.d.ts.map +1 -1
- package/dist/list.js +323 -171
- package/dist/loading.cjs +1 -1
- package/dist/loading.js +124 -151
- package/dist/logo-mark.cjs +1 -0
- package/dist/logo-mark.d.ts +79 -0
- package/dist/logo-mark.d.ts.map +1 -0
- package/dist/logo-mark.js +219 -0
- package/dist/logo.cjs +1 -1
- package/dist/logo.d.ts +1 -1
- package/dist/logo.d.ts.map +1 -1
- package/dist/logo.js +51 -87
- package/dist/map.cjs +1 -1
- package/dist/map.d.ts.map +1 -1
- package/dist/map.js +390 -586
- package/dist/media-empty.cjs +1 -1
- package/dist/media-empty.js +27 -42
- package/dist/media-viewer.cjs +1 -0
- package/dist/media-viewer.d.ts +224 -0
- package/dist/media-viewer.d.ts.map +1 -0
- package/dist/media-viewer.js +295 -0
- package/dist/menubar.cjs +1 -1
- package/dist/menubar.d.ts +14 -14
- package/dist/menubar.d.ts.map +1 -1
- package/dist/menubar.js +130 -267
- package/dist/multi-select-filter.cjs +1 -1
- package/dist/multi-select-filter.d.ts +9 -1
- package/dist/multi-select-filter.d.ts.map +1 -1
- package/dist/multi-select-filter.js +357 -446
- package/dist/navigation-menu.cjs +1 -1
- package/dist/navigation-menu.js +108 -172
- package/dist/pagination.cjs +1 -1
- package/dist/pagination.d.ts +36 -12
- package/dist/pagination.d.ts.map +1 -1
- package/dist/pagination.js +208 -281
- package/dist/popover.cjs +1 -1
- package/dist/popover.d.ts +1 -1
- package/dist/popover.d.ts.map +1 -1
- package/dist/popover.js +34 -45
- package/dist/progress.cjs +1 -1
- package/dist/progress.d.ts +17 -2
- package/dist/progress.d.ts.map +1 -1
- package/dist/progress.js +116 -162
- package/dist/radio-group.cjs +1 -1
- package/dist/radio-group.js +90 -146
- package/dist/rating.cjs +1 -1
- package/dist/rating.d.ts +80 -13
- package/dist/rating.d.ts.map +1 -1
- package/dist/rating.js +70 -65
- package/dist/relative-date.cjs +1 -1
- package/dist/relative-date.d.ts.map +1 -1
- package/dist/relative-date.js +73 -89
- package/dist/resizable.cjs +1 -1
- package/dist/resizable.d.ts +39 -23
- package/dist/resizable.d.ts.map +1 -1
- package/dist/resizable.js +42 -44
- package/dist/result-count.cjs +1 -0
- package/dist/result-count.d.ts +110 -0
- package/dist/result-count.d.ts.map +1 -0
- package/dist/result-count.js +49 -0
- package/dist/route-progress.cjs +1 -1
- package/dist/route-progress.js +59 -102
- package/dist/scroll-area.cjs +1 -1
- package/dist/scroll-area.d.ts +9 -1
- package/dist/scroll-area.d.ts.map +1 -1
- package/dist/scroll-area.js +44 -79
- package/dist/select.cjs +2 -2
- package/dist/select.d.ts +10 -10
- package/dist/select.d.ts.map +1 -1
- package/dist/select.js +118 -238
- package/dist/separator.cjs +1 -1
- package/dist/separator.js +90 -78
- package/dist/sheet.cjs +1 -1
- package/dist/sheet.d.ts +8 -5
- package/dist/sheet.d.ts.map +1 -1
- package/dist/sheet.js +250 -317
- package/dist/single-select-filter.cjs +1 -1
- package/dist/single-select-filter.d.ts +32 -0
- package/dist/single-select-filter.d.ts.map +1 -1
- package/dist/single-select-filter.js +201 -203
- package/dist/skeleton.cjs +1 -1
- package/dist/skeleton.js +24 -38
- package/dist/slider.cjs +1 -1
- package/dist/slider.js +51 -81
- package/dist/sonner.cjs +1 -1
- package/dist/sonner.d.ts +1 -1
- package/dist/sonner.d.ts.map +1 -1
- package/dist/sonner.js +101 -125
- package/dist/spinner.cjs +1 -1
- package/dist/spinner.js +22 -31
- package/dist/split-layout.cjs +1 -1
- package/dist/split-layout.js +52 -101
- package/dist/status.cjs +1 -0
- package/dist/status.d.ts +51 -0
- package/dist/status.d.ts.map +1 -0
- package/dist/status.js +60 -0
- package/dist/stepper.cjs +1 -1
- package/dist/stepper.js +184 -316
- package/dist/switch.cjs +1 -1
- package/dist/switch.js +17 -32
- package/dist/table.cjs +1 -1
- package/dist/table.d.ts +103 -30
- package/dist/table.d.ts.map +1 -1
- package/dist/table.js +170 -209
- package/dist/tabs.cjs +1 -1
- package/dist/tabs.d.ts.map +1 -1
- package/dist/tabs.js +102 -147
- package/dist/text-reveal-motion.cjs +1 -1
- package/dist/text-reveal-motion.js +307 -363
- package/dist/textarea.cjs +1 -1
- package/dist/textarea.d.ts.map +1 -1
- package/dist/textarea.js +22 -35
- package/dist/toggle-group.cjs +1 -1
- package/dist/toggle-group.js +43 -62
- package/dist/toggle.cjs +1 -1
- package/dist/toggle.js +34 -46
- package/dist/tooltip.cjs +1 -1
- package/dist/tooltip.d.ts +2 -2
- package/dist/tooltip.d.ts.map +1 -1
- package/dist/tooltip.js +157 -249
- package/dist/typography-heading.cjs +1 -1
- package/dist/typography-heading.js +25 -61
- package/dist/typography-text.cjs +1 -1
- package/dist/typography-text.js +27 -57
- package/dist/typography.cjs +1 -1
- package/dist/typography.js +132 -340
- package/package.json +47 -47
- package/src/blocks/empty-state.tsx +34 -18
- package/src/blocks/input-list.tsx +14 -9
- package/src/blocks/sidebar.tsx +86 -31
- package/src/components/accordion.tsx +1 -1
- package/src/components/alert-dialog.tsx +4 -2
- package/src/components/badge.tsx +127 -15
- package/src/components/breadcrumb.tsx +1 -1
- package/src/components/button.tsx +8 -6
- package/src/components/calendar.tsx +155 -9
- package/src/components/card.tsx +63 -10
- package/src/components/carousel.tsx +4 -1
- package/src/components/chart.tsx +151 -17
- package/src/components/checkbox.tsx +1 -1
- package/src/components/collapsible.tsx +4 -1
- package/src/components/combobox.tsx +40 -7
- package/src/components/command.tsx +9 -10
- package/src/components/context-menu.tsx +4 -4
- package/src/components/data-table.tsx +619 -237
- package/src/components/date-picker.tsx +31 -4
- package/src/components/delta.tsx +217 -0
- package/src/components/description-list.tsx +445 -0
- package/src/components/drawer.tsx +5 -5
- package/src/components/dropdown-menu.tsx +4 -4
- package/src/components/field.tsx +36 -15
- package/src/components/global-layout.tsx +1 -1
- package/src/components/input-chip.tsx +51 -7
- package/src/components/input-group.tsx +1 -1
- package/src/components/input-password.tsx +15 -19
- package/src/components/input.tsx +10 -1
- package/src/components/list.tsx +695 -72
- package/src/components/logo-mark.tsx +345 -0
- package/src/components/map.tsx +18 -20
- package/src/components/media-viewer.tsx +908 -0
- package/src/components/multi-select-filter.tsx +255 -121
- package/src/components/navigation-menu.tsx +2 -2
- package/src/components/pagination.tsx +86 -26
- package/src/components/progress.tsx +91 -23
- package/src/components/rating.tsx +200 -74
- package/src/components/relative-date.tsx +19 -11
- package/src/components/resizable.tsx +86 -33
- package/src/components/result-count.tsx +253 -0
- package/src/components/scroll-area.tsx +31 -5
- package/src/components/select.tsx +2 -2
- package/src/components/sheet.tsx +14 -4
- package/src/components/single-select-filter.tsx +136 -41
- package/src/components/slider.tsx +2 -2
- package/src/components/status.tsx +162 -0
- package/src/components/switch.tsx +1 -1
- package/src/components/table.tsx +278 -106
- package/src/components/tabs.tsx +1 -0
- package/src/components/textarea.tsx +20 -2
- package/src/components/toggle.tsx +2 -2
- package/src/components/tooltip.tsx +11 -20
- package/src/hooks/use-filter-search-params.ts +302 -0
- package/src/index.ts +7 -0
- package/src/lib/compose-event-handlers.ts +14 -0
- package/src/lib/download-file.ts +61 -0
- package/src/lib/empty-chip.tsx +52 -0
- package/src/lib/field-aria.tsx +97 -0
- package/src/lib/image-file-info.ts +102 -0
- package/src/lib/media-viewer-content.tsx +1587 -0
- package/src/lib/media-viewer-internal.tsx +191 -0
- package/src/lib/media-viewer-motion.ts +120 -0
- package/src/lib/motion.ts +9 -0
- package/src/lib/table-internal.ts +74 -0
- package/src/lib/use-controllable.ts +43 -0
- package/src/lib/empty-chip.ts +0 -24
package/dist/data-table.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { Column, ColumnDef, ExpandedState, PaginationState, Row, RowData, RowSelectionState, SortingState, Table as TanStackTable } from '@tanstack/react-table';
|
|
2
2
|
import { InputGroup } from './input-group';
|
|
3
|
+
import { TableFrame, TableSize } from '../lib/table-internal';
|
|
3
4
|
/**
|
|
4
5
|
* DataTable — composable data table primitives built on TanStack Table.
|
|
5
6
|
*
|
|
@@ -26,6 +27,20 @@ declare module "@tanstack/react-table" {
|
|
|
26
27
|
width?: string;
|
|
27
28
|
/** Minimum column width (e.g., "100px", "8rem"). */
|
|
28
29
|
minWidth?: string;
|
|
30
|
+
/**
|
|
31
|
+
* This column starts a column group (DS-1195): its body cells draw a
|
|
32
|
+
* separator on their start edge. The header band stays clean.
|
|
33
|
+
*/
|
|
34
|
+
groupStart?: boolean;
|
|
35
|
+
/**
|
|
36
|
+
* Pin the column to the left edge while the table scrolls sideways
|
|
37
|
+
* (DS-1205). Pin ONE column — the first, normally; two pinned columns
|
|
38
|
+
* would stack on the same edge. The pinned header and body cells get an
|
|
39
|
+
* opaque background that follows the row state (selected, expanded,
|
|
40
|
+
* sub-row) and a divider on the pinned edge. Only has a visible effect
|
|
41
|
+
* when the table scrolls horizontally (`minWidth`).
|
|
42
|
+
*/
|
|
43
|
+
pinned?: "left";
|
|
29
44
|
}
|
|
30
45
|
}
|
|
31
46
|
/**
|
|
@@ -88,7 +103,11 @@ export interface UseDataTableOptions<TData> {
|
|
|
88
103
|
enableRowSelection?: boolean | ((row: Row<TData>) => boolean);
|
|
89
104
|
/** Enable client-side pagination. @default false */
|
|
90
105
|
enablePagination?: boolean;
|
|
91
|
-
/**
|
|
106
|
+
/**
|
|
107
|
+
* Initial page size when pagination is enabled. The Filtering pattern's
|
|
108
|
+
* 20 rows a page; pass 10 when two tables share a page.
|
|
109
|
+
* @default 20
|
|
110
|
+
*/
|
|
92
111
|
pageSize?: number;
|
|
93
112
|
/**
|
|
94
113
|
* Skip client-side sorting — the server pre-sorts `data`.
|
|
@@ -209,6 +228,36 @@ export interface DataTableProps<TData> {
|
|
|
209
228
|
trackingEl?: string;
|
|
210
229
|
/** Analytics label. */
|
|
211
230
|
trackingLabel?: string;
|
|
231
|
+
/**
|
|
232
|
+
* Row density, passed through to the underlying `Table` (DS-556):
|
|
233
|
+
* `default` rows are `h-12` (48px) under `h-12` (48px) column headers;
|
|
234
|
+
* `sm` rows are `h-10` (40px) under `h-9` (36px) headers. Rows still grow
|
|
235
|
+
* with multi-line content, and a row hosting an expander or icon-only
|
|
236
|
+
* action button (`size-9` + the cell's `p-2`) measures 52px at either size.
|
|
237
|
+
* Use `sm` for dense tables inside cards, dialogs and side panels.
|
|
238
|
+
* @default "default"
|
|
239
|
+
*/
|
|
240
|
+
size?: TableSize;
|
|
241
|
+
/**
|
|
242
|
+
* Where the frame comes from (DS-1103), passed through to the `Table`.
|
|
243
|
+
* - `"own"` — the view draws its own 1px `border-border`, `rounded-md`
|
|
244
|
+
* frame; cells keep `p-2`. The standalone table.
|
|
245
|
+
* - `"container"` — no border, square corners, and the first/last cell of
|
|
246
|
+
* every row — heads, cells, footer, empty row, skeleton rows — pads to the
|
|
247
|
+
* container's gutter, `var(--content-inset)` (24px in a `data` Card).
|
|
248
|
+
* Use inside `CardContent flush`, a Sheet or a dialog body so the page
|
|
249
|
+
* shows one box and the columns line up with the title; no className
|
|
250
|
+
* override needed. The view stays a focusable scroll region either way.
|
|
251
|
+
* @default "own"
|
|
252
|
+
*/
|
|
253
|
+
frame?: TableFrame;
|
|
254
|
+
/**
|
|
255
|
+
* Faint rule under every body row but the last (DS-1195), passed through to
|
|
256
|
+
* the `Table`. For long, dense tables with many numeric or grouped columns;
|
|
257
|
+
* leave off for short or simple tables.
|
|
258
|
+
* @default false
|
|
259
|
+
*/
|
|
260
|
+
rowDividers?: boolean;
|
|
212
261
|
/** Show skeleton rows instead of data while loading async data. */
|
|
213
262
|
isLoading?: boolean;
|
|
214
263
|
/**
|
|
@@ -237,24 +286,45 @@ export interface DataTableProps<TData> {
|
|
|
237
286
|
* @default "Loading results…"
|
|
238
287
|
*/
|
|
239
288
|
refetchingLabel?: string;
|
|
289
|
+
/**
|
|
290
|
+
* What the polite live region announces to screen readers while
|
|
291
|
+
* `isLoading` is set and the rows are skeletons.
|
|
292
|
+
* @default "Loading data…"
|
|
293
|
+
*/
|
|
294
|
+
loadingLabel?: string;
|
|
240
295
|
/** Number of skeleton rows when loading. Falls back to the table's page size, then 10. */
|
|
241
296
|
skeletonRowCount?: number;
|
|
242
297
|
/**
|
|
243
|
-
* What the table shows in place of rows when it has none
|
|
298
|
+
* What the table shows in place of rows when it has none — rendered through
|
|
299
|
+
* `TableEmpty`, announced politely either way.
|
|
244
300
|
*
|
|
245
|
-
*
|
|
246
|
-
*
|
|
247
|
-
*
|
|
301
|
+
* Left unset, the table renders the designed no-results state (Figma
|
|
302
|
+
* `No results`): an `<EmptyState size="md">` with the `SearchX` icon, the
|
|
303
|
+
* global-filter query echoed in the title and one line of description, no
|
|
304
|
+
* action — the reader wants the outcome of their own query, not a CTA.
|
|
305
|
+
* Translate it with `noResultsTitle` / `noResultsDescription`.
|
|
248
306
|
*
|
|
249
|
-
* Pass
|
|
250
|
-
*
|
|
251
|
-
*
|
|
252
|
-
*
|
|
253
|
-
*
|
|
254
|
-
* a
|
|
255
|
-
* @default
|
|
307
|
+
* Pass your own `<EmptyState size="md">` for an empty collection (Figma
|
|
308
|
+
* `Empty`): a title, one line and the setup CTA. The cell brings the
|
|
309
|
+
* block's breathing room with it — do not wrap it in a padding element.
|
|
310
|
+
* The block sits in the same live region, so keep it to the standard
|
|
311
|
+
* anatomy — its title and one line are worth hearing; a wall of copy is
|
|
312
|
+
* not. A string renders as a one-line message in an ordinary row.
|
|
313
|
+
* @default the no-results EmptyState
|
|
256
314
|
*/
|
|
257
315
|
noResultsMessage?: React.ReactNode;
|
|
316
|
+
/**
|
|
317
|
+
* Title of the default no-results state. `{query}` is replaced with the
|
|
318
|
+
* current global-filter value; the plain default is used when there is no
|
|
319
|
+
* query (column filters only).
|
|
320
|
+
* @default "No results for \"{query}\"" with a query, else "No results"
|
|
321
|
+
*/
|
|
322
|
+
noResultsTitle?: string;
|
|
323
|
+
/**
|
|
324
|
+
* The one line under the default no-results title.
|
|
325
|
+
* @default "Try a different search, or clear the filters."
|
|
326
|
+
*/
|
|
327
|
+
noResultsDescription?: string;
|
|
258
328
|
/**
|
|
259
329
|
* Pin the `<thead>` to the top of the component's own scroll container
|
|
260
330
|
* (the outer wrapper) so column headers remain visible while the rows
|
|
@@ -271,9 +341,21 @@ export interface DataTableProps<TData> {
|
|
|
271
341
|
* intent is the signal. For the same reason, don't set it on a table
|
|
272
342
|
* with no height bound: the wrapper never scrolls, and the region
|
|
273
343
|
* becomes an inert tab stop.
|
|
344
|
+
*
|
|
345
|
+
* `"page"` pins the headings to the page's scroll instead, with no height
|
|
346
|
+
* bound and no inner scroll box (DS-1215) — for long report tables that
|
|
347
|
+
* scroll with the page. The `<thead>` sticks at `--content-sticky-top`,
|
|
348
|
+
* which a `CardHeader sticky` publishes with its live height, so inside
|
|
349
|
+
* such a card the headings stick directly beneath the card header; with
|
|
350
|
+
* no sticky card header they stick at the top of the scrolling page,
|
|
351
|
+
* Sheet or Dialog. The headings stick while the table fits its container;
|
|
352
|
+
* once it is wider (`minWidth`, column `meta.minWidth`, wide content) the
|
|
353
|
+
* wrapper becomes the horizontal scroll region, labelled by
|
|
354
|
+
* `scrollRegionLabel`, and the headings scroll with the page — a sideways
|
|
355
|
+
* scroll box would otherwise trap them.
|
|
274
356
|
* @default false
|
|
275
357
|
*/
|
|
276
|
-
stickyHeader?: boolean;
|
|
358
|
+
stickyHeader?: boolean | "page";
|
|
277
359
|
/**
|
|
278
360
|
* Additional class name for the outer wrapper — the component's single
|
|
279
361
|
* scroll container for both axes. Height bounds belong here: `max-h-*`
|
|
@@ -358,46 +440,13 @@ export interface DataTableProps<TData> {
|
|
|
358
440
|
renderExpandedContent?: (row: Row<TData>) => React.ReactNode;
|
|
359
441
|
}
|
|
360
442
|
/**
|
|
361
|
-
* Generic DataTable renderer.
|
|
362
|
-
*
|
|
363
|
-
*
|
|
364
|
-
*
|
|
365
|
-
*
|
|
366
|
-
*
|
|
367
|
-
* **Compose as one slot.** The table and its companions — `DataTableToolbar`
|
|
368
|
-
* rows (search, filters, pagination, counters), `DataTableBulkActions` — form
|
|
369
|
-
* a single unit. When the parent lays out its children with a gap (e.g.
|
|
370
|
-
* `DialogContent` with `gap-8`, a Card body, a page section), wrap the whole
|
|
371
|
-
* unit in one flex-column container so the parent's gap applies around the
|
|
372
|
-
* table block, not between the toolbars and the table. Vertical rhythm inside
|
|
373
|
-
* the block comes from the toolbars' built-in padding — don't add custom
|
|
374
|
-
* margins between the parts.
|
|
375
|
-
*
|
|
376
|
-
* @example
|
|
377
|
-
* const table = useDataTable({ columns, data, enableSorting: true });
|
|
378
|
-
* return <DataTable table={table} dataHook="my-table" />;
|
|
379
|
-
*
|
|
380
|
-
* @example
|
|
381
|
-
* // One slot inside a gapped parent (dialog, card, page section).
|
|
382
|
-
* // min-h-0/flex-1 keep the table scrollable in height-capped parents;
|
|
383
|
-
* // the outer wrapper is the scroll container, so stickyHeader keeps the
|
|
384
|
-
* // column headers visible while the rows scroll (DS-912).
|
|
385
|
-
* <div className="flex min-h-0 flex-1 flex-col">
|
|
386
|
-
* <DataTableToolbar dataHook="toolbar-top">
|
|
387
|
-
* <DataTableToolbarLeft>{heading or search}</DataTableToolbarLeft>
|
|
388
|
-
* <DataTableToolbarRight>{filters}</DataTableToolbarRight>
|
|
389
|
-
* </DataTableToolbar>
|
|
390
|
-
* <DataTable table={table} dataHook="my-table" stickyHeader className="min-h-0 flex-1" />
|
|
391
|
-
* <DataTableToolbar dataHook="toolbar-bottom">
|
|
392
|
-
* <DataTableToolbarLeft>{selection counter}</DataTableToolbarLeft>
|
|
393
|
-
* <DataTableToolbarRight>{pagination}</DataTableToolbarRight>
|
|
394
|
-
* </DataTableToolbar>
|
|
395
|
-
* </div>
|
|
443
|
+
* Generic DataTable renderer — see `DataTableInner` for the full contract.
|
|
444
|
+
* `ref` is the view wrapper (`data-slot="data-table-view"`), the component's
|
|
445
|
+
* scroll container: scroll it back to the top after a page change, or
|
|
446
|
+
* `scrollIntoView` it. Cast keeps the `TData` generic through `forwardRef`
|
|
447
|
+
* (the Tabs / CommandVirtualList idiom).
|
|
396
448
|
*/
|
|
397
|
-
|
|
398
|
-
export declare namespace DataTable {
|
|
399
|
-
var displayName: string;
|
|
400
|
-
}
|
|
449
|
+
declare const DataTable: <TData>(props: DataTableProps<TData> & React.RefAttributes<HTMLDivElement>) => React.ReactElement | null;
|
|
401
450
|
/**
|
|
402
451
|
* Props for `VirtualizedDataTable`.
|
|
403
452
|
*
|
|
@@ -411,7 +460,14 @@ export declare namespace DataTable {
|
|
|
411
460
|
* sub-rows are real row-model rows — as do `getRowClassName` and the
|
|
412
461
|
* addressable row attributes.
|
|
413
462
|
*/
|
|
414
|
-
export interface VirtualizedDataTableProps<TData> extends Omit<DataTableProps<TData>, "renderExpandedContent"> {
|
|
463
|
+
export interface VirtualizedDataTableProps<TData> extends Omit<DataTableProps<TData>, "renderExpandedContent" | "stickyHeader"> {
|
|
464
|
+
/**
|
|
465
|
+
* Pin the `<thead>` to the top of the virtualized viewport so column
|
|
466
|
+
* headers stay visible while the rows scroll. The viewport is always
|
|
467
|
+
* bounded, so there is no `"page"` mode here.
|
|
468
|
+
* @default false
|
|
469
|
+
*/
|
|
470
|
+
stickyHeader?: boolean;
|
|
415
471
|
/**
|
|
416
472
|
* Height of the scroll container in pixels. Required — virtualization
|
|
417
473
|
* needs a bounded viewport. Pass a CSS value via `className` instead
|
|
@@ -421,8 +477,10 @@ export interface VirtualizedDataTableProps<TData> extends Omit<DataTableProps<TD
|
|
|
421
477
|
height?: number;
|
|
422
478
|
/**
|
|
423
479
|
* Estimated height of a single row in pixels. The virtualizer uses this
|
|
424
|
-
* for initial layout before measuring real DOM nodes.
|
|
425
|
-
*
|
|
480
|
+
* for initial layout before measuring real DOM nodes. Defaults to the
|
|
481
|
+
* table's row min-height for its `size` — 48 for `default`, 40 for `sm` —
|
|
482
|
+
* so only tables whose rows routinely wrap need to set it.
|
|
483
|
+
* @default 48 (`size="default"`) | 40 (`size="sm"`)
|
|
426
484
|
*/
|
|
427
485
|
estimateSize?: number;
|
|
428
486
|
/**
|
|
@@ -433,33 +491,10 @@ export interface VirtualizedDataTableProps<TData> extends Omit<DataTableProps<TD
|
|
|
433
491
|
overscan?: number;
|
|
434
492
|
}
|
|
435
493
|
/**
|
|
436
|
-
* Virtualized
|
|
437
|
-
*
|
|
438
|
-
* Drop-in alternative to `DataTable` that renders only the rows visible
|
|
439
|
-
* in the scroll viewport (plus `overscan` extras). Uses
|
|
440
|
-
* `@tanstack/react-virtual` internally.
|
|
441
|
-
*
|
|
442
|
-
* @example
|
|
443
|
-
* const table = useDataTable({
|
|
444
|
-
* columns,
|
|
445
|
-
* data: largeDataset, // 10 000+ rows
|
|
446
|
-
* enableSorting: true,
|
|
447
|
-
* manualPagination: true, // skip client pagination
|
|
448
|
-
* });
|
|
449
|
-
*
|
|
450
|
-
* return (
|
|
451
|
-
* <VirtualizedDataTable
|
|
452
|
-
* table={table}
|
|
453
|
-
* dataHook="big-table"
|
|
454
|
-
* height={600}
|
|
455
|
-
* estimateSize={48}
|
|
456
|
-
* />
|
|
457
|
-
* );
|
|
494
|
+
* Virtualized renderer — see `VirtualizedDataTableInner` for the contract.
|
|
495
|
+
* `ref` is the view wrapper, the scroll container the virtualizer drives.
|
|
458
496
|
*/
|
|
459
|
-
|
|
460
|
-
export declare namespace VirtualizedDataTable {
|
|
461
|
-
var displayName: string;
|
|
462
|
-
}
|
|
497
|
+
declare const VirtualizedDataTable: <TData>(props: VirtualizedDataTableProps<TData> & React.RefAttributes<HTMLDivElement>) => React.ReactElement | null;
|
|
463
498
|
/**
|
|
464
499
|
* Props for `DataTableColumnHeader` — a sortable column header with
|
|
465
500
|
* directional sort indicators. Matches the Figma TableHead/Button variant.
|
|
@@ -531,7 +566,7 @@ export interface DataTableColumnHeaderProps<TData, TValue> extends React.HTMLAtt
|
|
|
531
566
|
* so tables that do not opt in keep first-click-ascending. Once a column is
|
|
532
567
|
* sorted, clicking again reverses the direction as before.
|
|
533
568
|
*/
|
|
534
|
-
export declare function DataTableColumnHeader<TData, TValue>({ column, title, className, dataHook, trackingEl, trackingLabel, align, getSortLabel, loading, }: DataTableColumnHeaderProps<TData, TValue>):
|
|
569
|
+
export declare function DataTableColumnHeader<TData, TValue>({ column, title, className, dataHook, trackingEl, trackingLabel, align, getSortLabel, loading, }: DataTableColumnHeaderProps<TData, TValue>): React.JSX.Element;
|
|
535
570
|
export declare namespace DataTableColumnHeader {
|
|
536
571
|
var displayName: string;
|
|
537
572
|
}
|
|
@@ -551,6 +586,17 @@ export interface DataTableSearchProps<TData> extends Omit<React.ComponentPropsWi
|
|
|
551
586
|
placeholder?: string;
|
|
552
587
|
/** Accessible label for the clear button. @default "Clear search" */
|
|
553
588
|
clearSearchAriaLabel?: string;
|
|
589
|
+
/**
|
|
590
|
+
* Disables the search input. Use during initial data load when there is
|
|
591
|
+
* nothing to search yet — the input cannot be typed in, the clear button
|
|
592
|
+
* hides, and the group dims via `has-[:disabled]:opacity-50`. Any pending
|
|
593
|
+
* debounced push is discarded.
|
|
594
|
+
*
|
|
595
|
+
* This is for *initial load*, not refetch — during a search-triggered
|
|
596
|
+
* refetch, use `loading` instead (the input stays editable).
|
|
597
|
+
* @default false
|
|
598
|
+
*/
|
|
599
|
+
disabled?: boolean;
|
|
554
600
|
/**
|
|
555
601
|
* Search refetch in flight — the leading search icon swaps to a spinner
|
|
556
602
|
* and the group sets `aria-busy`. The input stays fully editable, and the
|
|
@@ -587,11 +633,52 @@ export interface DataTableSearchProps<TData> extends Omit<React.ComponentPropsWi
|
|
|
587
633
|
* only updates after `debounceMs` of inactivity. Client-side filtering stays
|
|
588
634
|
* synchronous: rows narrow per keystroke, exactly as the Filtering pattern
|
|
589
635
|
* promises ("debounce the request, never the input").
|
|
636
|
+
*
|
|
637
|
+
* Accepts a `ref` that resolves to the inner `<input>` element, so consumers
|
|
638
|
+
* can call `.focus()` without querying the component's markup.
|
|
590
639
|
*/
|
|
591
|
-
export declare
|
|
592
|
-
|
|
593
|
-
|
|
640
|
+
export declare const DataTableSearch: <TData>(props: DataTableSearchProps<TData> & React.RefAttributes<HTMLInputElement>) => React.ReactElement;
|
|
641
|
+
/** Pagination info returned by `useDataTablePagination`. */
|
|
642
|
+
interface DataTablePaginationInfo {
|
|
643
|
+
/** Current 0-based page index. */
|
|
644
|
+
pageIndex: number;
|
|
645
|
+
/** Number of rows per page. */
|
|
646
|
+
pageSize: number;
|
|
647
|
+
/** Total rows across all pages. */
|
|
648
|
+
totalRows: number;
|
|
649
|
+
/** Total page count. */
|
|
650
|
+
totalPages: number;
|
|
651
|
+
/** First visible row (1-based, 0 when empty). */
|
|
652
|
+
startRow: number;
|
|
653
|
+
/** Last visible row. */
|
|
654
|
+
endRow: number;
|
|
655
|
+
/** Current page (1-based). */
|
|
656
|
+
currentPage: number;
|
|
657
|
+
/** Whether a previous page exists. */
|
|
658
|
+
canPrev: boolean;
|
|
659
|
+
/** Whether a next page exists. */
|
|
660
|
+
canNext: boolean;
|
|
661
|
+
/** Navigate to a 1-based page number. */
|
|
662
|
+
goToPage: (page: number) => void;
|
|
663
|
+
/** Navigate to the next page. */
|
|
664
|
+
nextPage: () => void;
|
|
665
|
+
/** Navigate to the previous page. */
|
|
666
|
+
previousPage: () => void;
|
|
667
|
+
/** Set page size (resets to page 1). */
|
|
668
|
+
setPageSize: (size: number) => void;
|
|
594
669
|
}
|
|
670
|
+
/**
|
|
671
|
+
* Derives pagination state from a TanStack Table instance.
|
|
672
|
+
*
|
|
673
|
+
* Use when you need pagination metadata in a custom location (toolbar header,
|
|
674
|
+
* sticky footer) without rendering `DataTablePagination`. The component itself
|
|
675
|
+
* is built on this hook.
|
|
676
|
+
*
|
|
677
|
+
* @example
|
|
678
|
+
* const { startRow, endRow, totalRows, canNext, nextPage } = useDataTablePagination(table);
|
|
679
|
+
*/
|
|
680
|
+
declare function useDataTablePagination<TData>(table: TanStackTable<TData>): DataTablePaginationInfo;
|
|
681
|
+
/** The English default: compact "start – end of total", nothing when empty. */
|
|
595
682
|
/** Info passed to row-count render functions. */
|
|
596
683
|
export interface RowCountRenderInfo {
|
|
597
684
|
/** First visible row (1-based, 0 when empty). */
|
|
@@ -607,25 +694,51 @@ export interface RowCountRenderInfo {
|
|
|
607
694
|
}
|
|
608
695
|
export interface DataTablePaginationRowCountProps {
|
|
609
696
|
/**
|
|
610
|
-
*
|
|
611
|
-
*
|
|
612
|
-
*
|
|
697
|
+
* Row-count text. Supports the `{from}`, `{to}` and `{total}`
|
|
698
|
+
* placeholders — name the records in the product's words
|
|
699
|
+
* ("{from} to {to} of {total} locations"). Passed to
|
|
700
|
+
* `ResultCount` as its `rangeLabel`.
|
|
701
|
+
* @default "{from} to {to} of {total} results"
|
|
702
|
+
*/
|
|
703
|
+
label?: string;
|
|
704
|
+
/**
|
|
705
|
+
* `label` for a total of exactly 1 ("1 to 1 of 1 location"). Falls back to
|
|
706
|
+
* `label`. Passed to `ResultCount` as its `rangeLabelOne`.
|
|
707
|
+
* @default "{from} to {to} of {total} result"
|
|
708
|
+
*/
|
|
709
|
+
labelOne?: string;
|
|
710
|
+
/**
|
|
711
|
+
* Screen-reader-only text while the table is empty. The visible count
|
|
712
|
+
* hides at zero — the empty state says it — but the live region stays and
|
|
713
|
+
* announces the result. Passed to `ResultCount` as its `emptyLabel`.
|
|
714
|
+
* @default "No results"
|
|
715
|
+
*/
|
|
716
|
+
emptyLabel?: string;
|
|
717
|
+
/**
|
|
718
|
+
* Render the row-count text yourself. Receives pagination numbers; you
|
|
719
|
+
* control wording, pluralization, and order. Return `null` to hide. The
|
|
720
|
+
* node renders as plain text — prefer `label` so the count stays the
|
|
721
|
+
* `ResultCount` live region.
|
|
613
722
|
*/
|
|
614
723
|
renderText?: (info: RowCountRenderInfo) => React.ReactNode;
|
|
724
|
+
/** Data hook for the count. @default "{paginationDataHook}-row-count" */
|
|
725
|
+
dataHook?: string;
|
|
615
726
|
/** Additional class name. */
|
|
616
727
|
className?: string;
|
|
617
728
|
}
|
|
618
729
|
/**
|
|
619
|
-
* Row-count label for `DataTablePagination
|
|
730
|
+
* Row-count label for `DataTablePagination` — a `ResultCount` in its range
|
|
731
|
+
* form ("1 to 20 of 45 results"), so a paged table and a filtered
|
|
732
|
+
* list share one count component and one wording. At zero rows the visible
|
|
733
|
+
* count hides (the empty state says it) but the live region stays, with the
|
|
734
|
+
* screen-reader-only `emptyLabel`, so the empty result is announced.
|
|
620
735
|
*
|
|
621
|
-
* Renders "start–end of total" by default. Pass `renderText` for i18n-friendly
|
|
622
|
-
* custom text with full control over wording, pluralization, and order.
|
|
623
736
|
* Renders nothing below the `sm` viewport breakpoint — on small screens the
|
|
624
737
|
* label is removed so the page buttons get the full width (DS-998).
|
|
625
738
|
*
|
|
626
739
|
* Must be rendered inside `<DataTablePagination>`.
|
|
627
740
|
*/
|
|
628
|
-
declare function DataTablePaginationRowCount({ renderText, className, }: DataTablePaginationRowCountProps):
|
|
741
|
+
declare function DataTablePaginationRowCount({ label, labelOne, emptyLabel, renderText, dataHook, className, }: DataTablePaginationRowCountProps): React.JSX.Element | null;
|
|
629
742
|
declare namespace DataTablePaginationRowCount {
|
|
630
743
|
var displayName: string;
|
|
631
744
|
}
|
|
@@ -645,7 +758,7 @@ export interface DataTablePaginationNavProps {
|
|
|
645
758
|
* to navigate. Below the `sm` viewport breakpoint the buttons centre in the
|
|
646
759
|
* available width (DS-998). Must be rendered inside `<DataTablePagination>`.
|
|
647
760
|
*/
|
|
648
|
-
declare function DataTablePaginationNav({ ariaLabel, dataHook, className, }: DataTablePaginationNavProps):
|
|
761
|
+
declare function DataTablePaginationNav({ ariaLabel, dataHook, className, }: DataTablePaginationNavProps): React.JSX.Element | null;
|
|
649
762
|
declare namespace DataTablePaginationNav {
|
|
650
763
|
var displayName: string;
|
|
651
764
|
}
|
|
@@ -674,10 +787,36 @@ export interface DataTablePaginationProps<TData> {
|
|
|
674
787
|
*/
|
|
675
788
|
showRowCount?: boolean;
|
|
676
789
|
/**
|
|
677
|
-
*
|
|
678
|
-
*
|
|
790
|
+
* Row-count text in the default layout. Supports the `{from}`, `{to}` and
|
|
791
|
+
* `{total}` placeholders — name the records in the product's words
|
|
792
|
+
* ("{from} to {to} of {total} locations"). i18next's `{{from}}`
|
|
793
|
+
* form is accepted too, so `rowCountLabel={t("pagination.caption")}` works
|
|
794
|
+
* with the untranslated string.
|
|
795
|
+
* Ignored when `children` are provided — use `DataTablePaginationRowCount` instead.
|
|
796
|
+
* @default "{from} to {to} of {total} results"
|
|
797
|
+
*/
|
|
798
|
+
rowCountLabel?: string;
|
|
799
|
+
/**
|
|
800
|
+
* `rowCountLabel` for a total of exactly 1 ("1 to 1 of 1 location"). Falls
|
|
801
|
+
* back to `rowCountLabel`; pair with i18next's `_one` key.
|
|
802
|
+
* Ignored when `children` are provided — use `DataTablePaginationRowCount` instead.
|
|
803
|
+
* @default "{from} to {to} of {total} result"
|
|
804
|
+
*/
|
|
805
|
+
rowCountLabelOne?: string;
|
|
806
|
+
/**
|
|
807
|
+
* Screen-reader-only row count while the table is empty. The visible count
|
|
808
|
+
* hides at zero (the empty state says it) but the live region stays and
|
|
809
|
+
* announces the result; nothing is visible and the bar keeps no height.
|
|
810
|
+
* Ignored when `children` are provided — use `DataTablePaginationRowCount` instead.
|
|
811
|
+
* @default "No results"
|
|
812
|
+
*/
|
|
813
|
+
rowCountEmptyLabel?: string;
|
|
814
|
+
/**
|
|
815
|
+
* Render the row-count text yourself. Receives pagination numbers; you
|
|
816
|
+
* control wording, pluralization, and order. Return `null` to hide. The
|
|
817
|
+
* node renders as plain text — prefer `rowCountLabel` so the count stays
|
|
818
|
+
* the `ResultCount` live region.
|
|
679
819
|
* Ignored when `children` are provided — use `DataTablePaginationRowCount` instead.
|
|
680
|
-
* @default Renders "{startRow}-{endRow} of {totalRows}" or nothing when empty.
|
|
681
820
|
*/
|
|
682
821
|
renderRowCount?: ((info: RowCountRenderInfo) => React.ReactNode) | null;
|
|
683
822
|
/** Analytics element identifier. */
|
|
@@ -699,14 +838,16 @@ export interface DataTablePaginationProps<TData> {
|
|
|
699
838
|
/**
|
|
700
839
|
* Pagination controls for a DataTable.
|
|
701
840
|
*
|
|
702
|
-
* **Default mode** (no children): renders previous/next/page links and
|
|
703
|
-
*
|
|
704
|
-
* i18n-friendly text.
|
|
841
|
+
* **Default mode** (no children): renders previous/next/page links and the
|
|
842
|
+
* row count — a `ResultCount` in its range form, "1 to 20 of 45
|
|
843
|
+
* results". Use `rowCountLabel` for i18n-friendly text.
|
|
705
844
|
*
|
|
706
845
|
* The navigation hides itself when there is at most one page (the row count
|
|
707
|
-
* stays, keeping the bar informative and the layout stable).
|
|
708
|
-
* row count
|
|
709
|
-
*
|
|
846
|
+
* stays, keeping the bar informative and the layout stable). At zero rows the
|
|
847
|
+
* row count keeps its live region mounted with nothing visible, so the empty
|
|
848
|
+
* result is announced; only with the row count off (`showRowCount={false}`,
|
|
849
|
+
* `renderRowCount` null or returning null, or below `sm`) and a single page
|
|
850
|
+
* does the component render nothing — no consumer render gate needed.
|
|
710
851
|
*
|
|
711
852
|
* **Responsive behaviour:** below the `sm` viewport breakpoint the row-count
|
|
712
853
|
* label is removed and the page buttons centre in the available width — the
|
|
@@ -735,9 +876,7 @@ export interface DataTablePaginationProps<TData> {
|
|
|
735
876
|
* <DataTablePagination
|
|
736
877
|
* table={table}
|
|
737
878
|
* dataHook="pagination"
|
|
738
|
-
*
|
|
739
|
-
* t('pagination.caption', { from: startRow, to: endRow, total: totalRows })
|
|
740
|
-
* }
|
|
879
|
+
* rowCountLabel={t('pagination.caption')} // "{from} to {to} of {total} locations"
|
|
741
880
|
* />
|
|
742
881
|
*
|
|
743
882
|
* @example
|
|
@@ -747,7 +886,7 @@ export interface DataTablePaginationProps<TData> {
|
|
|
747
886
|
* <DataTablePaginationNav />
|
|
748
887
|
* </DataTablePagination>
|
|
749
888
|
*/
|
|
750
|
-
export declare function DataTablePagination<TData>({ table, dataHook, showRowCount, renderRowCount, trackingEl, trackingLabel, className, ariaLabel, children, }: DataTablePaginationProps<TData>):
|
|
889
|
+
export declare function DataTablePagination<TData>({ table, dataHook, showRowCount, rowCountLabel, rowCountLabelOne, rowCountEmptyLabel, renderRowCount, trackingEl, trackingLabel, className, ariaLabel, children, }: DataTablePaginationProps<TData>): React.JSX.Element | null;
|
|
751
890
|
export declare namespace DataTablePagination {
|
|
752
891
|
var displayName: string;
|
|
753
892
|
}
|
|
@@ -768,15 +907,17 @@ export interface DataTableSelectAllCheckboxProps<TData> {
|
|
|
768
907
|
selectAllAriaLabel?: string;
|
|
769
908
|
}
|
|
770
909
|
/**
|
|
771
|
-
* Header checkbox for selecting all visible page rows.
|
|
772
|
-
*
|
|
910
|
+
* Header checkbox for selecting all visible page rows. Checked only when
|
|
911
|
+
* every page row is selected; a partial selection shows it unchecked — the
|
|
912
|
+
* DS checkbox has no indeterminate state (Active | Inactive, like the Figma
|
|
913
|
+
* set), and clicking it still selects or clears every page row.
|
|
773
914
|
*
|
|
774
915
|
* While the surrounding `DataTable` is `refetching`, the checkbox is
|
|
775
916
|
* `aria-disabled` and toggles are ignored (visually unchanged, still exposed
|
|
776
917
|
* to screen readers so the select-all `<th>` never reads as empty): the rows
|
|
777
918
|
* it would select are stale and about to be replaced (DS-916).
|
|
778
919
|
*/
|
|
779
|
-
export declare function DataTableSelectAllCheckbox<TData>({ table, dataHook, trackingEl, trackingLabel, selectAllAriaLabel, }: DataTableSelectAllCheckboxProps<TData>):
|
|
920
|
+
export declare function DataTableSelectAllCheckbox<TData>({ table, dataHook, trackingEl, trackingLabel, selectAllAriaLabel, }: DataTableSelectAllCheckboxProps<TData>): React.JSX.Element;
|
|
780
921
|
export declare namespace DataTableSelectAllCheckbox {
|
|
781
922
|
var displayName: string;
|
|
782
923
|
}
|
|
@@ -803,7 +944,7 @@ export interface DataTableSelectRowCheckboxProps<TData> {
|
|
|
803
944
|
* to screen readers): the row it would select is stale and about to be
|
|
804
945
|
* replaced (DS-916).
|
|
805
946
|
*/
|
|
806
|
-
export declare function DataTableSelectRowCheckbox<TData>({ row, dataHook, trackingEl, trackingLabel, selectRowAriaLabel, }: DataTableSelectRowCheckboxProps<TData>):
|
|
947
|
+
export declare function DataTableSelectRowCheckbox<TData>({ row, dataHook, trackingEl, trackingLabel, selectRowAriaLabel, }: DataTableSelectRowCheckboxProps<TData>): React.JSX.Element;
|
|
807
948
|
export declare namespace DataTableSelectRowCheckbox {
|
|
808
949
|
var displayName: string;
|
|
809
950
|
}
|
|
@@ -852,7 +993,7 @@ export interface DataTableExpandRowButtonProps<TData> {
|
|
|
852
993
|
* `enableExpanding` on `useDataTable` (with `getSubRows` for sub-rows or
|
|
853
994
|
* `getRowCanExpand` for the detail-panel pattern).
|
|
854
995
|
*/
|
|
855
|
-
export declare function DataTableExpandRowButton<TData>({ row, rowName, dataHook, trackingEl, trackingLabel, expandLabel, collapseLabel, className, }: DataTableExpandRowButtonProps<TData>):
|
|
996
|
+
export declare function DataTableExpandRowButton<TData>({ row, rowName, dataHook, trackingEl, trackingLabel, expandLabel, collapseLabel, className, }: DataTableExpandRowButtonProps<TData>): React.JSX.Element;
|
|
856
997
|
export declare namespace DataTableExpandRowButton {
|
|
857
998
|
var displayName: string;
|
|
858
999
|
}
|
|
@@ -891,7 +1032,7 @@ export interface DataTableExpandedSkeletonProps {
|
|
|
891
1032
|
* : <DataTableExpandedSkeleton fields={4} />
|
|
892
1033
|
* }
|
|
893
1034
|
*/
|
|
894
|
-
export declare function DataTableExpandedSkeleton({ fields, loadingLabel, dataHook, className, }: DataTableExpandedSkeletonProps):
|
|
1035
|
+
export declare function DataTableExpandedSkeleton({ fields, loadingLabel, dataHook, className, }: DataTableExpandedSkeletonProps): React.JSX.Element;
|
|
895
1036
|
export declare namespace DataTableExpandedSkeleton {
|
|
896
1037
|
var displayName: string;
|
|
897
1038
|
}
|
|
@@ -977,8 +1118,6 @@ export interface DataTableBulkActionsProps<TData> {
|
|
|
977
1118
|
* <DataTableToolbar dataHook="toolbar">
|
|
978
1119
|
* <DataTableToolbarLeft>
|
|
979
1120
|
* <DataTableSearch table={table} dataHook="search" />
|
|
980
|
-
* </DataTableToolbarLeft>
|
|
981
|
-
* <DataTableToolbarRight>
|
|
982
1121
|
* <DataTableBulkActions table={table} dataHook="bulk-actions">
|
|
983
1122
|
* <DataTableBulkActionsSummary />
|
|
984
1123
|
* <DataTableBulkActionsActions>
|
|
@@ -987,10 +1126,13 @@ export interface DataTableBulkActionsProps<TData> {
|
|
|
987
1126
|
* </Button>
|
|
988
1127
|
* </DataTableBulkActionsActions>
|
|
989
1128
|
* </DataTableBulkActions>
|
|
1129
|
+
* </DataTableToolbarLeft>
|
|
1130
|
+
* <DataTableToolbarRight>
|
|
1131
|
+
* <DataTablePagination table={table} dataHook="pagination" />
|
|
990
1132
|
* </DataTableToolbarRight>
|
|
991
1133
|
* </DataTableToolbar>
|
|
992
1134
|
*/
|
|
993
|
-
export declare function DataTableBulkActions<TData>({ table, dataHook, trackingEl, trackingLabel, className, children, refetching, }: DataTableBulkActionsProps<TData>):
|
|
1135
|
+
export declare function DataTableBulkActions<TData>({ table, dataHook, trackingEl, trackingLabel, className, children, refetching, }: DataTableBulkActionsProps<TData>): React.JSX.Element | null;
|
|
994
1136
|
export declare namespace DataTableBulkActions {
|
|
995
1137
|
var displayName: string;
|
|
996
1138
|
}
|
|
@@ -1036,7 +1178,7 @@ export interface DataTableBulkActionsSummaryProps {
|
|
|
1036
1178
|
* }
|
|
1037
1179
|
* </DataTableBulkActionsSummary>
|
|
1038
1180
|
*/
|
|
1039
|
-
export declare function DataTableBulkActionsSummary({ dataHook, className, children, }: DataTableBulkActionsSummaryProps):
|
|
1181
|
+
export declare function DataTableBulkActionsSummary({ dataHook, className, children, }: DataTableBulkActionsSummaryProps): React.JSX.Element;
|
|
1040
1182
|
export declare namespace DataTableBulkActionsSummary {
|
|
1041
1183
|
var displayName: string;
|
|
1042
1184
|
}
|
|
@@ -1066,7 +1208,7 @@ export interface DataTableBulkActionsActionsProps {
|
|
|
1066
1208
|
* cannot be clicked or focused (without a disabled look), because the
|
|
1067
1209
|
* selection they would act on is stale (DS-916).
|
|
1068
1210
|
*/
|
|
1069
|
-
export declare function DataTableBulkActionsActions({ dataHook, className, children, }: DataTableBulkActionsActionsProps):
|
|
1211
|
+
export declare function DataTableBulkActionsActions({ dataHook, className, children, }: DataTableBulkActionsActionsProps): React.JSX.Element;
|
|
1070
1212
|
export declare namespace DataTableBulkActionsActions {
|
|
1071
1213
|
var displayName: string;
|
|
1072
1214
|
}
|
|
@@ -1086,8 +1228,14 @@ export interface DataTableToolbarProps {
|
|
|
1086
1228
|
* Responsive toolbar container for DataTable companion controls.
|
|
1087
1229
|
*
|
|
1088
1230
|
* Stacks vertically on mobile (< 640 px) and switches to a horizontal
|
|
1089
|
-
* row on `sm:` and up.
|
|
1090
|
-
*
|
|
1231
|
+
* row on `sm:` and up. The row **wraps**: the bulk-actions bar joins the
|
|
1232
|
+
* search and filters in the left slot while rows are selected, and when the
|
|
1233
|
+
* right slot (pagination) no longer fits beside them it drops to a second
|
|
1234
|
+
* line, right-aligned.
|
|
1235
|
+
* Nothing is hidden or squeezed, which is what keeps the bulk-actions
|
|
1236
|
+
* contract ("search and filters stay mounted") true at any width.
|
|
1237
|
+
* Layout-only — no dependency on a TanStack Table instance, so it works
|
|
1238
|
+
* for table footers or any search-plus-pagination row.
|
|
1091
1239
|
*
|
|
1092
1240
|
* Toolbars belong in the same flex-column container as their `DataTable` so
|
|
1093
1241
|
* the group reads as one slot inside gapped parents — see the composition
|
|
@@ -1108,7 +1256,7 @@ export interface DataTableToolbarProps {
|
|
|
1108
1256
|
* </DataTableToolbarRight>
|
|
1109
1257
|
* </DataTableToolbar>
|
|
1110
1258
|
*/
|
|
1111
|
-
export declare function DataTableToolbar({ dataHook, className, children, }: DataTableToolbarProps):
|
|
1259
|
+
export declare function DataTableToolbar({ dataHook, className, children, }: DataTableToolbarProps): React.JSX.Element;
|
|
1112
1260
|
export declare namespace DataTableToolbar {
|
|
1113
1261
|
var displayName: string;
|
|
1114
1262
|
}
|
|
@@ -1123,10 +1271,12 @@ export interface DataTableToolbarLeftProps {
|
|
|
1123
1271
|
}
|
|
1124
1272
|
/**
|
|
1125
1273
|
* Left slot of `DataTableToolbar`. Grows to fill remaining space on
|
|
1126
|
-
* desktop; full-width on mobile.
|
|
1127
|
-
*
|
|
1274
|
+
* desktop; full-width on mobile. Its flex basis is its content
|
|
1275
|
+
* (`flex-auto`, not `flex-1`) so a crowded toolbar wraps the right slot
|
|
1276
|
+
* onto a new line instead of squeezing the search and filters; `min-w-0`
|
|
1277
|
+
* still lets long inputs shrink on narrow viewports.
|
|
1128
1278
|
*/
|
|
1129
|
-
export declare function DataTableToolbarLeft({ className, children, }: DataTableToolbarLeftProps):
|
|
1279
|
+
export declare function DataTableToolbarLeft({ className, children, }: DataTableToolbarLeftProps): React.JSX.Element;
|
|
1130
1280
|
export declare namespace DataTableToolbarLeft {
|
|
1131
1281
|
var displayName: string;
|
|
1132
1282
|
}
|
|
@@ -1136,18 +1286,19 @@ export declare namespace DataTableToolbarLeft {
|
|
|
1136
1286
|
export interface DataTableToolbarRightProps {
|
|
1137
1287
|
/** Additional class name (merged after defaults via `cn`). */
|
|
1138
1288
|
className?: string;
|
|
1139
|
-
/** Slot contents —
|
|
1289
|
+
/** Slot contents — action buttons, bulk actions, or a compact top `DataTablePagination` for long-list pages. Pagination default placement is below the table. */
|
|
1140
1290
|
children: React.ReactNode;
|
|
1141
1291
|
}
|
|
1142
1292
|
/**
|
|
1143
1293
|
* Right slot of `DataTableToolbar`. Collapses to content width and
|
|
1144
|
-
* right-aligns on desktop
|
|
1145
|
-
*
|
|
1294
|
+
* right-aligns on desktop (`ml-auto`, so it stays right-aligned when the
|
|
1295
|
+
* toolbar wraps it onto its own line); full-width with `justify-end` on
|
|
1296
|
+
* mobile so pagination controls don't jump when stacking.
|
|
1146
1297
|
*/
|
|
1147
|
-
export declare function DataTableToolbarRight({ className, children, }: DataTableToolbarRightProps):
|
|
1298
|
+
export declare function DataTableToolbarRight({ className, children, }: DataTableToolbarRightProps): React.JSX.Element;
|
|
1148
1299
|
export declare namespace DataTableToolbarRight {
|
|
1149
1300
|
var displayName: string;
|
|
1150
1301
|
}
|
|
1151
|
-
export { DataTablePaginationRowCount, DataTablePaginationNav };
|
|
1152
|
-
export type { Column, ColumnDef, ExpandedState, PaginationState, Row, RowSelectionState, SortingState, TanStackTable, };
|
|
1302
|
+
export { DataTable, VirtualizedDataTable, DataTablePaginationRowCount, DataTablePaginationNav, useDataTablePagination, };
|
|
1303
|
+
export type { DataTablePaginationInfo, Column, ColumnDef, ExpandedState, PaginationState, Row, RowSelectionState, SortingState, TanStackTable, };
|
|
1153
1304
|
//# sourceMappingURL=data-table.d.ts.map
|