Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/framework/angular/reference/functions/injectTable.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: injectTable
function injectTable<TFeatures, TData, TSelected>(options, selector): AngularTable<TFeatures, TData, TSelected>;
```

Defined in: [injectTable.ts:125](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L125)
Defined in: [injectTable.ts:124](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L124)

Creates and returns an Angular-reactive table instance.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: AngularTableComputed

# Interface: AngularTableComputed()\<TFeatures\>

Defined in: [injectTable.ts:32](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L32)
Defined in: [injectTable.ts:28](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L28)

Store mode: pass `selector` (required) to project from full table state.
Source mode: pass `source` (atom or store); omit `selector` for the whole value
Expand All @@ -24,7 +24,7 @@ inference.
AngularTableComputed<TSourceValue>(props): Signal<Readonly<TSourceValue>>;
```

Defined in: [injectTable.ts:33](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L33)
Defined in: [injectTable.ts:29](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L29)

Store mode: pass `selector` (required) to project from full table state.
Source mode: pass `source` (atom or store); omit `selector` for the whole value
Expand Down Expand Up @@ -63,7 +63,7 @@ inference.
AngularTableComputed<TSourceValue, TSubSelected>(props): Signal<Readonly<TSubSelected>>;
```

Defined in: [injectTable.ts:38](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L38)
Defined in: [injectTable.ts:34](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L34)

Store mode: pass `selector` (required) to project from full table state.
Source mode: pass `source` (atom or store); omit `selector` for the whole value
Expand Down Expand Up @@ -106,7 +106,7 @@ inference.
AngularTableComputed<TSubSelected>(props): Signal<Readonly<TSubSelected>>;
```

Defined in: [injectTable.ts:43](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L43)
Defined in: [injectTable.ts:39](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L39)

