@requence/table 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -2,6 +2,8 @@
2
2
 
3
3
  Headless virtualized table with compound component API, Suspense-compatible data caching, and column width persistence for React.
4
4
 
5
+ 📖 **[Documentation](https://table.docs.requence.cloud)**
6
+
5
7
  ## Installation
6
8
 
7
9
  ```bash
@@ -16,7 +18,7 @@ This package uses [Tailwind CSS](https://tailwindcss.com/) utility classes inter
16
18
 
17
19
  ### VirtualTable
18
20
 
19
- A compound component for rendering large datasets with virtual scrolling and CSS Grid layout.
21
+ A compound component for rendering large datasets with virtual scrolling.
20
22
 
21
23
  ```tsx
22
24
  import { VirtualTable } from '@requence/table'
@@ -99,7 +101,7 @@ All exports are available from the package root:
99
101
  | Export | Type | Description |
100
102
  | --- | --- | --- |
101
103
  | `VirtualTable` | Component | Compound component (`.Header`, `.Column`, `.Body`, `.Row`, `.Cell`, `.SkeletonRow`, `.Empty`, `.Footer`) |
102
- | `createTable*` | Functions | Factory functions for creating slot components with baked-in defaults |
104
+ | `createTable*` | Functions | Factory functions for creating pre-configured sub-components with baked-in defaults |
103
105
  | `useTableCache` | Hook | Suspense-compatible paginated data cache |
104
106
  | `useTableColumnWidths` | Hook | Column width persistence with localStorage |
105
107
 
@@ -66,7 +66,7 @@ export interface VirtualTableFooterProps {
66
66
  end: number;
67
67
  }) => ReactNode;
68
68
  }
