@brightlocal/ui-components 2.20.0 → 2.22.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 +2 -0
- package/README.md +26 -13
- package/component-meta.json +41 -14
- package/dist/blocks/data-table.cjs +1 -1
- package/dist/blocks/data-table.d.ts +35 -3
- package/dist/blocks/data-table.d.ts.map +1 -1
- package/dist/blocks/data-table.js +178 -154
- package/dist/blocks/sidebar.cjs +1 -1
- package/dist/blocks/sidebar.d.ts +2 -2
- package/dist/blocks/sidebar.js +18 -18
- package/dist/breadcrumb.cjs +1 -1
- package/dist/breadcrumb.d.ts +1 -1
- package/dist/breadcrumb.d.ts.map +1 -1
- package/dist/breadcrumb.js +9 -6
- package/dist/button.cjs +1 -1
- package/dist/button.d.ts.map +1 -1
- package/dist/button.js +12 -12
- package/dist/hover-card.cjs +1 -1
- package/dist/hover-card.d.ts.map +1 -1
- package/dist/hover-card.js +45 -45
- package/dist/index.cjs +1 -1
- package/dist/index.js +69 -68
- package/dist/lib/utils.cjs +1 -1
- package/dist/lib/utils.d.ts +1 -0
- package/dist/lib/utils.d.ts.map +1 -1
- package/dist/lib/utils.js +7 -5
- package/dist/logo.cjs +1 -1
- package/dist/logo.d.ts +1 -1
- package/dist/logo.js +2 -2
- package/dist/navigation-menu.cjs +1 -1
- package/dist/navigation-menu.d.ts +17 -0
- package/dist/navigation-menu.d.ts.map +1 -1
- package/dist/navigation-menu.js +120 -90
- package/dist/pagination.cjs +1 -1
- package/dist/pagination.d.ts +12 -8
- package/dist/pagination.d.ts.map +1 -1
- package/dist/pagination.js +117 -113
- package/dist/progress.cjs +1 -1
- package/dist/progress.d.ts +28 -2
- package/dist/progress.d.ts.map +1 -1
- package/dist/progress.js +90 -49
- package/dist/skeleton.cjs +1 -1
- package/dist/skeleton.js +1 -1
- package/dist/sonner.d.ts +1 -1
- package/dist/table.cjs +1 -1
- package/dist/table.d.ts +22 -2
- package/dist/table.d.ts.map +1 -1
- package/dist/table.js +57 -43
- package/dist/tooltip.cjs +1 -1
- package/dist/tooltip.d.ts.map +1 -1
- package/dist/tooltip.js +36 -36
- package/package.json +7 -3
- package/src/blocks/data-table.tsx +56 -4
- package/src/blocks/sidebar.tsx +5 -5
- package/src/components/breadcrumb.tsx +6 -3
- package/src/components/button.tsx +7 -1
- package/src/components/hover-card.tsx +6 -3
- package/src/components/logo.tsx +3 -3
- package/src/components/navigation-menu.tsx +113 -32
- package/src/components/pagination.tsx +47 -67
- package/src/components/progress.tsx +118 -14
- package/src/components/skeleton.tsx +1 -1
- package/src/components/sonner.tsx +1 -1
- package/src/components/table.tsx +44 -7
- package/src/components/tooltip.tsx +8 -5
- package/src/lib/utils.ts +3 -0
package/AI_USAGE.md
CHANGED
|
@@ -347,6 +347,7 @@ sonner.dismiss("redirect-toast");
|
|
|
347
347
|
- Use `asChild` on triggers to render your own button: `<DialogTrigger asChild><Button>...</Button></DialogTrigger>`
|
|
348
348
|
- Use `cn()` from `@brightlocal/ui-components/lib/utils` to merge classNames
|
|
349
349
|
- Use `variant` and `size` props instead of custom className overrides
|
|
350
|
+
- On DS components, limit `className` to **external layout only** (margin, width, positioning, flex/grid) — see [CLASSNAME_OVERRIDES.md](./CLASSNAME_OVERRIDES.md)
|
|
350
351
|
- Provide `aria-label` on icon-only buttons (`iconOnly` prop)
|
|
351
352
|
- Use `Typography` components (`H1`–`H4`, `P`, `Small`, `Muted`, `Lead`) for text
|
|
352
353
|
- Use `Separator` between content sections, not `<hr>` or border utilities
|
|
@@ -359,6 +360,7 @@ sonner.dismiss("redirect-toast");
|
|
|
359
360
|
- Don't use bare `focus:` — always use `focus-visible:`
|
|
360
361
|
- Don't import from the barrel `"@brightlocal/ui-components"` — use per-file imports
|
|
361
362
|
- Don't create wrapper `<div>`s for layout when `Card`, `Field`, or layout components exist
|
|
363
|
+
- Don't override appearance on DS components via `className` (`bg-*`, `p-*`, `rounded-*`, `text-{size}`, `shadow-*`) — use a `variant`/`size` prop, a CSS variable, or a slot prop; request a variant if none fits (the note above about `bg-blue-600` being "OK" applies to _authoring_ a component, not overriding a DS one)
|
|
362
364
|
- Don't skip `dataHook` on interactive components — check `component-meta.json` if unsure whether it's required
|
|
363
365
|
- Don't use `size` prop on icons unless overriding the 16px default
|
|
364
366
|
|
package/README.md
CHANGED
|
@@ -326,24 +326,37 @@ Components support dark mode through CSS custom properties and the `dark` class.
|
|
|
326
326
|
|
|
327
327
|
### Custom Styling
|
|
328
328
|
|
|
329
|
-
|
|
329
|
+
> **The rule: the outer box is yours, the inner identity is ours.** How a
|
|
330
|
+
> component sits in _your_ layout is yours to set via `className`; what it _looks
|
|
331
|
+
> like_ is design-system identity — change it through props, variants, or tokens.
|
|
332
|
+
> Full policy: [CLASSNAME_OVERRIDES.md](./CLASSNAME_OVERRIDES.md).
|
|
330
333
|
|
|
331
|
-
|
|
332
|
-
- **CSS modules** - Target `data-slot` attributes
|
|
333
|
-
- **Wrapper components** - Create your own component variants
|
|
334
|
+
**✅ Safe — external layout via `className`** (margin, width, positioning, flex/grid placement):
|
|
334
335
|
|
|
335
336
|
```tsx
|
|
336
|
-
//
|
|
337
|
-
<Button className="
|
|
338
|
-
|
|
339
|
-
</Button>
|
|
340
|
-
|
|
341
|
-
// Creating a wrapper component
|
|
342
|
-
export function PrimaryButton(props) {
|
|
343
|
-
return <Button className="bg-primary text-primary-foreground" {...props} />;
|
|
344
|
-
}
|
|
337
|
+
// Position it in your layout
|
|
338
|
+
<Button className="w-full" dataHook="submit">Save</Button>
|
|
339
|
+
<Card className="max-w-md" dataHook="summary">...</Card>
|
|
345
340
|
```
|
|
346
341
|
|
|
342
|
+
**🔴 Don't — appearance via `className`** (colour, padding, radius, typography). Use a `variant`/`size` prop, a CSS variable, or a slot prop instead:
|
|
343
|
+
|
|
344
|
+
```tsx
|
|
345
|
+
// AVOID — overrides brand identity, silently wins over tokens
|
|
346
|
+
<Button className="bg-blue-600 hover:bg-blue-700">Custom Button</Button>
|
|
347
|
+
|
|
348
|
+
// DO — use a variant
|
|
349
|
+
<Button variant="outline" dataHook="cancel">Cancel</Button>
|
|
350
|
+
|
|
351
|
+
// DO — re-theme globally with CSS variables
|
|
352
|
+
// :root { --primary: 210 100% 50%; --radius: 0.5rem; }
|
|
353
|
+
|
|
354
|
+
// DO — reach a nested element with a slot prop
|
|
355
|
+
<Progress indicatorClassName="bg-info" dataHook="upload" />
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
Need an appearance a variant doesn't cover? [Request a DS change](./CLASSNAME_OVERRIDES.md#when-to-ask-the-ds-team) — it becomes a reusable variant for everyone. Other customization surfaces: **CSS variables** for theming, **`data-slot` attributes** for targeting parts, and **wrapper components** that set variant defaults.
|
|
359
|
+
|
|
347
360
|
## Accessibility
|
|
348
361
|
|
|
349
362
|
All components in this package are built with accessibility in mind, following WAI-ARIA best practices:
|
package/component-meta.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@brightlocal/ui-components",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.22.0",
|
|
4
4
|
"description": "Machine-readable registry of all components in the BrightLocal Design System",
|
|
5
5
|
"components": [
|
|
6
6
|
{
|
|
@@ -1428,7 +1428,7 @@
|
|
|
1428
1428
|
"description": "BrightLocal brand logo",
|
|
1429
1429
|
"i18nProps": {
|
|
1430
1430
|
"Logo": {
|
|
1431
|
-
"ariaLabel": "string — default: \"BrightLocal
|
|
1431
|
+
"ariaLabel": "string — default: \"BrightLocal logo\""
|
|
1432
1432
|
}
|
|
1433
1433
|
}
|
|
1434
1434
|
},
|
|
@@ -1598,19 +1598,18 @@
|
|
|
1598
1598
|
"Pagination",
|
|
1599
1599
|
"PaginationContent",
|
|
1600
1600
|
"PaginationItem",
|
|
1601
|
+
"PaginationButton",
|
|
1601
1602
|
"PaginationLink",
|
|
1602
1603
|
"PaginationPrevious",
|
|
1603
1604
|
"PaginationNext",
|
|
1604
1605
|
"PaginationEllipsis"
|
|
1605
1606
|
],
|
|
1606
1607
|
"compound": true,
|
|
1607
|
-
"dataHookRequired":
|
|
1608
|
+
"dataHookRequired": true,
|
|
1608
1609
|
"variants": {},
|
|
1609
1610
|
"props": [
|
|
1610
1611
|
"page",
|
|
1611
|
-
"totalPages"
|
|
1612
|
-
"siblingCount",
|
|
1613
|
-
"boundaryCount"
|
|
1612
|
+
"totalPages"
|
|
1614
1613
|
],
|
|
1615
1614
|
"hooks": [
|
|
1616
1615
|
"usePagination"
|
|
@@ -1688,15 +1687,26 @@
|
|
|
1688
1687
|
],
|
|
1689
1688
|
"compound": false,
|
|
1690
1689
|
"dataHookRequired": true,
|
|
1691
|
-
"variants": {
|
|
1690
|
+
"variants": {
|
|
1691
|
+
"color": [
|
|
1692
|
+
"green",
|
|
1693
|
+
"red",
|
|
1694
|
+
"orange",
|
|
1695
|
+
"yellow"
|
|
1696
|
+
]
|
|
1697
|
+
},
|
|
1692
1698
|
"props": [
|
|
1693
1699
|
"value",
|
|
1700
|
+
"max",
|
|
1701
|
+
"color",
|
|
1702
|
+
"showValue",
|
|
1703
|
+
"unit",
|
|
1694
1704
|
"ariaLabel",
|
|
1695
1705
|
"label",
|
|
1696
1706
|
"indicatorClassName",
|
|
1697
1707
|
"disabled"
|
|
1698
1708
|
],
|
|
1699
|
-
"description": "Progress bar indicator"
|
|
1709
|
+
"description": "Progress bar indicator with optional inline label, numeric value, and brand color options"
|
|
1700
1710
|
},
|
|
1701
1711
|
{
|
|
1702
1712
|
"name": "RadioGroup",
|
|
@@ -2194,10 +2204,19 @@
|
|
|
2194
2204
|
"left",
|
|
2195
2205
|
"right",
|
|
2196
2206
|
"center"
|
|
2207
|
+
],
|
|
2208
|
+
"layout": [
|
|
2209
|
+
"auto",
|
|
2210
|
+
"fixed"
|
|
2197
2211
|
]
|
|
2198
2212
|
},
|
|
2199
2213
|
"props": [],
|
|
2200
|
-
"
|
|
2214
|
+
"i18nProps": {
|
|
2215
|
+
"Table": {
|
|
2216
|
+
"scrollRegionLabel": "string — default: \"Scrollable table\""
|
|
2217
|
+
}
|
|
2218
|
+
},
|
|
2219
|
+
"description": "Semantic HTML table with accessibility features and logical alignment. Set layout=\"fixed\" with width on TableHead for stable columns.",
|
|
2201
2220
|
"aliases": [
|
|
2202
2221
|
"data grid",
|
|
2203
2222
|
"grid",
|
|
@@ -2379,8 +2398,7 @@
|
|
|
2379
2398
|
"Tooltip",
|
|
2380
2399
|
"TooltipProvider",
|
|
2381
2400
|
"TooltipTrigger",
|
|
2382
|
-
"TooltipContent"
|
|
2383
|
-
"TooltipArrow"
|
|
2401
|
+
"TooltipContent"
|
|
2384
2402
|
],
|
|
2385
2403
|
"compound": true,
|
|
2386
2404
|
"dataHookRequired": false,
|
|
@@ -2491,9 +2509,18 @@
|
|
|
2491
2509
|
"enablePagination",
|
|
2492
2510
|
"pageSize",
|
|
2493
2511
|
"isLoading",
|
|
2494
|
-
"noResultsMessage"
|
|
2512
|
+
"noResultsMessage",
|
|
2513
|
+
"layout",
|
|
2514
|
+
"minWidth",
|
|
2515
|
+
"scrollRegionLabel",
|
|
2516
|
+
"stickyHeader",
|
|
2517
|
+
"footer",
|
|
2518
|
+
"className"
|
|
2495
2519
|
],
|
|
2496
2520
|
"i18nProps": {
|
|
2521
|
+
"DataTable": {
|
|
2522
|
+
"scrollRegionLabel": "string — default: \"Scrollable table\""
|
|
2523
|
+
},
|
|
2497
2524
|
"DataTableColumnHeader": {
|
|
2498
2525
|
"getSortLabel": "(title: string, direction: \"asc\" | \"desc\" | false) => string"
|
|
2499
2526
|
},
|
|
@@ -2607,10 +2634,10 @@
|
|
|
2607
2634
|
"ariaLabel": "string — default: \"Sidebar\""
|
|
2608
2635
|
},
|
|
2609
2636
|
"SidebarTrigger": {
|
|
2610
|
-
"toggleAriaLabel": "string — default: \"Toggle
|
|
2637
|
+
"toggleAriaLabel": "string — default: \"Toggle sidebar\""
|
|
2611
2638
|
},
|
|
2612
2639
|
"SidebarRail": {
|
|
2613
|
-
"toggleAriaLabel": "string — default: \"Toggle
|
|
2640
|
+
"toggleAriaLabel": "string — default: \"Toggle sidebar\""
|
|
2614
2641
|
},
|
|
2615
2642
|
"SidebarPopoverTrigger": {
|
|
2616
2643
|
"triggerAriaLabel": "string — default: \"Switch workspace\""
|
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("react/jsx-runtime"),de=require("react"),j=require("@tanstack/react-table"),ue=require("@tanstack/react-virtual"),R=require("@brightlocal/icons"),p=require("@brightlocal/ui-components/lib/utils"),A=require("../button.cjs"),q=require("../checkbox.cjs"),N=require("../input-group.cjs"),m=require("../pagination.cjs"),ge=require("../skeleton.cjs"),g=require("../table.cjs");function be(a){const t=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(a){for(const l in a)if(l!=="default"){const n=Object.getOwnPropertyDescriptor(a,l);Object.defineProperty(t,l,n.get?n:{enumerable:!0,get:()=>a[l]})}}return t.default=a,Object.freeze(t)}const x=be(de);function P(a,t,l){const[n,i]=x.useState(t),o=a!==void 0?a:n,s=x.useRef(o);x.useEffect(()=>{s.current=o});const d=a!==void 0,c=x.useCallback(r=>{const u=typeof r=="function"?r(s.current):r;d||i(u),l?.(u)},[d,l]);return[o,c]}function xe(a){const{columns:t,data:l,enableSorting:n=!0,enableGlobalFiltering:i=!1,enableRowSelection:o=!1,enablePagination:s=!1,pageSize:d=10,manualSorting:c=!1,manualFiltering:r=!1,manualPagination:u=!1,rowCount:h,pageCount:b,enableExpanding:f=!1,getSubRows:w,getRowId:C,pagination:T,onPaginationChange:v,sorting:S,onSortingChange:z,globalFilter:D,onGlobalFilterChange:k,rowSelection:I,onRowSelectionChange:y,expanded:Y,onExpandedChange:Z}=a,[ee,ae]=P(T,{pageIndex:0,pageSize:d},v),[te,ne]=P(S,[],z),[oe,le]=P(D,"",k),[ie,se]=P(I,{},y),[re,ce]=P(Y,{},Z);return j.useReactTable({data:l,columns:t,getCoreRowModel:j.getCoreRowModel(),...C&&{getRowId:C},...(s||u)&&{onPaginationChange:ae},...s&&{...!u&&{getPaginationRowModel:j.getPaginationRowModel()}},...u&&{manualPagination:!0,...h!=null&&{rowCount:h},...b!=null&&{pageCount:b}},...n&&{...!c&&{getSortedRowModel:j.getSortedRowModel()},onSortingChange:ne,...c&&{manualSorting:!0}},...i&&{...!r&&{getFilteredRowModel:j.getFilteredRowModel()},...r&&{manualFiltering:!0},onGlobalFilterChange:le,globalFilterFn:"includesString"},...o&&{enableRowSelection:!0,onRowSelectionChange:se},...f&&{getExpandedRowModel:j.getExpandedRowModel(),onExpandedChange:ce,getSubRows:w},state:{pagination:ee,sorting:te,globalFilter:oe,rowSelection:ie,expanded:re}})}function H({table:a,dataHook:t,trackingEl:l,trackingLabel:n,isLoading:i=!1,skeletonRowCount:o,noResultsMessage:s="No results.",stickyHeader:d=!1,className:c,footer:r}){const u=a.getVisibleLeafColumns().length,h=o??a.getState().pagination.pageSize??10;return e.jsx("div",{"aria-busy":i||void 0,className:p.cn("border-border overflow-auto rounded-md border",c),"data-hook":t,"data-slot":"data-table-view","data-tracking-el":l,"data-tracking-label":n,children:e.jsxs(g.Table,{dataHook:`${t}-table`,children:[e.jsx(V,{stickyHeader:d,table:a}),e.jsx(g.TableBody,{children:i?e.jsxs(e.Fragment,{children:[e.jsx(E,{colCount:u,rowCount:h}),e.jsx(g.TableRow,{className:"sr-only",children:e.jsx(g.TableCell,{colSpan:u,children:e.jsx("div",{"aria-live":"polite",role:"status",children:"Loading data…"})})})]}):e.jsx(e.Fragment,{children:a.getRowModel().rows.length>0?a.getRowModel().rows.map(b=>e.jsx($,{row:b},b.id)):e.jsx(g.TableRow,{children:e.jsx(g.TableCell,{colSpan:u,children:e.jsx("div",{"aria-live":"polite",role:"status",children:s})})})})}),r]})})}H.displayName="DataTable";function V({table:a,stickyHeader:t}){return e.jsx(g.TableHeader,{className:p.cn(t&&"bg-background sticky top-0 z-10"),children:a.getHeaderGroups().map(l=>e.jsx(g.TableRow,{children:l.headers.map(n=>{const i=n.column.getCanSort()?n.column.getIsSorted():!1,o=i==="asc"?"ascending":i==="desc"?"descending":n.column.getCanSort()?"none":void 0;return e.jsx(g.TableHead,{"aria-sort":o,colSpan:n.colSpan,children:n.isPlaceholder?null:j.flexRender(n.column.columnDef.header,n.getContext())},n.id)})},l.id))})}function $({row:a}){return e.jsx(g.TableRow,{"data-state":a.getIsSelected()?"selected":void 0,children:a.getVisibleCells().map(t=>e.jsx(g.TableCell,{children:j.flexRender(t.column.columnDef.cell,t.getContext())},t.id))})}function E({rowCount:a,colCount:t}){return e.jsx(e.Fragment,{children:Array.from({length:a}).map((l,n)=>e.jsx(g.TableRow,{children:Array.from({length:t}).map((i,o)=>e.jsx(g.TableCell,{children:e.jsx(ge.Skeleton,{className:"h-4 w-full"})},`skeleton-${n}-${o}`))},`skeleton-${n}`))})}function G({table:a,dataHook:t,trackingEl:l,trackingLabel:n,isLoading:i=!1,skeletonRowCount:o,noResultsMessage:s="No results.",stickyHeader:d=!1,className:c,footer:r,height:u,estimateSize:h=48,overscan:b=5}){const f=a.getVisibleLeafColumns().length,w=o??a.getState().pagination.pageSize??10,C=x.useRef(null),T=a.getRowModel().rows,v=ue.useVirtualizer({count:T.length,getScrollElement:()=>C.current,estimateSize:()=>h,overscan:b}),S=v.getVirtualItems(),z=v.getTotalSize(),D=S.length>0?S[0].start:0,k=S.length>0?z-S[S.length-1].end:0;return e.jsx("div",{ref:C,"aria-busy":i||void 0,className:p.cn("border-border overflow-auto rounded-md border",c),"data-hook":t,"data-slot":"data-table-view","data-tracking-el":l,"data-tracking-label":n,style:u!=null?{height:u}:void 0,children:e.jsxs(g.Table,{dataHook:`${t}-table`,children:[e.jsx(V,{stickyHeader:d,table:a}),e.jsx(g.TableBody,{children:i?e.jsxs(e.Fragment,{children:[e.jsx(E,{colCount:f,rowCount:w}),e.jsx(g.TableRow,{className:"sr-only",children:e.jsx(g.TableCell,{colSpan:f,children:e.jsx("div",{"aria-live":"polite",role:"status",children:"Loading data…"})})})]}):T.length>0?e.jsxs(e.Fragment,{children:[D>0&&e.jsx("tr",{"aria-hidden":"true",children:e.jsx("td",{colSpan:f,style:{height:D}})}),S.map(I=>{const y=T[I.index];return e.jsx($,{row:y},y.id)}),k>0&&e.jsx("tr",{"aria-hidden":"true",children:e.jsx("td",{colSpan:f,style:{height:k}})})]}):e.jsx(g.TableRow,{children:e.jsx(g.TableCell,{colSpan:f,children:e.jsx("div",{"aria-live":"polite",role:"status",children:s})})})}),r]})})}G.displayName="VirtualizedDataTable";function L({column:a,title:t,className:l,dataHook:n,trackingEl:i,trackingLabel:o,align:s="left",getSortLabel:d}){if(!a.getCanSort())return e.jsx("div",{className:p.cn("text-muted-foreground text-left text-sm leading-normal font-medium",s==="right"&&"text-right",s==="center"&&"text-center",l),"data-hook":n,"data-slot":"data-table-column-header","data-tracking-el":i,"data-tracking-label":o,children:t});const c=a.getIsSorted(),r=d?d(t,c):c==="desc"?`Sort by ${t}, currently descending`:c==="asc"?`Sort by ${t}, currently ascending`:`Sort by ${t}`;return e.jsx("div",{className:p.cn("flex items-center",s==="right"&&"justify-end",s==="center"&&"justify-center",l),"data-slot":"data-table-column-header","data-tracking-el":i,"data-tracking-label":o,children:e.jsxs(A.Button,{"aria-label":r,className:"text-muted-foreground h-auto p-0 text-sm font-medium",dataHook:n||`column-header-${a.id}`,size:"sm",variant:"ghost",onClick:()=>a.toggleSorting(c==="asc"),children:[e.jsx("span",{"aria-hidden":"true",children:t}),e.jsx("span",{"aria-hidden":"true",className:"flex size-3 items-center justify-center",children:c==="desc"?e.jsx(R.ArrowDown,{size:12}):c==="asc"?e.jsx(R.ArrowUp,{size:12}):e.jsx(R.ArrowUpDown,{size:12})})]})})}L.displayName="DataTableColumnHeader";function O({table:a,ariaLabel:t,placeholder:l,clearSearchAriaLabel:n,...i}){const o=a.getState().globalFilter??"",s=d=>{a.setGlobalFilter(d)};return e.jsxs(N.InputGroup,{"data-slot":"data-table-search",...i,children:[e.jsx(N.InputGroupAddon,{className:"pl-3",children:e.jsx(R.Search,{})}),e.jsx(N.InputGroupInput,{"aria-label":t??"Search table",placeholder:l??"Search...",type:"text",value:o,onChange:d=>s(d.target.value)}),o&&e.jsx(N.InputGroupAddon,{className:"pr-1",children:e.jsx(A.Button,{"aria-label":n??"Clear search",className:"h-auto p-1","data-slot":"data-table-search-clear",dataHook:`${i.dataHook}-clear`,variant:"ghost",onClick:()=>s(""),children:e.jsx(R.X,{size:14})})})]})}O.displayName="DataTableSearch";function he(a){const{pageIndex:t,pageSize:l}=a.getState().pagination,n=a.getRowCount(),i=a.getPageCount(),o=a.getCanPreviousPage(),s=a.getCanNextPage(),d=t+1,c=n===0?0:t*l+1,r=Math.min(d*l,n),u=x.useCallback(w=>a.setPageIndex(w-1),[a]),h=x.useCallback(()=>a.nextPage(),[a]),b=x.useCallback(()=>a.previousPage(),[a]),f=x.useCallback(w=>a.setPageSize(w),[a]);return x.useMemo(()=>({pageIndex:t,pageSize:l,totalRows:n,totalPages:i,startRow:c,endRow:r,currentPage:d,canPrev:o,canNext:s,goToPage:u,nextPage:h,previousPage:b,setPageSize:f}),[t,l,n,i,c,r,d,o,s,u,h,b,f])}const F=x.createContext(null);function B(){const a=x.useContext(F);if(!a)throw new Error("DataTablePagination sub-components must be used within <DataTablePagination>");return a}function _({renderText:a,className:t}){const{info:l}=B(),{startRow:n,endRow:i,totalRows:o,pageIndex:s,pageSize:d}=l,c=a?a({startRow:n,endRow:i,totalRows:o,pageIndex:s,pageSize:d}):o===0?null:`${n}-${i} of ${o}`;return c==null?null:e.jsx("span",{className:p.cn("text-muted-foreground text-sm",t),"data-slot":"data-table-pagination-row-count",children:c})}_.displayName="DataTablePaginationRowCount";function M({ariaLabel:a="Table pagination",dataHook:t,className:l}){const{info:n}=B(),i=m.usePagination({page:n.currentPage,totalPages:n.totalPages,siblingCount:1,boundaryCount:1});return e.jsx(m.Pagination,{ariaLabel:a,className:p.cn("mx-0 w-auto justify-end",l),dataHook:t??"pagination-nav",children:e.jsx(m.PaginationContent,{children:i.map((o,s)=>o==="previous"?e.jsx(m.PaginationItem,{children:e.jsx(m.PaginationPrevious,{disabled:!n.canPrev,onClick:()=>n.previousPage()})},"previous"):o==="next"?e.jsx(m.PaginationItem,{children:e.jsx(m.PaginationNext,{disabled:!n.canNext,onClick:()=>n.nextPage()})},"next"):o==="ellipsis"?e.jsx(m.PaginationItem,{children:e.jsx(m.PaginationEllipsis,{})},`ellipsis-${s}`):e.jsx(m.PaginationItem,{children:e.jsx(m.PaginationLink,{isActive:o===n.currentPage,page:o,onClick:()=>n.goToPage(o)})},o))})})}M.displayName="DataTablePaginationNav";function U({table:a,dataHook:t,showRowCount:l=!0,renderRowCount:n,trackingEl:i,trackingLabel:o,className:s,ariaLabel:d="Table pagination",children:c}){const r=he(a),u=x.useMemo(()=>({info:r}),[r]),h={"data-hook":t,"data-slot":"data-table-pagination","data-tracking-el":i,"data-tracking-label":o};if(c)return e.jsx(F.Provider,{value:u,children:e.jsx("div",{className:p.cn("flex w-full items-center gap-4",s),...h,children:c})});const b=!l||n===null?null:n?n({startRow:r.startRow,endRow:r.endRow,totalRows:r.totalRows,pageIndex:r.pageIndex,pageSize:r.pageSize}):r.totalRows===0?null:`${r.startRow}-${r.endRow} of ${r.totalRows}`;return e.jsx(F.Provider,{value:u,children:e.jsxs("div",{className:p.cn("flex w-full items-center gap-4",b!=null?"justify-between":"justify-end",s),...h,children:[b!=null&&e.jsx("span",{className:"text-muted-foreground text-sm",children:b}),e.jsx(M,{ariaLabel:d,dataHook:`${t}-nav`})]})})}U.displayName="DataTablePagination";function X({table:a,dataHook:t,trackingEl:l,trackingLabel:n,selectAllAriaLabel:i}){return e.jsx(q.Checkbox,{"aria-label":i??"Select all",checked:a.getIsAllPageRowsSelected()||a.getIsSomePageRowsSelected()&&"indeterminate",dataHook:t||"select-all-checkbox",trackingEl:l,trackingLabel:n,onCheckedChange:o=>a.toggleAllPageRowsSelected(!!o)})}X.displayName="DataTableSelectAllCheckbox";function J({row:a,dataHook:t,trackingEl:l,trackingLabel:n,selectRowAriaLabel:i}){return e.jsx(q.Checkbox,{"aria-label":i??"Select row",checked:a.getIsSelected(),dataHook:t||`select-row-${a.id}`,disabled:!a.getCanSelect(),trackingEl:l,trackingLabel:n,onCheckedChange:o=>a.toggleSelected(!!o)})}J.displayName="DataTableSelectRowCheckbox";function K({dataHook:a,className:t,children:l}){return e.jsx("div",{className:p.cn("flex flex-col gap-3 py-4 sm:flex-row sm:items-center",t),"data-hook":a,"data-slot":"data-table-toolbar",children:l})}K.displayName="DataTableToolbar";function Q({className:a,children:t}){return e.jsx("div",{className:p.cn("flex w-full min-w-0 items-center gap-2 sm:w-auto sm:flex-1",a),"data-slot":"data-table-toolbar-left",children:t})}Q.displayName="DataTableToolbarLeft";function W({className:a,children:t}){return e.jsx("div",{className:p.cn("flex w-full items-center justify-end gap-2 sm:w-auto",a),"data-slot":"data-table-toolbar-right",children:t})}W.displayName="DataTableToolbarRight";exports.DataTable=H;exports.DataTableColumnHeader=L;exports.DataTablePagination=U;exports.DataTablePaginationNav=M;exports.DataTablePaginationRowCount=_;exports.DataTableSearch=O;exports.DataTableSelectAllCheckbox=X;exports.DataTableSelectRowCheckbox=J;exports.DataTableToolbar=K;exports.DataTableToolbarLeft=Q;exports.DataTableToolbarRight=W;exports.VirtualizedDataTable=G;exports.useDataTable=xe;
|
|
1
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("react/jsx-runtime"),de=require("react"),w=require("@tanstack/react-table"),ue=require("@tanstack/react-virtual"),v=require("@brightlocal/icons"),m=require("@brightlocal/ui-components/lib/utils"),V=require("../button.cjs"),$=require("../checkbox.cjs"),I=require("../input-group.cjs"),f=require("../pagination.cjs"),ge=require("../skeleton.cjs"),u=require("../table.cjs");function be(a){const n=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(a){for(const l in a)if(l!=="default"){const t=Object.getOwnPropertyDescriptor(a,l);Object.defineProperty(n,l,t.get?t:{enumerable:!0,get:()=>a[l]})}}return n.default=a,Object.freeze(n)}const x=be(de);function R(a,n,l){const[t,i]=x.useState(n),o=a!==void 0?a:t,s=x.useRef(o);x.useEffect(()=>{s.current=o});const d=a!==void 0,c=x.useCallback(r=>{const g=typeof r=="function"?r(s.current):r;d||i(g),l?.(g)},[d,l]);return[o,c]}function xe(a){const{columns:n,data:l,enableSorting:t=!0,enableGlobalFiltering:i=!1,enableRowSelection:o=!1,enablePagination:s=!1,pageSize:d=10,manualSorting:c=!1,manualFiltering:r=!1,manualPagination:g=!1,rowCount:h,pageCount:b,enableExpanding:p=!1,getSubRows:S,getRowId:T,pagination:C,onPaginationChange:F,sorting:D,onSortingChange:P,globalFilter:k,onGlobalFilterChange:j,rowSelection:M,onRowSelectionChange:y,expanded:N,onExpandedChange:A}=a,[z,ae]=R(C,{pageIndex:0,pageSize:d},F),[te,ne]=R(D,[],P),[oe,le]=R(k,"",j),[ie,se]=R(M,{},y),[re,ce]=R(N,{},A);return w.useReactTable({data:l,columns:n,getCoreRowModel:w.getCoreRowModel(),...T&&{getRowId:T},...(s||g)&&{onPaginationChange:ae},...s&&{...!g&&{getPaginationRowModel:w.getPaginationRowModel()}},...g&&{manualPagination:!0,...h!=null&&{rowCount:h},...b!=null&&{pageCount:b}},...t&&{...!c&&{getSortedRowModel:w.getSortedRowModel()},onSortingChange:ne,...c&&{manualSorting:!0}},...i&&{...!r&&{getFilteredRowModel:w.getFilteredRowModel()},...r&&{manualFiltering:!0},onGlobalFilterChange:le,globalFilterFn:"includesString"},...o&&{enableRowSelection:!0,onRowSelectionChange:se},...p&&{getExpandedRowModel:w.getExpandedRowModel(),onExpandedChange:ce,getSubRows:S},state:{pagination:z,sorting:te,globalFilter:oe,rowSelection:ie,expanded:re}})}function E({table:a,dataHook:n,trackingEl:l,trackingLabel:t,isLoading:i=!1,skeletonRowCount:o,noResultsMessage:s="No results.",stickyHeader:d=!1,className:c,layout:r,minWidth:g,scrollRegionLabel:h,footer:b}){const p=a.getVisibleLeafColumns().length,S=o??a.getState().pagination.pageSize??10;return e.jsx("div",{"aria-busy":i||void 0,className:m.cn("border-border overflow-auto rounded-md border",c),"data-hook":n,"data-slot":"data-table-view","data-tracking-el":l,"data-tracking-label":t,children:e.jsxs(u.Table,{dataHook:`${n}-table`,layout:r,minWidth:g,scrollRegionLabel:h,children:[e.jsx(G,{stickyHeader:d,table:a}),e.jsx(u.TableBody,{children:i?e.jsxs(e.Fragment,{children:[e.jsx(O,{colCount:p,rowCount:S}),e.jsx(u.TableRow,{className:"sr-only",children:e.jsx(u.TableCell,{colSpan:p,children:e.jsx("div",{"aria-live":"polite",role:"status",children:"Loading data…"})})})]}):e.jsx(e.Fragment,{children:a.getRowModel().rows.length>0?a.getRowModel().rows.map(T=>e.jsx(L,{row:T},T.id)):e.jsx(u.TableRow,{children:e.jsx(u.TableCell,{colSpan:p,children:e.jsx("div",{"aria-live":"polite",role:"status",children:s})})})})}),b]})})}E.displayName="DataTable";function G({table:a,stickyHeader:n}){return e.jsx(u.TableHeader,{className:m.cn(n&&"bg-background sticky top-0 z-10"),children:a.getHeaderGroups().map(l=>e.jsx(u.TableRow,{children:l.headers.map(t=>{const i=t.column.getCanSort()?t.column.getIsSorted():!1,o=i==="asc"?"ascending":i==="desc"?"descending":t.column.getCanSort()?"none":void 0,s=t.column.columnDef.meta;return e.jsx(u.TableHead,{"aria-sort":o,colSpan:t.colSpan,minWidth:s?.minWidth,width:s?.width,children:t.isPlaceholder?null:w.flexRender(t.column.columnDef.header,t.getContext())},t.id)})},l.id))})}function L({row:a}){return e.jsx(u.TableRow,{"data-state":a.getIsSelected()?"selected":void 0,children:a.getVisibleCells().map(n=>e.jsx(u.TableCell,{children:w.flexRender(n.column.columnDef.cell,n.getContext())},n.id))})}function O({rowCount:a,colCount:n}){return e.jsx(e.Fragment,{children:Array.from({length:a}).map((l,t)=>e.jsx(u.TableRow,{children:Array.from({length:n}).map((i,o)=>e.jsx(u.TableCell,{children:e.jsx(ge.Skeleton,{className:"h-4 w-full"})},`skeleton-${t}-${o}`))},`skeleton-${t}`))})}function B({table:a,dataHook:n,trackingEl:l,trackingLabel:t,isLoading:i=!1,skeletonRowCount:o,noResultsMessage:s="No results.",stickyHeader:d=!1,className:c,layout:r,minWidth:g,scrollRegionLabel:h,footer:b,height:p,estimateSize:S=48,overscan:T=5}){const C=a.getVisibleLeafColumns().length,F=o??a.getState().pagination.pageSize??10,D=x.useRef(null),P=a.getRowModel().rows,k=ue.useVirtualizer({count:P.length,getScrollElement:()=>D.current,estimateSize:()=>S,overscan:T}),j=k.getVirtualItems(),M=k.getTotalSize(),y=j.length>0?j[0].start:0,N=j.length>0?M-j[j.length-1].end:0;return e.jsx("div",{ref:D,"aria-busy":i||void 0,className:m.cn("border-border overflow-auto rounded-md border",c),"data-hook":n,"data-slot":"data-table-view","data-tracking-el":l,"data-tracking-label":t,style:p!=null?{height:p}:void 0,children:e.jsxs(u.Table,{dataHook:`${n}-table`,layout:r,minWidth:g,scrollRegionLabel:h,children:[e.jsx(G,{stickyHeader:d,table:a}),e.jsx(u.TableBody,{children:i?e.jsxs(e.Fragment,{children:[e.jsx(O,{colCount:C,rowCount:F}),e.jsx(u.TableRow,{className:"sr-only",children:e.jsx(u.TableCell,{colSpan:C,children:e.jsx("div",{"aria-live":"polite",role:"status",children:"Loading data…"})})})]}):P.length>0?e.jsxs(e.Fragment,{children:[y>0&&e.jsx("tr",{"aria-hidden":"true",children:e.jsx("td",{colSpan:C,style:{height:y}})}),j.map(A=>{const z=P[A.index];return e.jsx(L,{row:z},z.id)}),N>0&&e.jsx("tr",{"aria-hidden":"true",children:e.jsx("td",{colSpan:C,style:{height:N}})})]}):e.jsx(u.TableRow,{children:e.jsx(u.TableCell,{colSpan:C,children:e.jsx("div",{"aria-live":"polite",role:"status",children:s})})})}),b]})})}B.displayName="VirtualizedDataTable";function _({column:a,title:n,className:l,dataHook:t,trackingEl:i,trackingLabel:o,align:s="left",getSortLabel:d}){if(!a.getCanSort())return e.jsx("div",{className:m.cn("text-muted-foreground text-left text-sm leading-normal font-medium",s==="right"&&"text-right",s==="center"&&"text-center",l),"data-hook":t,"data-slot":"data-table-column-header","data-tracking-el":i,"data-tracking-label":o,children:n});const c=a.getIsSorted(),r=d?d(n,c):c==="desc"?`Sort by ${n}, currently descending`:c==="asc"?`Sort by ${n}, currently ascending`:`Sort by ${n}`;return e.jsx("div",{className:m.cn("flex items-center",s==="right"&&"justify-end",s==="center"&&"justify-center",l),"data-slot":"data-table-column-header","data-tracking-el":i,"data-tracking-label":o,children:e.jsxs(V.Button,{"aria-label":r,className:"text-muted-foreground h-auto p-0 text-sm font-medium",dataHook:t||`column-header-${a.id}`,size:"sm",variant:"ghost",onClick:()=>a.toggleSorting(c==="asc"),children:[e.jsx("span",{"aria-hidden":"true",children:n}),e.jsx("span",{"aria-hidden":"true",className:"flex size-3 items-center justify-center",children:c==="desc"?e.jsx(v.ArrowDown,{size:12}):c==="asc"?e.jsx(v.ArrowUp,{size:12}):e.jsx(v.ArrowUpDown,{size:12})})]})})}_.displayName="DataTableColumnHeader";function U({table:a,ariaLabel:n,placeholder:l,clearSearchAriaLabel:t,...i}){const o=a.getState().globalFilter??"",s=d=>{a.setGlobalFilter(d)};return e.jsxs(I.InputGroup,{"data-slot":"data-table-search",...i,children:[e.jsx(I.InputGroupAddon,{className:"pl-3",children:e.jsx(v.Search,{})}),e.jsx(I.InputGroupInput,{"aria-label":n??"Search table",placeholder:l??"Search...",type:"text",value:o,onChange:d=>s(d.target.value)}),o&&e.jsx(I.InputGroupAddon,{className:"pr-1",children:e.jsx(V.Button,{"aria-label":t??"Clear search",className:"h-auto p-1","data-slot":"data-table-search-clear",dataHook:`${i.dataHook}-clear`,variant:"ghost",onClick:()=>s(""),children:e.jsx(v.X,{size:14})})})]})}U.displayName="DataTableSearch";function he(a){const{pageIndex:n,pageSize:l}=a.getState().pagination,t=a.getRowCount(),i=a.getPageCount(),o=a.getCanPreviousPage(),s=a.getCanNextPage(),d=n+1,c=t===0?0:n*l+1,r=Math.min(d*l,t),g=x.useCallback(S=>a.setPageIndex(S-1),[a]),h=x.useCallback(()=>a.nextPage(),[a]),b=x.useCallback(()=>a.previousPage(),[a]),p=x.useCallback(S=>a.setPageSize(S),[a]);return x.useMemo(()=>({pageIndex:n,pageSize:l,totalRows:t,totalPages:i,startRow:c,endRow:r,currentPage:d,canPrev:o,canNext:s,goToPage:g,nextPage:h,previousPage:b,setPageSize:p}),[n,l,t,i,c,r,d,o,s,g,h,b,p])}const q=x.createContext(null);function W(){const a=x.useContext(q);if(!a)throw new Error("DataTablePagination sub-components must be used within <DataTablePagination>");return a}function X({renderText:a,className:n}){const{info:l}=W(),{startRow:t,endRow:i,totalRows:o,pageIndex:s,pageSize:d}=l,c=a?a({startRow:t,endRow:i,totalRows:o,pageIndex:s,pageSize:d}):o===0?null:`${t}-${i} of ${o}`;return c==null?null:e.jsx("span",{className:m.cn("text-muted-foreground text-sm",n),"data-slot":"data-table-pagination-row-count",children:c})}X.displayName="DataTablePaginationRowCount";function H({ariaLabel:a="Table pagination",dataHook:n,className:l}){const{info:t}=W(),i=f.usePagination({page:t.currentPage,totalPages:t.totalPages});return e.jsx(f.Pagination,{ariaLabel:a,className:m.cn("mx-0 w-auto justify-end",l),dataHook:n??"pagination-nav",children:e.jsx(f.PaginationContent,{children:i.map((o,s)=>o==="previous"?e.jsx(f.PaginationItem,{children:e.jsx(f.PaginationPrevious,{disabled:!t.canPrev,onClick:()=>t.previousPage()})},"previous"):o==="next"?e.jsx(f.PaginationItem,{children:e.jsx(f.PaginationNext,{disabled:!t.canNext,onClick:()=>t.nextPage()})},"next"):o==="ellipsis"?e.jsx(f.PaginationItem,{children:e.jsx(f.PaginationEllipsis,{})},`ellipsis-${s}`):e.jsx(f.PaginationItem,{children:e.jsx(f.PaginationLink,{isActive:o===t.currentPage,page:o,onClick:()=>t.goToPage(o)})},o))})})}H.displayName="DataTablePaginationNav";function J({table:a,dataHook:n,showRowCount:l=!0,renderRowCount:t,trackingEl:i,trackingLabel:o,className:s,ariaLabel:d="Table pagination",children:c}){const r=he(a),g=x.useMemo(()=>({info:r}),[r]),h={"data-hook":n,"data-slot":"data-table-pagination","data-tracking-el":i,"data-tracking-label":o};if(c)return e.jsx(q.Provider,{value:g,children:e.jsx("div",{className:m.cn("flex w-full items-center gap-4",s),...h,children:c})});const b=!l||t===null?null:t?t({startRow:r.startRow,endRow:r.endRow,totalRows:r.totalRows,pageIndex:r.pageIndex,pageSize:r.pageSize}):r.totalRows===0?null:`${r.startRow}-${r.endRow} of ${r.totalRows}`;return e.jsx(q.Provider,{value:g,children:e.jsxs("div",{className:m.cn("flex w-full items-center gap-4",b!=null?"justify-between":"justify-end",s),...h,children:[b!=null&&e.jsx("span",{className:"text-muted-foreground text-sm",children:b}),e.jsx(H,{ariaLabel:d,dataHook:`${n}-nav`})]})})}J.displayName="DataTablePagination";function K({table:a,dataHook:n,trackingEl:l,trackingLabel:t,selectAllAriaLabel:i}){return e.jsx($.Checkbox,{"aria-label":i??"Select all",checked:a.getIsAllPageRowsSelected()||a.getIsSomePageRowsSelected()&&"indeterminate",dataHook:n||"select-all-checkbox",trackingEl:l,trackingLabel:t,onCheckedChange:o=>a.toggleAllPageRowsSelected(!!o)})}K.displayName="DataTableSelectAllCheckbox";function Q({row:a,dataHook:n,trackingEl:l,trackingLabel:t,selectRowAriaLabel:i}){return e.jsx($.Checkbox,{"aria-label":i??"Select row",checked:a.getIsSelected(),dataHook:n||`select-row-${a.id}`,disabled:!a.getCanSelect(),trackingEl:l,trackingLabel:t,onCheckedChange:o=>a.toggleSelected(!!o)})}Q.displayName="DataTableSelectRowCheckbox";function Y({dataHook:a,className:n,children:l}){return e.jsx("div",{className:m.cn("flex flex-col gap-3 py-4 sm:flex-row sm:items-center",n),"data-hook":a,"data-slot":"data-table-toolbar",children:l})}Y.displayName="DataTableToolbar";function Z({className:a,children:n}){return e.jsx("div",{className:m.cn("flex w-full min-w-0 items-center gap-2 sm:w-auto sm:flex-1",a),"data-slot":"data-table-toolbar-left",children:n})}Z.displayName="DataTableToolbarLeft";function ee({className:a,children:n}){return e.jsx("div",{className:m.cn("flex w-full items-center justify-end gap-2 sm:w-auto",a),"data-slot":"data-table-toolbar-right",children:n})}ee.displayName="DataTableToolbarRight";exports.DataTable=E;exports.DataTableColumnHeader=_;exports.DataTablePagination=J;exports.DataTablePaginationNav=H;exports.DataTablePaginationRowCount=X;exports.DataTableSearch=U;exports.DataTableSelectAllCheckbox=K;exports.DataTableSelectRowCheckbox=Q;exports.DataTableToolbar=Y;exports.DataTableToolbarLeft=Z;exports.DataTableToolbarRight=ee;exports.VirtualizedDataTable=B;exports.useDataTable=xe;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Column, ColumnDef, ExpandedState, PaginationState, Row, RowSelectionState, SortingState, Table as TanStackTable } from '@tanstack/react-table';
|
|
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
3
|
/**
|
|
4
4
|
* DataTable — composable data table primitives built on TanStack Table.
|
|
@@ -21,6 +21,14 @@ import { InputGroup } from '../input-group';
|
|
|
21
21
|
* Block composition example — see `apps/sandbox/components/audit-table.tsx`.
|
|
22
22
|
*/
|
|
23
23
|
import * as React from "react";
|
|
24
|
+
declare module "@tanstack/react-table" {
|
|
25
|
+
interface ColumnMeta<TData extends RowData, TValue> {
|
|
26
|
+
/** Explicit column width (e.g., "200px", "50%", "10rem"). */
|
|
27
|
+
width?: string;
|
|
28
|
+
/** Minimum column width (e.g., "100px", "8rem"). */
|
|
29
|
+
minWidth?: string;
|
|
30
|
+
}
|
|
31
|
+
}
|
|
24
32
|
/**
|
|
25
33
|
* Configuration for `useDataTable`.
|
|
26
34
|
*
|
|
@@ -176,6 +184,30 @@ export interface DataTableProps<TData> {
|
|
|
176
184
|
stickyHeader?: boolean;
|
|
177
185
|
/** Additional class name for the outer wrapper. */
|
|
178
186
|
className?: string;
|
|
187
|
+
/**
|
|
188
|
+
* Table layout algorithm.
|
|
189
|
+
* - `"auto"` (default) — browser sizes columns based on content.
|
|
190
|
+
* - `"fixed"` — columns respect explicit `width` values on `TableHead`/`TableCell`
|
|
191
|
+
* and split remaining space equally. Use when you set `width` on headers.
|
|
192
|
+
*
|
|
193
|
+
* **Migration note:** `"fixed"` will become the default in the next major release.
|
|
194
|
+
* Consumers should start setting explicit `width` on columns now.
|
|
195
|
+
* @default "auto"
|
|
196
|
+
*/
|
|
197
|
+
layout?: "auto" | "fixed";
|
|
198
|
+
/**
|
|
199
|
+
* Minimum width for the table (e.g., "1100px", "60rem"). Prevents columns
|
|
200
|
+
* from compressing on narrow viewports and enables horizontal scroll.
|
|
201
|
+
* When set, the scroll container becomes a focusable region for
|
|
202
|
+
* keyboard accessibility.
|
|
203
|
+
*/
|
|
204
|
+
minWidth?: string;
|
|
205
|
+
/**
|
|
206
|
+
* Accessible label for the scroll container region.
|
|
207
|
+
* Used when `minWidth` is set to provide context for keyboard users.
|
|
208
|
+
* @default "Scrollable table"
|
|
209
|
+
*/
|
|
210
|
+
scrollRegionLabel?: string;
|
|
179
211
|
/**
|
|
180
212
|
* Optional footer rendered inside the `<table>` element after `<tbody>`.
|
|
181
213
|
* Use for summary rows or totals. Pass a `<TableFooter>` with rows.
|
|
@@ -193,7 +225,7 @@ export interface DataTableProps<TData> {
|
|
|
193
225
|
* const table = useDataTable({ columns, data, enableSorting: true });
|
|
194
226
|
* return <DataTable table={table} dataHook="my-table" />;
|
|
195
227
|
*/
|
|
196
|
-
export declare function DataTable<TData>({ table, dataHook, trackingEl, trackingLabel, isLoading, skeletonRowCount, noResultsMessage, stickyHeader, className, footer, }: DataTableProps<TData>): import("react/jsx-runtime").JSX.Element;
|
|
228
|
+
export declare function DataTable<TData>({ table, dataHook, trackingEl, trackingLabel, isLoading, skeletonRowCount, noResultsMessage, stickyHeader, className, layout, minWidth, scrollRegionLabel, footer, }: DataTableProps<TData>): import("react/jsx-runtime").JSX.Element;
|
|
197
229
|
export declare namespace DataTable {
|
|
198
230
|
var displayName: string;
|
|
199
231
|
}
|
|
@@ -249,7 +281,7 @@ export interface VirtualizedDataTableProps<TData> extends DataTableProps<TData>
|
|
|
249
281
|
* />
|
|
250
282
|
* );
|
|
251
283
|
*/
|
|
252
|
-
export declare function VirtualizedDataTable<TData>({ table, dataHook, trackingEl, trackingLabel, isLoading, skeletonRowCount, noResultsMessage, stickyHeader, className, footer, height, estimateSize, overscan, }: VirtualizedDataTableProps<TData>): import("react/jsx-runtime").JSX.Element;
|
|
284
|
+
export declare function VirtualizedDataTable<TData>({ table, dataHook, trackingEl, trackingLabel, isLoading, skeletonRowCount, noResultsMessage, stickyHeader, className, layout, minWidth, scrollRegionLabel, footer, height, estimateSize, overscan, }: VirtualizedDataTableProps<TData>): import("react/jsx-runtime").JSX.Element;
|
|
253
285
|
export declare namespace VirtualizedDataTable {
|
|
254
286
|
var displayName: string;
|
|
255
287
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-table.d.ts","sourceRoot":"","sources":["../../src/blocks/data-table.tsx"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EACL,KAAK,MAAM,EACX,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,GAAG,EACR,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,KAAK,IAAI,aAAa,EAQ5B,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"data-table.d.ts","sourceRoot":"","sources":["../../src/blocks/data-table.tsx"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EACL,KAAK,MAAM,EACX,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,GAAG,EACR,KAAK,OAAO,EACZ,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,KAAK,IAAI,aAAa,EAQ5B,MAAM,uBAAuB,CAAC;AAE/B,OAAO,QAAQ,uBAAuB,CAAC;IAErC,UAAU,UAAU,CAAC,KAAK,SAAS,OAAO,EAAE,MAAM;QAChD,6DAA6D;QAC7D,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,oDAAoD;QACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAOD,OAAO,EACL,UAAU,EAGX,MAAM,2BAA2B,CAAC;AAkEnC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,mBAAmB,CAAC,KAAK;IACxC,4EAA4E;IAC5E,OAAO,EAAE,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC;IACrC,kEAAkE;IAClE,IAAI,EAAE,KAAK,EAAE,CAAC;IACd;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,KAAK,MAAM,CAAC;IAI9E,2CAA2C;IAC3C,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,8EAA8E;IAC9E,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,0DAA0D;IAC1D,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,oDAAoD;IACpD,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,gEAAgE;IAChE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAIlB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAInB,uDAAuD;IACvD,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,2DAA2D;IAC3D,UAAU,CAAC,EAAE,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,KAAK,KAAK,EAAE,GAAG,SAAS,CAAC;IAIxE;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,2EAA2E;IAC3E,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAAE,eAAe,KAAK,IAAI,CAAC;IAC3D,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,KAAK,IAAI,CAAC;IAClD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oBAAoB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAChD,YAAY,CAAC,EAAE,iBAAiB,CAAC;IACjC,oBAAoB,CAAC,EAAE,CAAC,SAAS,EAAE,iBAAiB,KAAK,IAAI,CAAC;IAC9D,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,gBAAgB,CAAC,EAAE,CAAC,QAAQ,EAAE,aAAa,KAAK,IAAI,CAAC;CACtD;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAChC,OAAO,EAAE,mBAAmB,CAAC,KAAK,CAAC,GAClC,aAAa,CAAC,KAAK,CAAC,CA8GtB;AAMD;;;;;;;;GAQG;AACH,MAAM,WAAW,cAAc,CAAC,KAAK;IACnC,sEAAsE;IACtE,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;IAC5B,kDAAkD;IAClD,QAAQ,EAAE,MAAM,CAAC;IACjB,oCAAoC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uBAAuB;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mEAAmE;IACnE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,0FAA0F;IAC1F,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kDAAkD;IAClD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC1B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC1B;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,EAC/B,KAAK,EACL,QAAQ,EACR,UAAU,EACV,aAAa,EACb,SAAiB,EACjB,gBAAgB,EAChB,gBAAgC,EAChC,YAAoB,EACpB,SAAS,EACT,MAAM,EACN,QAAQ,EACR,iBAAiB,EACjB,MAAM,GACP,EAAE,cAAc,CAAC,KAAK,CAAC,2CA0DvB;yBAxEe,SAAS;;;AA8KzB;;;;;;GAMG;AACH,MAAM,WAAW,yBAAyB,CACxC,KAAK,CACL,SAAQ,cAAc,CAAC,KAAK,CAAC;IAC7B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,EAC1C,KAAK,EACL,QAAQ,EACR,UAAU,EACV,aAAa,EACb,SAAiB,EACjB,gBAAgB,EAChB,gBAAgC,EAChC,YAAoB,EACpB,SAAS,EACT,MAAM,EACN,QAAQ,EACR,iBAAiB,EACjB,MAAM,EACN,MAAM,EACN,YAAiB,EACjB,QAAY,GACb,EAAE,yBAAyB,CAAC,KAAK,CAAC,2CA2FlC;yBA5Ge,oBAAoB;;;AAoHpC;;;GAGG;AACH,MAAM,WAAW,0BAA0B,CACzC,KAAK,EACL,MAAM,CACN,SAAQ,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC;IAC5C,gEAAgE;IAChE,MAAM,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC9B,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uBAAuB;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,qEAAqE;IACrE,KAAK,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;IACpC;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,KAAK,MAAM,CAAC;CAC7E;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,EACnD,MAAM,EACN,KAAK,EACL,SAAS,EACT,QAAQ,EACR,UAAU,EACV,aAAa,EACb,KAAc,EACd,YAAY,GACb,EAAE,0BAA0B,CAAC,KAAK,EAAE,MAAM,CAAC,2CAiE3C;yBA1Ee,qBAAqB;;;AAkFrC;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB,CAAC,KAAK,CAAE,SAAQ,IAAI,CACvD,KAAK,CAAC,wBAAwB,CAAC,OAAO,UAAU,CAAC,EACjD,UAAU,GAAG,UAAU,CACxB;IACC,+BAA+B;IAC/B,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;IAC5B,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8CAA8C;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qEAAqE;IACrE,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,EACrC,KAAK,EACL,SAAS,EACT,WAAW,EACX,oBAAoB,EACpB,GAAG,eAAe,EACnB,EAAE,oBAAoB,CAAC,KAAK,CAAC,2CAmC7B;yBAzCe,eAAe;;;AA4K/B,iDAAiD;AACjD,MAAM,WAAW,kBAAkB;IACjC,iDAAiD;IACjD,QAAQ,EAAE,MAAM,CAAC;IACjB,wBAAwB;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,kCAAkC;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gCAAgC;IAC/C;;;;OAIG;IACH,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,KAAK,CAAC,SAAS,CAAC;IAC3D,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,iBAAS,2BAA2B,CAAC,EACnC,UAAU,EACV,SAAS,GACV,EAAE,gCAAgC,kDAoBlC;kBAvBQ,2BAA2B;;;AA+BpC,MAAM,WAAW,2BAA2B;IAC1C,yEAAyE;IACzE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qCAAqC;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,iBAAS,sBAAsB,CAAC,EAC9B,SAA8B,EAC9B,QAAQ,EACR,SAAS,GACV,EAAE,2BAA2B,2CAwD7B;kBA5DQ,sBAAsB;;;AAoE/B;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,wBAAwB,CAAC,KAAK;IAC7C,+BAA+B;IAC/B,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;IAC5B,kDAAkD;IAClD,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,kBAAkB,KAAK,KAAK,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;IACxE,oCAAoC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uBAAuB;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+FAA+F;IAC/F,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,EACzC,KAAK,EACL,QAAQ,EACR,YAAmB,EACnB,cAAc,EACd,UAAU,EACV,aAAa,EACb,SAAS,EACT,SAA8B,EAC9B,QAAQ,GACT,EAAE,wBAAwB,CAAC,KAAK,CAAC,2CAkEjC;yBA5Ee,mBAAmB;;;AAoFnC;;;GAGG;AACH,MAAM,WAAW,+BAA+B,CAAC,KAAK;IACpD,+BAA+B;IAC/B,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;IAC5B,sEAAsE;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uBAAuB;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0EAA0E;IAC1E,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,EAChD,KAAK,EACL,QAAQ,EACR,UAAU,EACV,aAAa,EACb,kBAAkB,GACnB,EAAE,+BAA+B,CAAC,KAAK,CAAC,2CAcxC;yBApBe,0BAA0B;;;AAwB1C;;GAEG;AACH,MAAM,WAAW,+BAA+B,CAAC,KAAK;IACpD,6BAA6B;IAC7B,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;IAChB,sEAAsE;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uBAAuB;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,6EAA6E;IAC7E,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,EAChD,GAAG,EACH,QAAQ,EACR,UAAU,EACV,aAAa,EACb,kBAAkB,GACnB,EAAE,+BAA+B,CAAC,KAAK,CAAC,2CAYxC;yBAlBe,0BAA0B;;;AA0B1C;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,kDAAkD;IAClD,QAAQ,EAAE,MAAM,CAAC;IACjB,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uFAAuF;IACvF,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,gBAAgB,CAAC,EAC/B,QAAQ,EACR,SAAS,EACT,QAAQ,GACT,EAAE,qBAAqB,2CAavB;yBAjBe,gBAAgB;;;AAyBhC;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uEAAuE;IACvE,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,EACnC,SAAS,EACT,QAAQ,GACT,EAAE,yBAAyB,2CAY3B;yBAfe,oBAAoB;;;AAuBpC;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,yEAAyE;IACzE,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,EACpC,SAAS,EACT,QAAQ,GACT,EAAE,0BAA0B,2CAY5B;yBAfe,qBAAqB;;;AAuBrC,OAAO,EAAE,2BAA2B,EAAE,sBAAsB,EAAE,CAAC;AAE/D,YAAY,EACV,MAAM,EACN,SAAS,EACT,aAAa,EACb,eAAe,EACf,GAAG,EACH,iBAAiB,EACjB,YAAY,EACZ,aAAa,GACd,CAAC"}
|