Skip to content

Commit 5f3fca4

Browse files
committed
docs: fix links
commit b7329a4 Author: Tanner Linsley <[email protected]> Date: Fri May 23 13:38:26 2025 -0600 docs: fix relative links
1 parent 66fbe3a commit 5f3fca4

23 files changed

+7361
-15954
lines changed

docs/api/core/cell.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Cell APIs
33
---
44

5-
These are **core** options and API properties for all cells. More options and API properties are available for other [table features](../guide/features).
5+
These are **core** options and API properties for all cells. More options and API properties are available for other [table features](../../../guide/features.md).
66

77
## Cell API
88

docs/api/core/column.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Column APIs
33
---
44

5-
These are **core** options and API properties for all columns. More options and API properties are available for other [table features](../guide/features).
5+
These are **core** options and API properties for all columns. More options and API properties are available for other [table features](../../../guide/features.md).
66

77
## Column API
88

docs/api/core/header-group.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: HeaderGroup APIs
33
---
44

5-
These are **core** options and API properties for all header groups. More options and API properties may be available for other [table features](../guide/features).
5+
These are **core** options and API properties for all header groups. More options and API properties may be available for other [table features](../../../guide/features.md).
66

77
## Header Group API
88

@@ -30,4 +30,4 @@ The depth of the header group, zero-indexed based.
3030
type headers = Header<TData>[]
3131
```
3232
33-
An array of [Header](../api/core/header) objects that belong to this header group
33+
An array of [Header](../../../api/core/header.md) objects that belong to this header group

docs/api/core/header.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Header APIs
33
---
44

5-
These are **core** options and API properties for all headers. More options and API properties may be available for other [table features](../guide/features).
5+
These are **core** options and API properties for all headers. More options and API properties may be available for other [table features](../../../guide/features.md).
66

77
## Header API
88

@@ -38,15 +38,15 @@ The depth of the header, zero-indexed based.
3838
column: Column<TData>
3939
```
4040

41-
The header's associated [Column](../api/core/column) object
41+
The header's associated [Column](../../../api/core/column.md) object
4242

4343
### `headerGroup`
4444

4545
```tsx
4646
headerGroup: HeaderGroup<TData>
4747
```
4848

49-
The header's associated [HeaderGroup](../api/core/header-group) object
49+
The header's associated [HeaderGroup](../../../api/core/header-group.md) object
5050

5151
### `subHeaders`
5252

docs/api/core/row.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Row APIs
33
---
44

5-
These are **core** options and API properties for all rows. More options and API properties are available for other [table features](../guide/features).
5+
These are **core** options and API properties for all rows. More options and API properties are available for other [table features](../../../guide/features.md).
66

77
## Row API
88