69
- interface SlotComponent<P> {
69
+ export interface SlotComponent<P> {
70
70
  (props: P): ReactNode;
71
71
  slot: string;
72
72
  slotDefaults: Partial<P>;
@@ -1 +1 @@
1
- {"version":3,"file":"VirtualTable.d.ts","sourceRoot":"","sources":["../src/VirtualTable.tsx"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,aAAa,EAElB,KAAK,cAAc,EAEnB,KAAK,SAAS,EAMf,MAAM,OAAO,CAAA;AAMd,MAAM,WAAW,iBAAiB;IAChC,0CAA0C;IAC1C,UAAU,EAAE,MAAM,CAAA;IAClB,yCAAyC;IACzC,SAAS,EAAE,MAAM,CAAA;IACjB,sEAAsE;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,8EAA8E;IAC9E,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAA;IAC/D,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,qCAAqC;IACrC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,uDAAuD;IACvD,KAAK,CAAC,EAAE,aAAa,CAAA;IACrB,QAAQ,EAAE,SAAS,CAAA;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,SAAS,CAAA;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,mGAAmG;IACnG,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACvB,6CAA6C;IAC7C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,qEAAqE;IACrE,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,yDAAyD;IACzD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,sFAAsF;IACtF,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,uCAAuC;IACvC,aAAa,CAAC,EAAE,MAAM,IAAI,CAAA;IAC1B,yGAAyG;IACzG,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;IAC1E,QAAQ,CAAC,EAAE,SAAS,CAAA;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,SAAS,GAAG,IAAI,CAAA;CAC9C;AAED,MAAM,WAAW,oBAAqB,SAAQ,cAAc,CAAC,KAAK,CAAC;CAAG;AAEtE,MAAM,WAAW,4BAA6B,SAAQ,cAAc,CAAC,KAAK,CAAC;CAAG;AAE9E,MAAM,WAAW,qBAAsB,SAAQ,cAAc,CAAC,KAAK,CAAC;IAClE,0CAA0C;IAC1C,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,SAAS,CAAA;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,CAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,KAAK,SAAS,CAAA;CAC/D;AA0BD,UAAU,aAAa,CAAC,CAAC;IACvB,CAAC,KAAK,EAAE,CAAC,GAAG,SAAS,CAAA;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;CACzB;AASD,wBAAgB,iBAAiB,CAC/B,QAAQ,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,GAC1C,aAAa,CAAC,uBAAuB,CAAC,CAExC;AAED,wBAAgB,iBAAiB,CAC/B,QAAQ,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,GAC1C,aAAa,CAAC,uBAAuB,CAAC,CAExC;AAED,wBAAgB,eAAe,CAC7B,QAAQ,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GACxC,aAAa,CAAC,qBAAqB,CAAC,CAEtC;AAED,wBAAgB,sBAAsB,CACpC,QAAQ,CAAC,EAAE,OAAO,CAAC,4BAA4B,CAAC,GAC/C,aAAa,CAAC,4BAA4B,CAAC,CAE7C;AAED,wBAAgB,gBAAgB,CAC9B,QAAQ,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GACzC,aAAa,CAAC,sBAAsB,CAAC,CAEvC;AAED,wBAAgB,iBAAiB,CAC/B,QAAQ,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,GAC1C,aAAa,CAAC,uBAAuB,CAAC,CAExC;AAED,wBAAgB,cAAc,CAC5B,QAAQ,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,GACvC,aAAa,CAAC,oBAAoB,CAAC,CAErC;AA+HD,iBAAS,gBAAgB,CAAC,EACxB,SAAS,EACT,KAAK,EACL,WAAW,EACX,OAAO,EACP,GAAG,IAAI,EACR,EAAE,qBAAqB,+BAcvB;AAqCD,iBAAS,gBAAgB,CAAC,EACxB,UAAU,EACV,SAAS,EACT,QAAY,EACZ,aAAa,EACb,SAAS,EACT,KAAK,EAAE,SAAS,EAChB,YAAY,EAAE,SAAS,EACvB,QAAQ,GACT,EAAE,iBAAiB,+BAgTnB;AAID,eAAO,MAAM,YAAY;;;;;;;;;CASvB,CAAA"}
1
+ {"version":3,"file":"VirtualTable.d.ts","sourceRoot":"","sources":["../src/VirtualTable.tsx"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,aAAa,EAElB,KAAK,cAAc,EAEnB,KAAK,SAAS,EAMf,MAAM,OAAO,CAAA;AAMd,MAAM,WAAW,iBAAiB;IAChC,0CAA0C;IAC1C,UAAU,EAAE,MAAM,CAAA;IAClB,yCAAyC;IACzC,SAAS,EAAE,MAAM,CAAA;IACjB,sEAAsE;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,8EAA8E;IAC9E,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAA;IAC/D,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,qCAAqC;IACrC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,uDAAuD;IACvD,KAAK,CAAC,EAAE,aAAa,CAAA;IACrB,QAAQ,EAAE,SAAS,CAAA;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,SAAS,CAAA;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,mGAAmG;IACnG,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACvB,6CAA6C;IAC7C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,qEAAqE;IACrE,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,yDAAyD;IACzD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,sFAAsF;IACtF,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,uCAAuC;IACvC,aAAa,CAAC,EAAE,MAAM,IAAI,CAAA;IAC1B,yGAAyG;IACzG,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;IAC1E,QAAQ,CAAC,EAAE,SAAS,CAAA;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,SAAS,GAAG,IAAI,CAAA;CAC9C;AAED,MAAM,WAAW,oBAAqB,SAAQ,cAAc,CAAC,KAAK,CAAC;CAAG;AAEtE,MAAM,WAAW,4BAA6B,SAAQ,cAAc,CAAC,KAAK,CAAC;CAAG;AAE9E,MAAM,WAAW,qBAAsB,SAAQ,cAAc,CAAC,KAAK,CAAC;IAClE,0CAA0C;IAC1C,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,SAAS,CAAA;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,CAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,KAAK,SAAS,CAAA;CAC/D;AA0BD,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,CAAC,KAAK,EAAE,CAAC,GAAG,SAAS,CAAA;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;CACzB;AASD,wBAAgB,iBAAiB,CAC/B,QAAQ,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,GAC1C,aAAa,CAAC,uBAAuB,CAAC,CAExC;AAED,wBAAgB,iBAAiB,CAC/B,QAAQ,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,GAC1C,aAAa,CAAC,uBAAuB,CAAC,CAExC;AAED,wBAAgB,eAAe,CAC7B,QAAQ,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GACxC,aAAa,CAAC,qBAAqB,CAAC,CAEtC;AAED,wBAAgB,sBAAsB,CACpC,QAAQ,CAAC,EAAE,OAAO,CAAC,4BAA4B,CAAC,GAC/C,aAAa,CAAC,4BAA4B,CAAC,CAE7C;AAED,wBAAgB,gBAAgB,CAC9B,QAAQ,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GACzC,aAAa,CAAC,sBAAsB,CAAC,CAEvC;AAED,wBAAgB,iBAAiB,CAC/B,QAAQ,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,GAC1C,aAAa,CAAC,uBAAuB,CAAC,CAExC;AAED,wBAAgB,cAAc,CAC5B,QAAQ,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,GACvC,aAAa,CAAC,oBAAoB,CAAC,CAErC;AA+HD,iBAAS,gBAAgB,CAAC,EACxB,SAAS,EACT,KAAK,EACL,WAAW,EACX,OAAO,EACP,GAAG,IAAI,EACR,EAAE,qBAAqB,+BAcvB;AAqCD,iBAAS,gBAAgB,CAAC,EACxB,UAAU,EACV,SAAS,EACT,QAAY,EACZ,aAAa,EACb,SAAS,EACT,KAAK,EAAE,SAAS,EAChB,YAAY,EAAE,SAAS,EACvB,QAAQ,GACT,EAAE,iBAAiB,+BAgTnB;AAID,eAAO,MAAM,YAAY;;;;;;;;;CASvB,CAAA"}
package/dist/index.d.ts CHANGED
@@ -1,7 +1,26 @@
1
- export { VirtualTable } from './VirtualTable.tsx';
2
- export { createTableHeader, createTableColumn, createTableBody, createTableSkeletonRow, createTableEmpty, createTableFooter, createTableRow, } from './VirtualTable.tsx';
3
- export type { VirtualTableProps, VirtualTableHeaderProps, VirtualTableColumnProps, VirtualTableBodyProps, VirtualTableSkeletonRowProps, VirtualTableRowProps, VirtualTableCellProps, VirtualTableEmptyProps, VirtualTableFooterProps, } from './VirtualTable.tsx';
4
- export { useTableCache } from './useTableCache.ts';
1
+ import { createTableHeader as _createTableHeader, createTableColumn as _createTableColumn, createTableBody as _createTableBody, createTableSkeletonRow as _createTableSkeletonRow, createTableEmpty as _createTableEmpty, createTableFooter as _createTableFooter, createTableRow as _createTableRow } from './VirtualTable.tsx';
2
+ export type { SlotComponent, VirtualTableProps, VirtualTableHeaderProps, VirtualTableColumnProps, VirtualTableBodyProps, VirtualTableSkeletonRowProps, VirtualTableRowProps, VirtualTableCellProps, VirtualTableEmptyProps, VirtualTableFooterProps, } from './VirtualTable.tsx';
3
+ import { useTableCache as _useTableCache } from './useTableCache.ts';
5
4
  export type { UseTableCacheOptions, TableCache } from './useTableCache.ts';
6
- export { useTableColumnWidths } from './useTableColumnWidths.ts';
5
+ import { useTableColumnWidths as _useTableColumnWidths } from './useTableColumnWidths.ts';
6
+ declare const VirtualTable: (({ totalCount, rowHeight, overscan, onRangeChange, className, style: styleProp, "aria-label": ariaLabel, children, }: import("./VirtualTable.tsx").VirtualTableProps) => import("react").JSX.Element) & {
7
+ Header: import("./VirtualTable.tsx").SlotComponent<import("./VirtualTable.tsx").VirtualTableHeaderProps>;
8
+ Column: import("./VirtualTable.tsx").SlotComponent<import("./VirtualTable.tsx").VirtualTableColumnProps>;
9
+ Body: import("./VirtualTable.tsx").SlotComponent<import("./VirtualTable.tsx").VirtualTableBodyProps>;
10
+ SkeletonRow: import("./VirtualTable.tsx").SlotComponent<import("./VirtualTable.tsx").VirtualTableSkeletonRowProps>;
11
+ Row: import("./VirtualTable.tsx").SlotComponent<import("./VirtualTable.tsx").VirtualTableRowProps>;
12
+ Cell: ({ className, style, showOnHover, colSpan, ...rest }: import("./VirtualTable.tsx").VirtualTableCellProps) => import("react").JSX.Element;
13
+ Empty: import("./VirtualTable.tsx").SlotComponent<import("./VirtualTable.tsx").VirtualTableEmptyProps>;
14
+ Footer: import("./VirtualTable.tsx").SlotComponent<import("./VirtualTable.tsx").VirtualTableFooterProps>;
15
+ };
16
+ declare const createTableHeader: typeof _createTableHeader;
17
+ declare const createTableColumn: typeof _createTableColumn;
18
+ declare const createTableBody: typeof _createTableBody;
19
+ declare const createTableSkeletonRow: typeof _createTableSkeletonRow;
20
+ declare const createTableEmpty: typeof _createTableEmpty;
21
+ declare const createTableFooter: typeof _createTableFooter;
22
+ declare const createTableRow: typeof _createTableRow;
23
+ declare const useTableCache: typeof _useTableCache;
24
+ declare const useTableColumnWidths: typeof _useTableColumnWidths;
25
+ export { VirtualTable, createTableHeader, createTableColumn, createTableBody, createTableSkeletonRow, createTableEmpty, createTableFooter, createTableRow, useTableCache, useTableColumnWidths, };
7
26
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,sBAAsB,EACtB,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,GACf,MAAM,oBAAoB,CAAA;AAC3B,YAAY,EACV,iBAAiB,EACjB,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,EACrB,4BAA4B,EAC5B,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,GACxB,MAAM,oBAAoB,CAAA;AAE3B,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,YAAY,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAE1E,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAEL,iBAAiB,IAAI,kBAAkB,EACvC,iBAAiB,IAAI,kBAAkB,EACvC,eAAe,IAAI,gBAAgB,EACnC,sBAAsB,IAAI,uBAAuB,EACjD,gBAAgB,IAAI,iBAAiB,EACrC,iBAAiB,IAAI,kBAAkB,EACvC,cAAc,IAAI,eAAe,EAClC,MAAM,oBAAoB,CAAA;AAC3B,YAAY,EACV,aAAa,EACb,iBAAiB,EACjB,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,EACrB,4BAA4B,EAC5B,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,GACxB,MAAM,oBAAoB,CAAA;AAE3B,OAAO,EAAE,aAAa,IAAI,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACpE,YAAY,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAE1E,OAAO,EAAE,oBAAoB,IAAI,qBAAqB,EAAE,MAAM,2BAA2B,CAAA;AAEzF,QAAA,MAAM,YAAY;;;;;;;;;CAAgB,CAAA;AAClC,QAAA,MAAM,iBAAiB,2BAAqB,CAAA;AAC5C,QAAA,MAAM,iBAAiB,2BAAqB,CAAA;AAC5C,QAAA,MAAM,eAAe,yBAAmB,CAAA;AACxC,QAAA,MAAM,sBAAsB,gCAA0B,CAAA;AACtD,QAAA,MAAM,gBAAgB,0BAAoB,CAAA;AAC1C,QAAA,MAAM,iBAAiB,2BAAqB,CAAA;AAC5C,QAAA,MAAM,cAAc,wBAAkB,CAAA;AACtC,QAAA,MAAM,aAAa,uBAAiB,CAAA;AACpC,QAAA,MAAM,oBAAoB,8BAAwB,CAAA;AAElD,OAAO,EACL,YAAY,EACZ,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,sBAAsB,EACtB,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EACd,aAAa,EACb,oBAAoB,GACrB,CAAA"}