@tanstack/vue-table 9.2.4 → 9.2.5

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.
Files changed (10) hide show
  1. package/dist/FlexRender.d.ts +5 -6
  2. package/dist/createTableHook.d.ts +17 -18
  3. package/dist/useTable.d.ts +4 -5
  4. package/package.json +6 -6
  5. package/skills/create-table-hook/SKILL.md +1 -1
  6. package/skills/getting-started/SKILL.md +1 -1
  7. package/skills/migrate-v8-to-v9/SKILL.md +1 -1
  8. package/skills/table-state/SKILL.md +1 -1
  9. package/skills/with-tanstack-query/SKILL.md +1 -1
  10. package/skills/with-tanstack-virtual/SKILL.md +1 -1
package/dist/FlexRender.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  //#region src/FlexRender.d.ts
2
- interface FlexRenderCell {
2
+ export interface FlexRenderCell {
3
3
  column: {
4
4
  columnDef: {
5
5
  aggregatedCell?: any;
@@ -10,7 +10,7 @@ interface FlexRenderCell {
10
10
  getIsAggregated?: () => boolean;
11
11
  getIsPlaceholder?: () => boolean;
12
12
  }
13
- interface FlexRenderHeader {
13
+ export interface FlexRenderHeader {
14
14
  column: {
15
15
  columnDef: {
16
16
  footer?: any;
@@ -23,7 +23,7 @@ interface FlexRenderHeader {
23
23
  * If rendering headers, cells, or footers with custom markup, use flexRender instead of `cell.getValue()` or `cell.renderValue()`.
24
24
  * @example flexRender(cell.column.columnDef.cell, cell.getContext())
25
25
  */
26
- declare function flexRender(render: any, props: any): any;
26
+ export declare function flexRender(render: any, props: any): any;
27
27
  /**
28
28
  * Simplified component for rendering headers, cells, or footers.
29
29
  *
@@ -39,7 +39,7 @@ declare function flexRender(render: any, props: any): any;
39
39
  * <FlexRender :render="cell.column.columnDef.cell" :props="cell.getContext()" />
40
40
  * ```
41
41
  */
42
- declare const FlexRender: import("vue").DefineComponent<{
42
+ export declare const FlexRender: import("vue").DefineComponent<{
43
43
  render?: any;
44
44
  props?: any;
45
45
  cell?: FlexRenderCell | undefined;
@@ -58,5 +58,4 @@ declare const FlexRender: import("vue").DefineComponent<{
58
58
  header: FlexRenderHeader;
59
59
  footer: FlexRenderHeader;
60
60
  }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
61
- //#endregion
62
- export { FlexRender, FlexRenderCell, FlexRenderHeader, flexRender };
61
+ //#endregion
package/dist/createTableHook.d.ts CHANGED
@@ -3,8 +3,8 @@ import { TableOptionsWithReactiveData, VueTable } from "./useTable.js";
3
3
  import { Component, PropType } from "vue";
4
4
  import { AccessorFn, AccessorFnColumnDef, AccessorKeyColumnDef, Cell, CellContext, CellData, Column, ColumnDef, DeepKeys, DeepValue, DisplayColumnDef, GroupColumnDef, Header, IdentifiedColumnDef, NoInfer, Row, RowData, Table, TableFeatures } from "@tanstack/table-core";
5
5
  //#region src/createTableHook.d.ts
6
- type ComponentType<T extends Record<string, any>> = Component<T>;
7
- type AppCellContext<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData, TCellComponents extends Record<string, ComponentType<any>>> = {
6
+ export type ComponentType<T extends Record<string, any>> = Component<T>;
7
+ export type AppCellContext<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData, TCellComponents extends Record<string, ComponentType<any>>> = {
8
8
  cell: Cell<TFeatures, TData, TValue> & TCellComponents & {
9
9
  FlexRender: Component;
10
10
  };
@@ -14,31 +14,31 @@ type AppCellContext<TFeatures extends TableFeatures, TData extends RowData, TVal
14
14
  row: Row<TFeatures, TData>;
15
15
  table: Table<TFeatures, TData>;
16
16
  };
17
- type AppHeaderContext<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData, THeaderComponents extends Record<string, ComponentType<any>>> = {
17
+ export type AppHeaderContext<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData, THeaderComponents extends Record<string, ComponentType<any>>> = {
18
18
  column: Column<TFeatures, TData, TValue>;
19
19
  header: Header<TFeatures, TData, TValue> & THeaderComponents & {
20
20
  FlexRender: Component;
21
21
  };
22
22
  table: Table<TFeatures, TData>;
23
23
  };
24
- type AppColumnDefTemplate<TProps extends object> = string | ((props: TProps) => any);
25
- type AppColumnDefBase<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData, TCellComponents extends Record<string, ComponentType<any>>, THeaderComponents extends Record<string, ComponentType<any>>> = Omit<IdentifiedColumnDef<TFeatures, TData, TValue>, 'cell' | 'header' | 'footer'> & {
24
+ export type AppColumnDefTemplate<TProps extends object> = string | ((props: TProps) => any);
25
+ export type AppColumnDefBase<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData, TCellComponents extends Record<string, ComponentType<any>>, THeaderComponents extends Record<string, ComponentType<any>>> = Omit<IdentifiedColumnDef<TFeatures, TData, TValue>, 'cell' | 'header' | 'footer'> & {
26
26
  cell?: AppColumnDefTemplate<AppCellContext<TFeatures, TData, TValue, TCellComponents>>;
27
27
  header?: AppColumnDefTemplate<AppHeaderContext<TFeatures, TData, TValue, THeaderComponents>>;
28
28
  footer?: AppColumnDefTemplate<AppHeaderContext<TFeatures, TData, TValue, THeaderComponents>>;
29
29
  };
30
- type AppDisplayColumnDef<TFeatures extends TableFeatures, TData extends RowData, TCellComponents extends Record<string, ComponentType<any>>, THeaderComponents extends Record<string, ComponentType<any>>> = Omit<DisplayColumnDef<TFeatures, TData, unknown>, 'cell' | 'header' | 'footer'> & {
30
+ export type AppDisplayColumnDef<TFeatures extends TableFeatures, TData extends RowData, TCellComponents extends Record<string, ComponentType<any>>, THeaderComponents extends Record<string, ComponentType<any>>> = Omit<DisplayColumnDef<TFeatures, TData, unknown>, 'cell' | 'header' | 'footer'> & {
31
31
  cell?: AppColumnDefTemplate<AppCellContext<TFeatures, TData, unknown, TCellComponents>>;
32
32
  header?: AppColumnDefTemplate<AppHeaderContext<TFeatures, TData, unknown, THeaderComponents>>;
33
33
  footer?: AppColumnDefTemplate<AppHeaderContext<TFeatures, TData, unknown, THeaderComponents>>;
34
34
  };
35
- type AppGroupColumnDef<TFeatures extends TableFeatures, TData extends RowData, TCellComponents extends Record<string, ComponentType<any>>, THeaderComponents extends Record<string, ComponentType<any>>> = Omit<GroupColumnDef<TFeatures, TData, unknown>, 'cell' | 'header' | 'footer' | 'columns'> & {
35
+ export type AppGroupColumnDef<TFeatures extends TableFeatures, TData extends RowData, TCellComponents extends Record<string, ComponentType<any>>, THeaderComponents extends Record<string, ComponentType<any>>> = Omit<GroupColumnDef<TFeatures, TData, unknown>, 'cell' | 'header' | 'footer' | 'columns'> & {
36
36
  cell?: AppColumnDefTemplate<AppCellContext<TFeatures, TData, unknown, TCellComponents>>;
37
37
  header?: AppColumnDefTemplate<AppHeaderContext<TFeatures, TData, unknown, THeaderComponents>>;
38
38
  footer?: AppColumnDefTemplate<AppHeaderContext<TFeatures, TData, unknown, THeaderComponents>>;
39
39
  columns?: ReadonlyArray<ColumnDef<TFeatures, TData, unknown>>;
40
40
  };
41
- type AppColumnHelper<TFeatures extends TableFeatures, TData extends RowData, TCellComponents extends Record<string, ComponentType<any>>, THeaderComponents extends Record<string, ComponentType<any>>> = {
41
+ export type AppColumnHelper<TFeatures extends TableFeatures, TData extends RowData, TCellComponents extends Record<string, ComponentType<any>>, THeaderComponents extends Record<string, ComponentType<any>>> = {
42
42
  accessor: <TAccessor extends AccessorFn<TData> | DeepKeys<TData>, TValue extends (TAccessor extends AccessorFn<TData, infer TReturn> ? TReturn : TAccessor extends DeepKeys<TData> ? DeepValue<TData, TAccessor> : never)>(accessor: TAccessor, column: TAccessor extends AccessorFn<TData> ? AppColumnDefBase<TFeatures, TData, TValue, TCellComponents, THeaderComponents> & {
43
43
  id: string;
44
44
  } : AppColumnDefBase<TFeatures, TData, TValue, TCellComponents, THeaderComponents>) => TAccessor extends AccessorFn<TData> ? AccessorFnColumnDef<TFeatures, TData, TValue> : AccessorKeyColumnDef<TFeatures, TData, TValue>;
@@ -46,26 +46,26 @@ type AppColumnHelper<TFeatures extends TableFeatures, TData extends RowData, TCe
46
46
  display: (column: AppDisplayColumnDef<TFeatures, TData, TCellComponents, THeaderComponents>) => DisplayColumnDef<TFeatures, TData, unknown>;
47
47
  group: (column: AppGroupColumnDef<TFeatures, TData, TCellComponents, THeaderComponents>) => GroupColumnDef<TFeatures, TData, unknown>;
48
48
  };
49
- type CreateTableHookOptions<TFeatures extends TableFeatures, TTableComponents extends Record<string, ComponentType<any>>, TCellComponents extends Record<string, ComponentType<any>>, THeaderComponents extends Record<string, ComponentType<any>>> = Omit<TableOptionsWithReactiveData<TFeatures, any>, 'columns' | 'data' | 'store' | 'state' | 'initialState'> & {
49
+ export type CreateTableHookOptions<TFeatures extends TableFeatures, TTableComponents extends Record<string, ComponentType<any>>, TCellComponents extends Record<string, ComponentType<any>>, THeaderComponents extends Record<string, ComponentType<any>>> = Omit<TableOptionsWithReactiveData<TFeatures, any>, 'columns' | 'data' | 'store' | 'state' | 'initialState'> & {
50
50
  tableComponents?: TTableComponents;
51
51
  cellComponents?: TCellComponents;
52
52
  headerComponents?: THeaderComponents;
53
53
  };
54
- interface AppTableProps {}
55
- interface AppCellProps<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData> {
54
+ export interface AppTableProps {}
55
+ export interface AppCellProps<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData> {
56
56
  cell: Cell<TFeatures, TData, TValue>;
57
57
  }
58
- interface AppHeaderProps<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData> {
58
+ export interface AppHeaderProps<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData> {
59
59
  header: Header<TFeatures, TData, TValue>;
60
60
  }
61
- type AppVueTable<TFeatures extends TableFeatures, TData extends RowData, TTableComponents extends Record<string, ComponentType<any>>, _TCellComponents extends Record<string, ComponentType<any>>, _THeaderComponents extends Record<string, ComponentType<any>>> = VueTable<TFeatures, TData> & NoInfer<TTableComponents> & {
61
+ export type AppVueTable<TFeatures extends TableFeatures, TData extends RowData, TTableComponents extends Record<string, ComponentType<any>>, _TCellComponents extends Record<string, ComponentType<any>>, _THeaderComponents extends Record<string, ComponentType<any>>> = VueTable<TFeatures, TData> & NoInfer<TTableComponents> & {
62
62
  AppTable: Component<AppTableProps>;
63
63
  AppCell: Component<AppCellProps<TFeatures, TData>>;
64
64
  AppHeader: Component<AppHeaderProps<TFeatures, TData>>;
65
65
  AppFooter: Component<AppHeaderProps<TFeatures, TData>>;
66
66
  FlexRender: typeof AppFlexRender;
67
67
  };
68
- interface CreateTableHookResult<TFeatures extends TableFeatures, TTableComponents extends Record<string, ComponentType<any>>, TCellComponents extends Record<string, ComponentType<any>>, THeaderComponents extends Record<string, ComponentType<any>>> {
68
+ export interface CreateTableHookResult<TFeatures extends TableFeatures, TTableComponents extends Record<string, ComponentType<any>>, TCellComponents extends Record<string, ComponentType<any>>, THeaderComponents extends Record<string, ComponentType<any>>> {
69
69
  /** The features object that was passed to `createTableHook`. */
70
70
  appFeatures: TFeatures;
71
71
  /**
@@ -100,7 +100,7 @@ interface CreateTableHookResult<TFeatures extends TableFeatures, TTableComponent
100
100
  FlexRender: Component;
101
101
  };
102
102
  }
103
- declare const AppFlexRender: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
103
+ export declare const AppFlexRender: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
104
104
  cell: {
105
105
  type: PropType<FlexRenderCell>;
106
106
  default: undefined;
@@ -150,6 +150,5 @@ declare const AppFlexRender: import("vue").DefineComponent<import("vue").Extract
150
150
  * })
151
151
  * ```
152
152
  */
153
- declare function createTableHook<TFeatures extends TableFeatures, const TTableComponents extends Record<string, ComponentType<any>>, const TCellComponents extends Record<string, ComponentType<any>>, const THeaderComponents extends Record<string, ComponentType<any>>>({ tableComponents, cellComponents, headerComponents, ...defaultTableOptions }: CreateTableHookOptions<TFeatures, TTableComponents, TCellComponents, THeaderComponents>): CreateTableHookResult<TFeatures, TTableComponents, TCellComponents, THeaderComponents>;
154
- //#endregion
155
- export { AppCellContext, AppCellProps, AppColumnDefBase, AppColumnDefTemplate, AppColumnHelper, AppDisplayColumnDef, AppFlexRender, AppGroupColumnDef, AppHeaderContext, AppHeaderProps, AppTableProps, AppVueTable, ComponentType, CreateTableHookOptions, CreateTableHookResult, createTableHook };
153
+ export declare function createTableHook<TFeatures extends TableFeatures, const TTableComponents extends Record<string, ComponentType<any>>, const TCellComponents extends Record<string, ComponentType<any>>, const THeaderComponents extends Record<string, ComponentType<any>>>({ tableComponents, cellComponents, headerComponents, ...defaultTableOptions }: CreateTableHookOptions<TFeatures, TTableComponents, TCellComponents, THeaderComponents>): CreateTableHookResult<TFeatures, TTableComponents, TCellComponents, THeaderComponents>;
154
+ //#endregion
package/dist/useTable.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  import { MaybeRef, VNode } from "vue";
2
2
  import { RowData, Table, TableFeatures, TableOptions } from "@tanstack/table-core";
3
3
  //#region src/useTable.d.ts
4
- type TableOptionsWithReactiveData<TFeatures extends TableFeatures, TData extends RowData> = { [K in keyof TableOptions<TFeatures, TData>]: K extends 'data' ? MaybeRef<ReadonlyArray<TData>> : MaybeRef<TableOptions<TFeatures, TData>[K]>; };
5
- type VueTable<TFeatures extends TableFeatures, TData extends RowData> = Table<TFeatures, TData> & {
4
+ export type TableOptionsWithReactiveData<TFeatures extends TableFeatures, TData extends RowData> = { [K in keyof TableOptions<TFeatures, TData>]: K extends 'data' ? MaybeRef<ReadonlyArray<TData>> : MaybeRef<TableOptions<TFeatures, TData>[K]>; };
5
+ export type VueTable<TFeatures extends TableFeatures, TData extends RowData> = Table<TFeatures, TData> & {
6
6
  /** Creates a reactive render boundary. The child function reads the table
7
7
  * atoms it needs, so Vue only tracks those atom reads.
8
8
  */
@@ -29,6 +29,5 @@ type VueTable<TFeatures extends TableFeatures, TData extends RowData> = Table<TF
29
29
  * )
30
30
  * ```
31
31
  */
32
- declare function useTable<TFeatures extends TableFeatures, TData extends RowData>(tableOptions: TableOptions<TFeatures, TData> | TableOptionsWithReactiveData<TFeatures, TData>): VueTable<TFeatures, TData>;
33
- //#endregion
34
- export { TableOptionsWithReactiveData, VueTable, useTable };
32
+ export declare function useTable<TFeatures extends TableFeatures, TData extends RowData>(tableOptions: TableOptions<TFeatures, TData> | TableOptionsWithReactiveData<TFeatures, TData>): VueTable<TFeatures, TData>;
33
+ //#endregion
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tanstack/vue-table",
3
- "version": "9.2.4",
3
+ "version": "9.2.5",
4
4
  "description": "Headless UI for building powerful tables & datagrids for Vue.",
5
5
  "author": "Tanner Linsley",
6
6
  "license": "MIT",
@@ -39,14 +39,14 @@
39
39
  "skills"
40
40
  ],
41
41
  "dependencies": {
42
- "@tanstack/store": "^0.11.1",
43
- "@tanstack/table-core": "9.2.4"
42
+ "@tanstack/store": "^0.11.2",
43
+ "@tanstack/table-core": "9.2.5"
44
44
  },
45
45
  "devDependencies": {
46
46
  "@testing-library/vue": "^8.1.0",
47
- "@vitejs/plugin-vue": "^6.0.8",
48
- "eslint-plugin-vue": "^10.10.0",
49
- "vue": "^3.5.41"
47
+ "@vitejs/plugin-vue": "^6.0.9",
48
+ "eslint-plugin-vue": "^10.11.1",
49
+ "vue": "^3.5.43"
50
50
  },
51
51
  "peerDependencies": {
52
52
  "vue": ">=3.2"
package/skills/create-table-hook/SKILL.md CHANGED
@@ -6,7 +6,7 @@ metadata:
6
6
  type: framework
7
7
  library: '@tanstack/vue-table'
8
8
  framework: vue
9
- library_version: '9.2.4'
9
+ library_version: '9.2.5'
10
10
  requires:
11
11
  - '@tanstack/table-core#core'
12
12
  - getting-started
package/skills/getting-started/SKILL.md CHANGED
@@ -6,7 +6,7 @@ metadata:
6
6
  type: framework
7
7
  library: '@tanstack/vue-table'
8
8
  framework: vue
9
- library_version: '9.2.4'
9
+ library_version: '9.2.5'
10
10
  requires:
11
11
  - '@tanstack/table-core#core'
12
12
  - '@tanstack/table-core#table-features'
package/skills/migrate-v8-to-v9/SKILL.md CHANGED
@@ -6,7 +6,7 @@ metadata:
6
6
  type: lifecycle
7
7
  library: '@tanstack/vue-table'
8
8
  framework: vue
9
- library_version: '9.2.4'
9
+ library_version: '9.2.5'
10
10
  requires:
11
11
  - '@tanstack/table-core#migrate-v8-to-v9'
12
12
  - getting-started
package/skills/table-state/SKILL.md CHANGED
@@ -6,7 +6,7 @@ metadata:
6
6
  type: framework
7
7
  library: '@tanstack/vue-table'
8
8
  framework: vue
9
- library_version: '9.2.4'
9
+ library_version: '9.2.5'
10
10
  requires:
11
11
  - '@tanstack/table-core#core'
12
12
  - getting-started
package/skills/with-tanstack-query/SKILL.md CHANGED
@@ -6,7 +6,7 @@ metadata:
6
6
  type: composition
7
7
  library: '@tanstack/vue-table'
8
8
  framework: vue
9
- library_version: '9.2.4'
9
+ library_version: '9.2.5'
10
10
  requires:
11
11
  - '@tanstack/table-core#client-vs-server'
12
12
  - getting-started
package/skills/with-tanstack-virtual/SKILL.md CHANGED
@@ -6,7 +6,7 @@ metadata:
6
6
  type: composition
7
7
  library: '@tanstack/vue-table'
8
8
  framework: vue
9
- library_version: '9.2.4'
9
+ library_version: '9.2.5'
10
10
  requires:
11
11
  - '@tanstack/table-core#core'
12
12
  - getting-started