Store mode: pass `selector` (required) to project from full table state.
Source mode: pass `source` (atom or store); omit `selector` for the whole value
Expand Down
38 changes: 28 additions & 10 deletions docs/framework/angular/reference/type-aliases/AngularTable.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,41 @@ title: AngularTable
type AngularTable<TFeatures, TData, TSelected> = Table<TFeatures, TData> & object;
```

Defined in: [injectTable.ts:49](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L49)
Defined in: [injectTable.ts:45](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L45)

## Type Declaration

### computed
### computed()

```ts
computed: AngularTableComputed<TFeatures>;
computed: <TSubSelected>(props) => Signal<Readonly<TSubSelected>>;
```

Alias: **`Subscribe`** — same function reference as `computed` (naming parity with other adapters).
Creates a computed that subscribe to changes in the table store with a custom selector.
Default equality function is "shallow".

#### Type Parameters

##### TSubSelected

`TSubSelected` = \{
\}

#### Parameters

##### props

###### equal?

`ValueEqualityFn`\<`TSubSelected`\>

###### selector

(`state`) => `TSubSelected`

#### Returns

`Signal`\<`Readonly`\<`TSubSelected`\>\>

### state

Expand All @@ -29,12 +53,6 @@ readonly state: Signal<Readonly<TSelected>>;

The selected state from the table store, based on the selector provided.

### Subscribe

```ts
Subscribe: AngularTableComputed<TFeatures>;
```

### value

```ts
Expand Down
2 changes: 1 addition & 1 deletion docs/framework/react/reference/index/functions/useTable.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: useTable
function useTable<TFeatures, TData, TSelected>(tableOptions, selector): ReactTable<TFeatures, TData, TSelected>;
```

Defined in: [useTable.ts:114](https://github.com/TanStack/table/blob/main/packages/react-table/src/useTable.ts#L114)
Defined in: [useTable.ts:112](https://github.com/TanStack/table/blob/main/packages/react-table/src/useTable.ts#L112)

## Type Parameters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Defined in: [createTableHook.tsx:321](https://github.com/TanStack/table/blob/mai

##### cell

`Cell_Cell`\<`TFeatures`, `TData`, `TValue`\> & `UnionToIntersection`\<`"columnGroupingFeature"` *extends* keyof `TFeatures` ? `Cell_ColumnGrouping` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: TFeatures\[K\] extends TableFeature\<FeatureConstructorOptions\> ? "Cell" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof FeatureConstructorOptions & "Cell"\] : never : any \}\[keyof `TFeatures`\]\> & `Cell_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `TCellComponents` & `object`
`Cell_Cell`\<`TFeatures`, `TData`, `TValue`\> & `UnionToIntersection`\<`"columnGroupingFeature"` *extends* keyof `TFeatures` ? `Cell_ColumnGrouping` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: K extends "coreReativityFeature" ? never : TFeatures\[K\] extends TableFeature\<FeatureConstructorOptions\> ? "Cell" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof (...) & "Cell"\] : never : any \}\[keyof `TFeatures`\]\> & `Cell_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `TCellComponents` & `object`

##### state

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Defined in: [createTableHook.tsx:303](https://github.com/TanStack/table/blob/mai

##### cell

`Cell_Cell`\<`TFeatures`, `TData`, `TValue`\> & `UnionToIntersection`\<`"columnGroupingFeature"` *extends* keyof `TFeatures` ? `Cell_ColumnGrouping` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: TFeatures\[K\] extends TableFeature\<FeatureConstructorOptions\> ? "Cell" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof FeatureConstructorOptions & "Cell"\] : never : any \}\[keyof `TFeatures`\]\> & `Cell_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `TCellComponents` & `object`
`Cell_Cell`\<`TFeatures`, `TData`, `TValue`\> & `UnionToIntersection`\<`"columnGroupingFeature"` *extends* keyof `TFeatures` ? `Cell_ColumnGrouping` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: K extends "coreReativityFeature" ? never : TFeatures\[K\] extends TableFeature\<FeatureConstructorOptions\> ? "Cell" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof (...) & "Cell"\] : never : any \}\[keyof `TFeatures`\]\> & `Cell_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `TCellComponents` & `object`

#### Returns

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Defined in: [createTableHook.tsx:357](https://github.com/TanStack/table/blob/mai

`Header_Core`\<`TFeatures`, `TData`, `TValue`\> & `UnionToIntersection`\<
\| `"columnSizingFeature"` *extends* keyof `TFeatures` ? `Header_ColumnSizing` : `never`
\| `"columnResizingFeature"` *extends* keyof `TFeatures` ? `Header_ColumnResizing` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: TFeatures\[K\] extends TableFeature\<FeatureConstructorOptions\> ? "Header" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof FeatureConstructorOptions & "Header"\] : never : any \}\[keyof `TFeatures`\]\> & `Header_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `THeaderComponents` & `object`
\| `"columnResizingFeature"` *extends* keyof `TFeatures` ? `Header_ColumnResizing` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: K extends "coreReativityFeature" ? never : TFeatures\[K\] extends TableFeature\<FeatureConstructorOptions\> ? "Header" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof (...) & "Header"\] : never : any \}\[keyof `TFeatures`\]\> & `Header_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `THeaderComponents` & `object`

##### state

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Defined in: [createTableHook.tsx:339](https://github.com/TanStack/table/blob/mai

`Header_Core`\<`TFeatures`, `TData`, `TValue`\> & `UnionToIntersection`\<
\| `"columnSizingFeature"` *extends* keyof `TFeatures` ? `Header_ColumnSizing` : `never`
\| `"columnResizingFeature"` *extends* keyof `TFeatures` ? `Header_ColumnResizing` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: TFeatures\[K\] extends TableFeature\<FeatureConstructorOptions\> ? "Header" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof FeatureConstructorOptions & "Header"\] : never : any \}\[keyof `TFeatures`\]\> & `Header_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `THeaderComponents` & `object`
\| `"columnResizingFeature"` *extends* keyof `TFeatures` ? `Header_ColumnResizing` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: K extends "coreReativityFeature" ? never : TFeatures\[K\] extends TableFeature\<FeatureConstructorOptions\> ? "Header" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof (...) & "Header"\] : never : any \}\[keyof `TFeatures`\]\> & `Header_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `THeaderComponents` & `object`

#### Returns

Expand Down
18 changes: 2 additions & 16 deletions docs/framework/react/reference/index/type-aliases/ReactTable.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: ReactTable
type ReactTable<TFeatures, TData, TSelected> = Table<TFeatures, TData> & object;
```

