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>(options): AngularTable<TFeatures, TData>;
```

Defined in: [packages/angular-table/src/injectTable.ts:91](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L91)
Defined in: [packages/angular-table/src/injectTable.ts:92](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L92)

Creates and returns an Angular-reactive table instance.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: AngularTable
type AngularTable<TFeatures, TData> = Table<TFeatures, TData>;
```

Defined in: [packages/angular-table/src/injectTable.ts:30](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L30)
Defined in: [packages/angular-table/src/injectTable.ts:31](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L31)

## Type Parameters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ type SubscribeSource<TValue> =
| ReadonlyStore<TValue>;
```

Defined in: [packages/angular-table/src/injectTable.ts:24](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L24)
Defined in: [packages/angular-table/src/injectTable.ts:25](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L25)

## Type Parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/index/functions/assignPrototypeAPIs.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ function assignPrototypeAPIs<TFeatures, TData, TDeps, TDepArgs>(
apis): void;
```

Defined in: [utils.ts:403](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L403)
Defined in: [utils.ts:378](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L378)

Assigns API methods to a prototype object for memory-efficient method sharing.
All instances created with this prototype will share the same method references.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/index/functions/assignTableAPIs.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function assignTableAPIs<TFeatures, TData, TDeps, TDepArgs>(
apis): void;
```

Defined in: [utils.ts:361](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L361)
Defined in: [utils.ts:336](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L336)

Assigns Table API methods directly to the table instance.
Unlike row/cell/column/header, the table is a singleton so methods are assigned directly.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/index/functions/callMemoOrStaticFn.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ function callMemoOrStaticFn<TObject, TStaticFn>(
args): ReturnType<TStaticFn>;
```

Defined in: [utils.ts:451](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L451)
Defined in: [utils.ts:424](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L424)

Looks to run the memoized function with the builder pattern on the object if it exists, otherwise fallback to the static method passed in.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/index/functions/constructCell.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function constructCell<TFeatures, TData, TValue>(
table): Cell<TFeatures, TData, TValue>;
```

Defined in: [core/cells/constructCell.ts:31](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/constructCell.ts#L31)
Defined in: [core/cells/constructCell.ts:32](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/constructCell.ts#L32)

Constructs a cell instance from normalized table internals.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/index/functions/constructColumn.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ function constructColumn<TFeatures, TData, TValue>(
parent?): Column<TFeatures, TData, TValue>;
```