@@ -120,4 +120,4 @@ An array of the original subRows as returned by the `options.getSubRows` option.
120120
type getAllCells = () => Cell<TData>[]
121121
```
122122
123-
Returns all of the [Cells](../api/core/cell) for the row.
123+
Returns all of the [Cells](../../../api/core/cell.md) for the row.

docs/api/core/table.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Table APIs
33
---
44

5-
## `createAngularTable` / `useReactTable` / `createSolidTable` / `useQwikTable` / `useVueTable` / `createSvelteTable`
5+
## `useReactTable` / `createSolidTable` / `useQwikTable` / `useVueTable` / `createSvelteTable`
66

77
```tsx
88
type useReactTable = <TData extends AnyData>(
@@ -14,7 +14,7 @@ These functions are used to create a table. Which one you use depends on which f
1414
1515
## Options
1616
17-
These are **core** options and API properties for the table. More options and API properties are available for other [table features](../guide/features).
17+
These are **core** options and API properties for the table. More options and API properties are available for other [table features](../../../guide/features.md).
1818
1919
### `data`
2020
@@ -34,7 +34,7 @@ When the `data` option changes reference (compared via `Object.is`), the table w
3434
type columns = ColumnDef<TData>[]
3535
```
3636
37-
The array of column defs to use for the table. See the [Column Defs Guide](../../docs/guide/column-defs) for more information on creating column definitions.
37+
The array of column defs to use for the table. See the [Column Def Guide](../../../guide/column-defs.md) for more information on creating column definitions.
3838
3939
### `defaultColumn`
4040
@@ -89,7 +89,7 @@ declare module '@tanstack/table-core' {
8989
}
9090
```
9191

92-
> 🧠 Think of this option as an arbitrary "context" for your table. This is a great way to pass arbitrary data or functions to your table without having to pass it to every thing the table touches. A good example is passing a locale object to your table to use for formatting dates, numbers, etc or even a function that can be used to update editable data like in the [editable-data example](../framework/react/examples/editable-data).
92+
> 🧠 Think of this option as an arbitrary "context" for your table. This is a great way to pass arbitrary data or functions to your table without having to pass it to every thing the table touches. A good example is passing a locale object to your table to use for formatting dates, numbers, etc or even a function that can be used to update editable data like in the [editable-data](../../../framework/react/examples/editable-data) example.
9393
9494
### `state`
9595

docs/api/features/filters.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ id: filters
77

88
The Filtering API docs are now split into multiple API doc pages:
99

10-
- [Column Faceting](../api/features/column-faceting)
11-
- [Global Faceting](../api/features/global-faceting)
12-
- [Column Filtering](../api/features/column-filtering)
13-
- [Global Filtering](../api/features/global-filtering)
10+
- [Column Faceting](../../features/column-faceting.md)
11+
- [Global Faceting](../../features/global-faceting.md)
12+
- [Column Filtering](../../features/column-filtering.md)
13+
- [Global Filtering](../../features/global-filtering.md)

docs/api/features/global-filtering.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export interface GlobalFilterTableState {
2525

2626
## Filter Functions
2727

28-
You can use the same filter functions that are available for column filtering for global filtering. See the [Column Filtering APIs](../api/features/column-filtering) to learn more about filter functions.
28+
You can use the same filter functions that are available for column filtering for global filtering. See the [Column Filtering](../../features/column-filtering.md) to learn more about filter functions.
2929

3030
#### Using Filter Functions
3131

docs/api/features/pinning.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ id: pinning
77

88
The pinning apis are now split into multiple api pages:
99

10-
- [Column Pinning](../api/features/column-pinning)
11-
- [Row Pinning](../api/features/row-pinning)
10+
- [Column Pinning](../../features/column-pinning.md)
11+
- [Row Pinning](../../features/row-pinning.md)

docs/api/features/row-selection.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export type RowSelectionTableState = {
1515
}
1616
```
1717
18-
By default, the row selection state uses the index of each row as the row identifiers. Row selection state can instead be tracked with a custom unique row id by passing in a custom [getRowId](../core/table.md#getrowid) function to the the table.
18+
By default, the row selection state uses the index of each row as the row identifiers. Row selection state can instead be tracked with a custom unique row id by passing in a custom [getRowId](../../core/table.md#getrowid) function to the the table.
1919
2020
## Table Options
2121
@@ -113,8 +113,6 @@ getIsSomeRowsSelected: () => boolean
113113
114114
Returns whether or not any rows in the table are selected.
115115
116-
NOTE: Returns `false` if all rows are selected.
117-
118116
### `getIsSomePageRowsSelected`
119117
120118
```tsx

docs/guide/column-defs.md

Lines changed: 4 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
---
2-
title: Columns Definitions Guide
2+
title: Columns Guide
33
---
44

55
## API
66

7-
[Column Def](../api/core/column-def)
7+
[Table API](../../api/core/table)
88

99
## Column Definitions Guide
1010

11-
> Note: This guide is about setting up column definitions for your table and NOT about the actual [`column`](../guide/columns) objects that are generated within the table instance.
12-
1311
Column defs are the single most important part of building a table. They are responsible for:
1412

1513
- Building the underlying data model that will be used for everything including sorting, filtering, grouping, etc.
1614
- Formatting the data model into what will be displayed in the table
17-
- Creating [header groups](../api/core/header-group), [headers](../api/core/header) and [footers](../api/core/column-def#footer)
15+
- Creating [header groups](../../api/core/header-group.md), [headers](../../api/core/header.md) and [footers](../../api/core/column-def.md#footer)
1816
- Creating columns for display-only purposes, eg. action buttons, checkboxes, expanders, sparklines, etc.
1917

2018
## Column Def Types
@@ -147,38 +145,6 @@ columnHelper.accessor('firstName')
147145
}
148146
```
149147

150-
## Deep Keys
151-
152-
If each of your items is an object with the following shape:
153-
154-
```tsx
155-
type Person = {
156-
name: {
157-
first: string
158-
last: string
159-
}
160-
info: {
161-
age: number
162-
visits: number
163-
}
164-
}
165-
```
166-
167-
You could extract the `first` value like so:
168-
169-
```tsx
170-
columnHelper.accessor('name.first', {
171-
id: 'firstName',
172-
})
173-
174-
// OR
175-
176-
{
177-
accessorKey: 'name.first',
178-
id: 'firstName',
179-
}
180-
```
181-
182148
## Array Indices
183149

184150
If each of your items is an array with the following shape:
@@ -276,7 +242,7 @@ columnHelper.accessor('firstName', {
276242

277243
## Aggregated Cell Formatting
278244

279-
For more info on aggregated cells, see [grouping](../guide/grouping).
245+
For more info on aggregated cells, see [grouping](../grouping).
280246

281247
## Header & Footer Formatting
282248

docs/guide/column-filtering.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,30 @@ title: Column Filtering Guide
66

77
Want to skip to the implementation? Check out these examples:
88

9-
- [Column Filters](../framework/react/examples/filters)
10-
- [Faceted Filters](../framework/react/examples/filters-faceted) (Autocomplete and Range filters)
11-
- [Fuzzy Search](../framework/react/examples/filters-fuzzy) (Match Sorter)
12-
- [Editable Data](../framework/react/examples/editable-data)
13-
- [Expanding](../framework/react/examples/expanding) (Filtering from Sub-Rows)
14-
- [Grouping](../framework/react/examples/grouping)
15-
- [Pagination](../framework/react/examples/pagination)
16-
- [Row Selection](../framework/react/examples/row-selection)
9+
- [filters](../../framework/react/examples/filters) (includes faceting)
10+
- [editable-data](../../framework/react/examples/editable-data)
11+
- [expanding](../../framework/react/examples/expanding)
12+
- [grouping](../../framework/react/examples/grouping)
13+
- [pagination](../../framework/react/examples/pagination)
14+
- [row-selection](../../framework/react/examples/row-selection)
1715

1816
## API
1917

20-
[Column Filtering API](../api/features/column-filtering)
18+
[Column Filtering API](../../api/features/column-filtering)
2119

2220
## Column Filtering Guide
2321

2422
Filtering comes in 2 flavors: Column Filtering and Global Filtering.
2523

2624
This guide will focus on column filtering, which is a filter that is applied to a single column's accessor value.
2725

28-
TanStack table supports both client-side and manual server-side filtering. This guide will go over how to implement and customize both, and help you decide which one is best for your use-case.
26+
TanStack table supports both both client-side and manual server-side filtering. This guide will go over how to implement and customize both, and help you decide which one is best for your use-case.
2927

3028
### Client-Side vs Server-Side Filtering
3129

3230
If you have a large dataset, you may not want to load all of that data into the client's browser in order to filter it. In this case, you will most likely want to implement server-side filtering, sorting, pagination, etc.
3331

34-
However, as also discussed in the [Pagination Guide](../guide/pagination#should-you-use-client-side-pagination), a lot of developers underestimate how many rows can be loaded client-side without a performance hit. The TanStack table examples are often tested to handle up to 100,000 rows or more with decent performance for client-side filtering, sorting, pagination, and grouping. This doesn't necessarily mean that your app will be able to handle that many rows, but if your table is only going to have a few thousand rows at most, you might be able to take advantage of the client-side filtering, sorting, pagination, and grouping that TanStack table provides.
32+
However, as also discussed in the [Pagination Guide](../pagination.md#should-you-use-client-side-pagination), a lot of developers underestimate how many rows can be loaded client-side without a performance hit. The TanStack table examples are often tested to handle up to 100,000 rows or more with decent performance for client-side filtering, sorting, pagination, and grouping. This doesn't necessarily that your app will be able to handle that many rows, but if your table is only going to have a few thousand rows at most, you might be able to take advantage of the client-side filtering, sorting, pagination, and grouping that TanStack table provides.
3533

3634
> TanStack Table can handle thousands of client-side rows with good performance. Don't rule out client-side filtering, pagination, sorting, etc. without some thought first.
3735
@@ -59,7 +57,7 @@ const table = useReactTable({
5957
})
6058
```
6159

62-
> **Note:** When using manual filtering, many of the options that are discussed in the rest of this guide will have no effect. When `manualFiltering` is set to `true`, the table instance will not apply any filtering logic to the rows that are passed to it. Instead, it will assume that the rows are already filtered and will use the `data` that you pass to it as-is.
60+
> **Note:** When using manual filtering, many of the options that are discussed in the rest of this guide will have no effect. When is `manualFiltering` is set to `true`, the table instance will not apply any filtering logic to the rows that are passed to it. Instead, it will assume that the rows are already filtered and will use the `data` that you pass to it as-is.
6361
6462
### Client-Side Filtering
6563

@@ -217,8 +215,8 @@ const table = useReactTable({
217215
data,
218216
getCoreRowModel: getCoreRowModel(),
219217
getFilteredRowModel: getFilteredRowModel(),
220-
filterFns: { // add a custom global filter function
221-
myCustomFilterFn: (row, columnId, filterValue) => { // defined inline here
218+
filterFns: { //add a custom sorting function
219+
myCustomFilterFn: (row, columnId, filterValue) => { //defined inline here
222220
return // true or false based on your custom logic
223221
},
224222
startsWith: startsWithFilterFn, // defined elsewhere
@@ -323,15 +321,15 @@ const table = useReactTable({
323321

324322
There are a lot of Column and Table APIs that you can use to interact with the column filter state and hook up to your UI components. Here is a list of the available APIs and their most common use-cases:
325323

326-
- `table.setColumnFilters` - Overwrite the entire column filter state with a new state.
327-
- `table.resetColumnFilters` - Useful for a "clear all/reset filters" button.
324+
- `table.setColumnFilters` - Overwrite the entire column filter state with a new state
325+
- `table.resetColumnFilters` - Useful for a "clear all/reset filters" button
328326

329-
- **`column.getFilterValue`** - Useful for getting the default initial filter value for an input, or even directly providing the filter value to a filter input.
330-
- **`column.setFilterValue`** - Useful for connecting filter inputs to their `onChange` or `onBlur` handlers.
327+
- **`column.getFilterValue`** - Useful for getting the default initial filter value for an input, or even directly providing the filter value to a filter input
328+
- **`column.setFilterValue`** - Useful for connecting filter inputs to their `onChange` or `onBlur` handlers
331329

332-
- `column.getCanFilter` - Useful for disabling/enabling filter inputs.
333-
- `column.getIsFiltered` - Useful for displaying a visual indicator that a column is currently being filtered.
334-
- `column.getFilterIndex` - Useful for displaying in what order the current filter is being applied.
330+
- `column.getCanFilter` - Useful for disabling/enabling filter inputs
331+
- `column.getIsFiltered` - Useful for displaying a visual indicator that a column is currently being filtered
332+
- `column.getFilterIndex` - Useful for displaying in what order the current filter is being applied
335333

336-
- `column.getAutoFilterFn` - Used internally to find the default filter function for a column if none is specified.
337-
- `column.getFilterFn` - Useful for displaying which filter mode or function is currently being used.
334+
- `column.getAutoFilterFn` -
335+
- `column.getFilterFn` - Useful for displaying which filter mode or function is currently being used

docs/guide/features.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ title: Features Guide
44

55
TanStack Table comes with many features, each with their own associated options and API:
66

7-
- [Column Ordering](../guide/column-ordering)
8-
- [Column Pinning](../guide/column-pinning)
9-
- [Column Sizing](../guide/column-sizing)
10-
- [Column Visibility](../guide/column-visibility)
11-
- [Expanding](../guide/expanding)
12-
- [Column Faceting](../guide/column-faceting)
13-
- [Column Filtering](../guide/column-filtering)
14-
- [Global Faceting](../guide/global-faceting)
15-
- [Global Filtering](../guide/global-filtering)
16-
- [Grouping](../guide/grouping)
17-
- [Pagination](../guide/pagination)
18-
- [Row Pinning](../guide/row-pinning)
19-
- [Row Selection](../guide/row-selection)
20-
- [Sorting](../guide/sorting)
21-
- [Virtualization](../guide/virtualization)
7+
- [Column Ordering](../column-ordering.md)
8+
- [Column Pinning](../column-pinning.md)
9+
- [Column Sizing](../column-sizing.md)
10+
- [Column Visibility](../column-visibility.md)
11+
- [Expanding](../expanding.md)
12+
- [Column Faceting](../column-faceting.md)
13+
- [Column Filtering](../column-filtering.md)
14+
- [Global Faceting](../global-faceting.md)
15+
- [Global Filtering](../global-filtering.md)
16+
- [Grouping](../grouping.md)
17+
- [Pagination](../pagination.md)
18+
- [Row Pinning](../row-pinning.md)
19+
- [Row Selection](../row-selection.md)
20+
- [Sorting](../sorting.md)
21+
- [Virtualization](../virtualization.md)

docs/guide/filters.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ title: Filters Guide
66

77
The filter guides are now split into multiple guides:
88

9-
- [Column Filtering](../guide/column-filtering)
10-
- [Global Filtering](../guide/global-filtering)
11-
- [Fuzzy Filtering](../guide/fuzzy-filtering)
12-
- [Column Faceting](../guide/column-faceting)
13-
- [Global Faceting](../guide/global-faceting)
9+
- [Column Filtering](../column-filtering.md)
10+
- [Global Filtering](../global-filtering.md)
11+
- [Fuzzy Filtering](../fuzzy-filtering.md)
12+
<!-- - [Faceted Values](../faceted-values.md) -->

docs/guide/pinning.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ title: Pinning Guide
66

77
Pinning is split into 2 different feature guides:
88

9-
- [Column Pinning](../guide/column-pinning)
10-
- [Row Pinning](../guide/row-pinning)
9+
- [Column Pinning](../column-pinning.md)
10+
- [Row Pinning](../row-pinning.md)

docs/guide/row-selection.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ title: Row Selection Guide
66

77
Want to skip to the implementation? Check out these examples:
88

9-
- [React row-selection](../framework/react/examples/row-selection)
10-
- [Vue row-selection](../framework/vue/examples/row-selection)
11-
- [React expanding](../framework/react/examples/expanding)
9+
- [React row-selection](../../framework/react/examples/row-selection)
10+
- [Vue row-selection](../../framework/vue/examples/row-selection)
11+
- [React expanding](../../framework/react/examples/expanding)
1212

1313
## API
1414

15-
[Row Selection API](../api/features/row-selection)
15+
[Row Selection API](../../api/features/row-selection)
1616

1717
## Row Selection Guide
1818

0 commit comments

Comments
 (0)