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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion _artifacts/domain_map.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
library:
name: '@tanstack/table'
version: '9.0.0-beta.42'
version: '9.0.0-beta.43'
repository: 'https://github.com/TanStack/table'
homepage: 'https://tanstack.com/table'
description: 'Headless, framework-agnostic data-grid state and row-processing primitives with tree-shakeable v9 features and framework adapters.'
Expand Down
2 changes: 1 addition & 1 deletion _artifacts/skill_tree.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
library:
name: '@tanstack/table'
version: '9.0.0-beta.42'
version: '9.0.0-beta.43'
repository: 'https://github.com/TanStack/table'
description: 'Headless data-grid state and row processing with tree-shakeable v9 features and framework adapters.'
package_version_overrides:
Expand Down
71 changes: 53 additions & 18 deletions docs/reference/index/interfaces/Row_Core.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,27 @@ Defined in: [core/rows/coreRowsFeature.types.ts:12](https://github.com/TanStack/

***

### \_displayIndexCache

```ts
_displayIndexCache: number;
```

Defined in: [core/rows/coreRowsFeature.types.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L16)

#### Inherited from

[`Row_Row`](Row_Row.md).[`_displayIndexCache`](Row_Row.md#_displayindexcache)

***

### \_uniqueValuesCache

```ts
_uniqueValuesCache: Record<string, unknown>;
```

Defined in: [core/rows/coreRowsFeature.types.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L16)
Defined in: [core/rows/coreRowsFeature.types.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L17)

#### Inherited from

Expand All @@ -57,7 +71,7 @@ Defined in: [core/rows/coreRowsFeature.types.ts:16](https://github.com/TanStack/
_valuesCache: Record<string, unknown>;
```

Defined in: [core/rows/coreRowsFeature.types.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L17)
Defined in: [core/rows/coreRowsFeature.types.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L18)

#### Inherited from

Expand All @@ -71,7 +85,7 @@ Defined in: [core/rows/coreRowsFeature.types.ts:17](https://github.com/TanStack/
depth: number;
```

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

The depth of the row (if nested or grouped) relative to the root row array.

Expand All @@ -87,7 +101,7 @@ The depth of the row (if nested or grouped) relative to the root row array.
getAllCells: () => Cell<TFeatures, TData, unknown>[];
```

Defined in: [core/rows/coreRowsFeature.types.ts:63](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L63)
Defined in: [core/rows/coreRowsFeature.types.ts:69](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L69)

Builds one cell for each leaf column, including cells for hidden columns.

Expand All @@ -107,7 +121,7 @@ Builds one cell for each leaf column, including cells for hidden columns.
getAllCellsByColumnId: () => Record<string, Cell<TFeatures, TData, unknown>>;
```

Defined in: [core/rows/coreRowsFeature.types.ts:59](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L59)
Defined in: [core/rows/coreRowsFeature.types.ts:65](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L65)

Builds a lookup of this row's cells keyed by leaf column id.

Expand All @@ -121,13 +135,34 @@ Builds a lookup of this row's cells keyed by leaf column id.

***

### getDisplayIndex()

```ts
getDisplayIndex: () => number;
```

Defined in: [core/rows/coreRowsFeature.types.ts:61](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L61)

Returns the zero-based index of the row in the current display order
before pagination, or `-1` if the row is not in that model.

#### Returns

`number`

#### Inherited from

[`Row_Row`](Row_Row.md).[`getDisplayIndex`](Row_Row.md#getdisplayindex)

***

### getLeafRows()

```ts
getLeafRows: () => Row<TFeatures, TData>[];
```

Defined in: [core/rows/coreRowsFeature.types.ts:67](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L67)
Defined in: [core/rows/coreRowsFeature.types.ts:73](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L73)

Returns the leaf rows for the row, not including any parent rows.

Expand All @@ -147,7 +182,7 @@ Returns the leaf rows for the row, not including any parent rows.
getParentRow: () => Row<TFeatures, TData> | undefined;
```

Defined in: [core/rows/coreRowsFeature.types.ts:71](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L71)
Defined in: [core/rows/coreRowsFeature.types.ts:77](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L77)

Returns the parent row for the row, if it exists.

Expand All @@ -167,7 +202,7 @@ Returns the parent row for the row, if it exists.
getParentRows: () => Row<TFeatures, TData>[];
```

Defined in: [core/rows/coreRowsFeature.types.ts:75](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L75)
Defined in: [core/rows/coreRowsFeature.types.ts:81](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L81)

Returns the parent rows for the row, all the way up to a root row.

Expand All @@ -187,7 +222,7 @@ Returns the parent rows for the row, all the way up to a root row.
getUniqueValues: <TValue>(columnId) => TValue[];
```

Defined in: [core/rows/coreRowsFeature.types.ts:79](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L79)
Defined in: [core/rows/coreRowsFeature.types.ts:85](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L85)

Reads the values this row contributes to faceting/grouping for a column.

Expand Down Expand Up @@ -219,7 +254,7 @@ Reads the values this row contributes to faceting/grouping for a column.
getValue: <TValue>(columnId) => TValue;
```

Defined in: [core/rows/coreRowsFeature.types.ts:83](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L83)
Defined in: [core/rows/coreRowsFeature.types.ts:89](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L89)

Reads this row's accessor value for a column id and caches the result.

Expand Down Expand Up @@ -251,7 +286,7 @@ Reads this row's accessor value for a column id and caches the result.
id: string;
```

Defined in: [core/rows/coreRowsFeature.types.ts:25](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L25)
Defined in: [core/rows/coreRowsFeature.types.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L26)

The resolved unique identifier for the row resolved via the `options.getRowId` option. Defaults to the row's index (or relative index if it is a subRow).

Expand All @@ -267,7 +302,7 @@ The resolved unique identifier for the row resolved via the `options.getRowId` o
index: number;
```

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

The index of the row within its parent array (or the root data array).

Expand All @@ -283,7 +318,7 @@ The index of the row within its parent array (or the root data array).
original: TData;
```

Defined in: [core/rows/coreRowsFeature.types.ts:33](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L33)
Defined in: [core/rows/coreRowsFeature.types.ts:34](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L34)

The original row object provided to the table. If the row is a grouped row, the original row object will be the first original in the group.

Expand All @@ -299,7 +334,7 @@ The original row object provided to the table. If the row is a grouped row, the
optional originalSubRows: readonly TData[];
```

Defined in: [core/rows/coreRowsFeature.types.ts:37](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L37)
Defined in: [core/rows/coreRowsFeature.types.ts:38](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L38)

An array of the original subRows as returned by the `options.getSubRows` option.

Expand All @@ -315,7 +350,7 @@ An array of the original subRows as returned by the `options.getSubRows` option.
optional parentId: string;
```

Defined in: [core/rows/coreRowsFeature.types.ts:41](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L41)
Defined in: [core/rows/coreRowsFeature.types.ts:42](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L42)

If nested, this row's parent row id.

Expand All @@ -331,7 +366,7 @@ If nested, this row's parent row id.
renderValue: <TValue>(columnId) => TValue;
```

Defined in: [core/rows/coreRowsFeature.types.ts:87](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L87)
Defined in: [core/rows/coreRowsFeature.types.ts:93](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L93)

Renders the value for the row in a given columnId the same as `getValue`, but will return the `renderFallbackValue` if no value is found.

Expand Down Expand Up @@ -363,7 +398,7 @@ Renders the value for the row in a given columnId the same as `getValue`, but wi
subRows: Row<TFeatures, TData>[];
```

Defined in: [core/rows/coreRowsFeature.types.ts:45](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L45)
Defined in: [core/rows/coreRowsFeature.types.ts:46](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L46)

An array of subRows for the row as returned and created by the `options.getSubRows` option.

Expand All @@ -379,7 +414,7 @@ An array of subRows for the row as returned and created by the `options.getSubRo
table: Table_Internal<TFeatures, TData>;
```

Defined in: [core/rows/coreRowsFeature.types.ts:49](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L49)
Defined in: [core/rows/coreRowsFeature.types.ts:50](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L50)

Reference to the parent table instance.

Expand Down
30 changes: 20 additions & 10 deletions docs/reference/index/interfaces/Row_CoreProperties.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,23 @@ Defined in: [core/rows/coreRowsFeature.types.ts:12](https://github.com/TanStack/

***

### \_displayIndexCache

```ts
_displayIndexCache: number;
```

Defined in: [core/rows/coreRowsFeature.types.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L16)

***

### \_uniqueValuesCache

```ts
_uniqueValuesCache: Record<string, unknown>;
```

Defined in: [core/rows/coreRowsFeature.types.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L16)
Defined in: [core/rows/coreRowsFeature.types.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L17)

***

Expand All @@ -49,7 +59,7 @@ Defined in: [core/rows/coreRowsFeature.types.ts:16](https://github.com/TanStack/
_valuesCache: Record<string, unknown>;
```

Defined in: [core/rows/coreRowsFeature.types.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L17)
Defined in: [core/rows/coreRowsFeature.types.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L18)

***

Expand All @@ -59,7 +69,7 @@ Defined in: [core/rows/coreRowsFeature.types.ts:17](https://github.com/TanStack/
depth: number;
```

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

The depth of the row (if nested or grouped) relative to the root row array.

Expand All @@ -71,7 +81,7 @@ The depth of the row (if nested or grouped) relative to the root row array.
id: string;
```

Defined in: [core/rows/coreRowsFeature.types.ts:25](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L25)
Defined in: [core/rows/coreRowsFeature.types.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L26)

The resolved unique identifier for the row resolved via the `options.getRowId` option. Defaults to the row's index (or relative index if it is a subRow).

Expand All @@ -83,7 +93,7 @@ The resolved unique identifier for the row resolved via the `options.getRowId` o
index: number;
```

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

The index of the row within its parent array (or the root data array).

Expand All @@ -95,7 +105,7 @@ The index of the row within its parent array (or the root data array).
original: TData;
```

Defined in: [core/rows/coreRowsFeature.types.ts:33](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L33)
Defined in: [core/rows/coreRowsFeature.types.ts:34](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L34)

The original row object provided to the table. If the row is a grouped row, the original row object will be the first original in the group.

Expand All @@ -107,7 +117,7 @@ The original row object provided to the table. If the row is a grouped row, the
optional originalSubRows: readonly TData[];
```

Defined in: [core/rows/coreRowsFeature.types.ts:37](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L37)
Defined in: [core/rows/coreRowsFeature.types.ts:38](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L38)

An array of the original subRows as returned by the `options.getSubRows` option.

Expand All @@ -119,7 +129,7 @@ An array of the original subRows as returned by the `options.getSubRows` option.
optional parentId: string;
```

Defined in: [core/rows/coreRowsFeature.types.ts:41](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L41)
Defined in: [core/rows/coreRowsFeature.types.ts:42](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L42)

If nested, this row's parent row id.

Expand All @@ -131,7 +141,7 @@ If nested, this row's parent row id.
subRows: Row<TFeatures, TData>[];
```

Defined in: [core/rows/coreRowsFeature.types.ts:45](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L45)
Defined in: [core/rows/coreRowsFeature.types.ts:46](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L46)

An array of subRows for the row as returned and created by the `options.getSubRows` option.

Expand All @@ -143,6 +153,6 @@ An array of subRows for the row as returned and created by the `options.getSubRo
table: Table_Internal<TFeatures, TData>;
```

Defined in: [core/rows/coreRowsFeature.types.ts:49](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L49)
Defined in: [core/rows/coreRowsFeature.types.ts:50](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.types.ts#L50)

Reference to the parent table instance.
Loading
Loading