Defined in: [core/columns/constructColumn.ts:35](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/constructColumn.ts#L35)
Defined in: [core/columns/constructColumn.ts:36](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/constructColumn.ts#L36)

Constructs a column instance from normalized table internals.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: constructColumnVisibilityFeature
function constructColumnVisibilityFeature<TFeatures, TData>(): TableFeature<ColumnVisibilityFeatureConstructors<TFeatures, TData>>;
```

Defined in: [features/column-visibility/columnVisibilityFeature.ts:50](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.ts#L50)
Defined in: [features/column-visibility/columnVisibilityFeature.ts:51](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.ts#L51)

Creates the stock column visibility feature.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: constructCoreHeadersFeature
function constructCoreHeadersFeature<TFeatures, TData>(): TableFeature<CoreHeadersFeatureConstructors<TFeatures, TData>>;
```

Defined in: [core/headers/coreHeadersFeature.ts:36](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/coreHeadersFeature.ts#L36)
Defined in: [core/headers/coreHeadersFeature.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/coreHeadersFeature.ts#L27)

Creates the stock core headers feature.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/index/functions/constructHeader.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function constructHeader<TFeatures, TData, TValue>(
options): Header<TFeatures, TData, TValue>;
```

Defined in: [core/headers/constructHeader.ts:30](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/constructHeader.ts#L30)
Defined in: [core/headers/constructHeader.ts:31](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/constructHeader.ts#L31)

Constructs a header instance from normalized table internals.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/index/functions/constructRow.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ function constructRow<TFeatures, TData>(
parentId?): Row<TFeatures, TData>;
```

Defined in: [core/rows/constructRow.ts:29](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/constructRow.ts#L29)
Defined in: [core/rows/constructRow.ts:30](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/constructRow.ts#L30)

Constructs a row instance from normalized table internals.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/index/functions/flattenBy.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: flattenBy
function flattenBy<TNode>(arr, getChildren): TNode[];
```

Defined in: [utils.ts:88](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L88)
Defined in: [utils.ts:78](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L78)

Flattens a tree of nodes by recursively reading child nodes.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/index/functions/getFunctionNameInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: getFunctionNameInfo
function getFunctionNameInfo(staticFnName, splitBy): object;
```

Defined in: [utils.ts:344](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L344)
Defined in: [utils.ts:319](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L319)

Assumes that a function name is in the format of `parentName_fnKey` and returns the `fnKey` and `fnName` in the format of `parentName.fnKey`.

Expand Down
24 changes: 0 additions & 24 deletions docs/reference/index/functions/getMemoFnMeta.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/reference/index/functions/isFunction.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: isFunction
function isFunction<T>(d): d is T;
```

Defined in: [utils.ts:72](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L72)
Defined in: [utils.ts:69](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L69)

Returns whether a value is a function.

Expand Down
24 changes: 0 additions & 24 deletions docs/reference/index/functions/isNumberArray.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/reference/index/functions/makeStateUpdater.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: makeStateUpdater
function makeStateUpdater<TFeatures, K>(key, instance): (updater) => void;
```

Defined in: [utils.ts:56](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L56)
Defined in: [utils.ts:53](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L53)

Creates a table state updater for a single state slice.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/index/functions/memo.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: memo
function memo<TDeps, TDepArgs, TResult>(__namedParameters): (depArgs?) => TResult;
```

Defined in: [utils.ts:146](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L146)
Defined in: [utils.ts:113](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L113)

Creates a dependency-tracked memoized function for table internals.

Expand Down
18 changes: 0 additions & 18 deletions docs/reference/index/functions/noop.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/reference/index/functions/tableMemo.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: tableMemo
function tableMemo<TFeatures, TDeps, TDepArgs, TResult>(__namedParameters): (depArgs?) => TResult;
```

Defined in: [utils.ts:212](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L212)
Defined in: [utils.ts:182](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L182)

Creates a table-aware memoized function.

Expand Down
5 changes: 0 additions & 5 deletions docs/reference/index/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,6 @@ title: index
- [HeaderGroup](type-aliases/HeaderGroup.md)
- [IdentifiedColumnDef](type-aliases/IdentifiedColumnDef.md)
- [InitRowInstanceData](type-aliases/InitRowInstanceData.md)
- [MemoFnMeta](type-aliases/MemoFnMeta.md)
- [NoInfer](type-aliases/NoInfer.md)
- [OnChangeFn](type-aliases/OnChangeFn.md)
- [PartialKeys](type-aliases/PartialKeys.md)
Expand Down Expand Up @@ -313,7 +312,6 @@ title: index

## Variables

- [$internalMemoFnMeta](variables/$internalMemoFnMeta.md)
- [aggregationFn\_count](variables/aggregationFn_count.md)
- [aggregationFn\_extent](variables/aggregationFn_extent.md)
- [aggregationFn\_max](variables/aggregationFn_max.md)
Expand Down Expand Up @@ -418,12 +416,9 @@ title: index
- [functionalUpdate](functions/functionalUpdate.md)
- [getFunctionNameInfo](functions/getFunctionNameInfo.md)
- [getInitialTableState](functions/getInitialTableState.md)
- [getMemoFnMeta](functions/getMemoFnMeta.md)
- [isFunction](functions/isFunction.md)
- [isNumberArray](functions/isNumberArray.md)
- [makeStateUpdater](functions/makeStateUpdater.md)
- [memo](functions/memo.md)
- [noop](functions/noop.md)
- [tableFeatures](functions/tableFeatures.md)
- [tableMemo](functions/tableMemo.md)
- [tableOptions](functions/tableOptions.md)
6 changes: 3 additions & 3 deletions docs/reference/index/interfaces/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: API

# Interface: API\<TDeps, TDepArgs\>

Defined in: [utils.ts:331](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L331)
Defined in: [utils.ts:306](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L306)

## Type Parameters

Expand All @@ -25,7 +25,7 @@ Defined in: [utils.ts:331](https://github.com/TanStack/table/blob/main/packages/
fn: (...args) => any;
```

Defined in: [utils.ts:332](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L332)
Defined in: [utils.ts:307](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L307)

#### Parameters

Expand All @@ -45,7 +45,7 @@ Defined in: [utils.ts:332](https://github.com/TanStack/table/blob/main/packages/
optional memoDeps: (depArgs?) => any[] | undefined;
```

Defined in: [utils.ts:333](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L333)
Defined in: [utils.ts:308](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L308)

#### Parameters

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

# Interface: ColumnVisibilityFeatureConstructors\<TFeatures, TData\>

Defined in: [features/column-visibility/columnVisibilityFeature.ts:33](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.ts#L33)
Defined in: [features/column-visibility/columnVisibilityFeature.ts:34](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.ts#L34)

## Type Parameters

Expand Down
10 changes: 5 additions & 5 deletions docs/reference/index/interfaces/Column_ColumnVisibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Column_ColumnVisibility

# Interface: Column\_ColumnVisibility

Defined in: [features/column-visibility/columnVisibilityFeature.types.ts:85](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.types.ts#L85)
Defined in: [features/column-visibility/columnVisibilityFeature.types.ts:92](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.types.ts#L92)

## Properties

Expand All @@ -15,7 +15,7 @@ Defined in: [features/column-visibility/columnVisibilityFeature.types.ts:85](htt
getCanHide: () => boolean;
```

Defined in: [features/column-visibility/columnVisibilityFeature.types.ts:89](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.types.ts#L89)
Defined in: [features/column-visibility/columnVisibilityFeature.types.ts:96](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.types.ts#L96)

Returns whether the column can be hidden

Expand All @@ -31,7 +31,7 @@ Returns whether the column can be hidden
getIsVisible: () => boolean;
```

Defined in: [features/column-visibility/columnVisibilityFeature.types.ts:93](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.types.ts#L93)
Defined in: [features/column-visibility/columnVisibilityFeature.types.ts:100](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.types.ts#L100)

Returns whether the column is visible

Expand All @@ -47,7 +47,7 @@ Returns whether the column is visible
getToggleVisibilityHandler: () => (event) => void;
```

Defined in: [features/column-visibility/columnVisibilityFeature.types.ts:97](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.types.ts#L97)
Defined in: [features/column-visibility/columnVisibilityFeature.types.ts:104](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.types.ts#L104)

Returns a function that can be used to toggle the column visibility. This function can be used to bind to an event handler to a checkbox.

Expand Down Expand Up @@ -75,7 +75,7 @@ Returns a function that can be used to toggle the column visibility. This functi
toggleVisibility: (value?) => void;
```

Defined in: [features/column-visibility/columnVisibilityFeature.types.ts:101](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.types.ts#L101)
Defined in: [features/column-visibility/columnVisibilityFeature.types.ts:108](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.types.ts#L108)

Toggles the visibility of the column.

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

# Interface: CoreHeadersFeatureConstructors\<TFeatures, TData\>

Defined in: [core/headers/coreHeadersFeature.ts:23](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/coreHeadersFeature.ts#L23)
Defined in: [core/headers/coreHeadersFeature.ts:14](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/coreHeadersFeature.ts#L14)

## Type Parameters

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/index/interfaces/PrototypeAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: PrototypeAPI

# Interface: PrototypeAPI\<TDeps, TDepArgs\>

Defined in: [utils.ts:386](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L386)
Defined in: [utils.ts:361](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L361)

## Type Parameters

Expand All @@ -25,7 +25,7 @@ Defined in: [utils.ts:386](https://github.com/TanStack/table/blob/main/packages/
fn: (self, ...args) => any;
```

Defined in: [utils.ts:387](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L387)
Defined in: [utils.ts:362](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L362)

#### Parameters

Expand All @@ -49,7 +49,7 @@ Defined in: [utils.ts:387](https://github.com/TanStack/table/blob/main/packages/
optional memoDeps: (self, depArgs?) => any[] | undefined;
```

Defined in: [utils.ts:388](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L388)
Defined in: [utils.ts:363](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L363)

#### Parameters

Expand Down
16 changes: 16 additions & 0 deletions docs/reference/index/interfaces/Row_ColumnVisibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,19 @@ Returns an array of cells that account for column visibility for the row.
#### Returns

[`Cell`](../type-aliases/Cell.md)\<`TFeatures`, `TData`, `unknown`\>[]

***

### getVisibleCellsByColumnId()

```ts
getVisibleCellsByColumnId: () => Record<string, Cell<TFeatures, TData, unknown>>;
```

Defined in: [features/column-visibility/columnVisibilityFeature.types.ts:86](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.types.ts#L86)

Returns visible cells by column id for the row.

#### Returns

`Record`\<`string`, [`Cell`](../type-aliases/Cell.md)\<`TFeatures`, `TData`, `unknown`\>\>
Loading
Loading