Defined in: [useTable.ts:21](https://github.com/TanStack/table/blob/main/packages/react-table/src/useTable.ts#L21)
Defined in: [useTable.ts:22](https://github.com/TanStack/table/blob/main/packages/react-table/src/useTable.ts#L22)

## Type Declaration

Expand Down Expand Up @@ -56,25 +56,11 @@ flexRender(footer.column.columnDef.footer, footer.getContext())
### state

```ts
readonly state: Readonly<TSelected> & object;
readonly state: Readonly<TSelected>;
```

The selected state of the table. This state may not match the structure of `table.store.state` because it is selected by the `selector` function that you pass as the 2nd argument to `useTable`.

#### Type Declaration

##### columns

```ts
columns: TableOptions<TFeatures, TData>["columns"];
```

##### data

```ts
data: TableOptions<TFeatures, TData>["data"];
```

#### Example

```ts
Expand Down
38 changes: 0 additions & 38 deletions docs/reference/functions/constructReactivityFeature.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/reference/functions/constructTable.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: constructTable
function constructTable<TFeatures, TData>(tableOptions): Table<TFeatures, TData>;
```

Defined in: [core/table/constructTable.ts:20](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/constructTable.ts#L20)
Defined in: [core/table/constructTable.ts:21](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/constructTable.ts#L21)

## Type Parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/getInitialTableState.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: getInitialTableState
function getInitialTableState<TFeatures>(features, initialState): TableState<TFeatures>;
```

Defined in: [core/table/constructTable.ts:10](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/constructTable.ts#L10)
Defined in: [core/table/constructTable.ts:11](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/constructTable.ts#L11)

## Type Parameters

Expand Down
46 changes: 23 additions & 23 deletions docs/reference/functions/tableOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Defined in: [helpers/tableOptions.ts:16](https://github.com/TanStack/table/blob/
## Call Signature

```ts
function tableOptions<TFeatures, TData>(options): Omit<TableOptions<TFeatures, TData>, "_features">;
function tableOptions<TFeatures, TData>(options): Omit<TableOptions<TFeatures, TData>, "_features" | "data" | "columns"> & object;
```

Defined in: [helpers/tableOptions.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L27)
Expand All @@ -83,19 +83,19 @@ Defined in: [helpers/tableOptions.ts:27](https://github.com/TanStack/table/blob/

#### options

`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"_features"`\>
`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"data"` \| `"columns"`\> & `object`

### Returns

`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"_features"`\>
`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"_features"` \| `"data"` \| `"columns"`\> & `object`

## Call Signature

```ts
function tableOptions<TFeatures, TData>(options): Omit<TableOptions<TFeatures, TData>, "_features" | "data" | "columns"> & object;
function tableOptions<TFeatures, TData>(options): TableOptions<TFeatures, TData>;
```

Defined in: [helpers/tableOptions.ts:34](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L34)
Defined in: [helpers/tableOptions.ts:38](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L38)

### Type Parameters

Expand All @@ -111,19 +111,19 @@ Defined in: [helpers/tableOptions.ts:34](https://github.com/TanStack/table/blob/

#### options

`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"data"` \| `"columns"`\> & `object`
[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>

### Returns

`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"_features"` \| `"data"` \| `"columns"`\> & `object`
[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>

## Call Signature

```ts
function tableOptions<TFeatures, TData>(options): Omit<TableOptions<TFeatures, TData>, "data" | "_features">;
function tableOptions<TFeatures, TData>(options): Omit<TableOptions<TFeatures, TData>, "_features">;
```

Defined in: [helpers/tableOptions.ts:45](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L45)
Defined in: [helpers/tableOptions.ts:43](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L43)

### Type Parameters

Expand All @@ -139,19 +139,19 @@ Defined in: [helpers/tableOptions.ts:45](https://github.com/TanStack/table/blob/

#### options

`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"data"` \| `"_features"`\>
`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"_features"`\>

### Returns

`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"data"` \| `"_features"`\>
`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"_features"`\>

## Call Signature

```ts
function tableOptions<TFeatures, TData>(options): Omit<TableOptions<TFeatures, TData>, "columns" | "_features">;
function tableOptions<TFeatures, TData>(options): Omit<TableOptions<TFeatures, TData>, "data" | "_features">;
```

Defined in: [helpers/tableOptions.ts:52](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L52)
Defined in: [helpers/tableOptions.ts:50](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L50)

### Type Parameters

Expand All @@ -167,19 +167,19 @@ Defined in: [helpers/tableOptions.ts:52](https://github.com/TanStack/table/blob/

#### options

`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"columns"` \| `"_features"`\>
`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"data"` \| `"_features"`\>

### Returns

`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"columns"` \| `"_features"`\>
`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"data"` \| `"_features"`\>

## Call Signature

```ts
function tableOptions<TFeatures, TData>(options): Omit<TableOptions<TFeatures, TData>, "data" | "columns" | "_features">;
function tableOptions<TFeatures, TData>(options): Omit<TableOptions<TFeatures, TData>, "columns" | "_features">;
```

Defined in: [helpers/tableOptions.ts:59](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L59)
Defined in: [helpers/tableOptions.ts:57](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L57)

### Type Parameters

Expand All @@ -195,19 +195,19 @@ Defined in: [helpers/tableOptions.ts:59](https://github.com/TanStack/table/blob/

#### options

`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"data"` \| `"columns"` \| `"_features"`\>
`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"columns"` \| `"_features"`\>

### Returns

`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"data"` \| `"columns"` \| `"_features"`\>
`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"columns"` \| `"_features"`\>

## Call Signature

```ts
function tableOptions<TFeatures, TData>(options): TableOptions<TFeatures, TData>;
function tableOptions<TFeatures, TData>(options): Omit<TableOptions<TFeatures, TData>, "data" | "columns" | "_features">;
```

Defined in: [helpers/tableOptions.ts:69](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L69)
Defined in: [helpers/tableOptions.ts:64](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L64)

### Type Parameters

Expand All @@ -223,8 +223,8 @@ Defined in: [helpers/tableOptions.ts:69](https://github.com/TanStack/table/blob/

#### options

[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>
`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"data"` \| `"columns"` \| `"_features"`\>

### Returns

[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>
`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"data"` \| `"columns"` \| `"_features"`\>
2 changes: 0 additions & 2 deletions docs/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,6 @@ title: "@tanstack/table-core"
- [TableOptions\_RowSelection](interfaces/TableOptions_RowSelection.md)
- [TableOptions\_RowSorting](interfaces/TableOptions_RowSorting.md)
- [TableOptions\_Table](interfaces/TableOptions_Table.md)
- [TableReactivityFeatureConstructors](interfaces/TableReactivityFeatureConstructors.md)
- [TableState\_ColumnFiltering](interfaces/TableState_ColumnFiltering.md)
- [TableState\_ColumnGrouping](interfaces/TableState_ColumnGrouping.md)
- [TableState\_ColumnOrdering](interfaces/TableState_ColumnOrdering.md)
Expand Down Expand Up @@ -397,7 +396,6 @@ title: "@tanstack/table-core"
- [constructCoreTablesFeature](functions/constructCoreTablesFeature.md)
- [constructGlobalFilteringFeature](functions/constructGlobalFilteringFeature.md)
- [constructHeader](functions/constructHeader.md)
- [constructReactivityFeature](functions/constructReactivityFeature.md)
- [constructRow](functions/constructRow.md)
- [constructRowExpandingFeature](functions/constructRowExpandingFeature.md)
- [constructRowPaginationFeature](functions/constructRowPaginationFeature.md)
Expand Down
Loading
Loading