Skip to content

Commit 965b55e

Browse files
committed
docs: fix links
1 parent 5f3fca4 commit 965b55e

37 files changed

+10295
-1590
lines changed

docs/api/core/header-group.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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.md) objects that belong to this header group
33+
An array of [Header](../header.md) objects that belong to this header group

docs/api/core/header.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -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.md) object
41+
The header's associated [Column](../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.md) object
49+
The header's associated [HeaderGroup](../header-group.md) object
5050

5151
### `subHeaders`
5252

docs/api/core/row.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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.md) for the row.
123+
Returns all of the [Cells](../cell.md) for the row.

docs/api/core/table.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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](../../../framework/react/examples/editable-data) example.
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](https://github.com/TanStack/table/tree/main/examples/react/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](../../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)
10+
- [Column Faceting](../../../guide/column-faceting.md)
11+
- [Global Faceting](../../../guide/global-faceting.md)
12+
- [Column Filtering](../../../guide/column-filtering.md)
13+
- [Global Filtering](../../../guide/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](../../features/column-filtering.md) 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](../../../guide/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](../../features/column-pinning.md)
11-
- [Row Pinning](../../features/row-pinning.md)
10+
- [Column Pinning](../../../guide/column-pinning.md)
11+
- [Row Pinning](../../../guide/row-pinning.md)

docs/framework/react/guide/table-state.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ title: Table State (React) Guide
66

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

9-
- [kitchen sink](../examples/kitchen-sink)
10-
- [fully controlled](../examples/fully-controlled)
9+
- [kitchen sink](../../examples/kitchen-sink)
10+
- [fully controlled](../../examples/fully-controlled)
1111

1212
## Table State (React) Guide
1313

docs/guide/cells.md

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

55
## API
66

7-
[Cell API](../api/core/cell)
7+
[Cell API](../../api/core/cell)
88

99
## Cells Guide
1010

1111
This quick guide will discuss the different ways you can retrieve and interact with `cell` objects in TanStack Table.
1212

1313
### Where to Get Cells From
1414

15-
Cells come from [Rows](../guide/rows). Enough said, right?
15+
Cells come from [Rows](../../guide/rows). Enough said, right?
1616

1717
There are multiple `row` instance APIs you can use to retrieve the appropriate cells from a row depending on which features you are using. Most commonly, you will use the `row.getAllCells` or `row.getVisibleCells` APIs (if you are using column visibility features), but there are a handful of other similar APIs that you can use.
1818

@@ -32,7 +32,7 @@ During grouping or aggregation features, the `cell.id` will have additional stri
3232

3333
#### Cell Parent Objects
3434

35-
Every cell stores a reference to its parent [row](../guide/rows) and [column](../guide/columns) objects.
35+
Every cell stores a reference to its parent [row](../../guide/rows) and [column](../../guide/columns) objects.
3636

3737
#### Access Cell Values
3838

docs/guide/column-defs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Columns Guide
44

55
## API
66

7-
[Table API](../../api/core/table)
7+
[Table API](../../api/core/table.md)
88

99
## Column Definitions Guide
1010

@@ -242,7 +242,7 @@ columnHelper.accessor('firstName', {
242242

243243
## Aggregated Cell Formatting
244244

245-
For more info on aggregated cells, see [grouping](../grouping).
245+
For more info on aggregated cells, see [grouping](../grouping.md).
246246

247247
## Header & Footer Formatting
248248

docs/guide/column-faceting.md

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

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

9-
- [filters-faceted](../framework/react/examples/filters-faceted)
9+
- [filters-faceted](../../framework/react/examples/filters-faceted)
1010

1111
## API
1212

13-
[Column Faceting API](../api/features/column-faceting)
13+
[Column Faceting API](../../api/features/column-faceting)
1414

1515
## Column Faceting Guide
1616

docs/guide/column-filtering.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ title: Column Filtering Guide
66

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

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)
9+
- [filters](https://github.com/TanStack/table/tree/main/examples/react/filters) (includes faceting)
10+
- [editable-data](https://github.com/TanStack/table/tree/main/examples/react/editable-data)
11+
- [expanding](https://github.com/TanStack/table/tree/main/examples/react/expanding)
12+
- [grouping](https://github.com/TanStack/table/tree/main/examples/react/grouping)
13+
- [pagination](https://github.com/TanStack/table/tree/main/examples/react/pagination)
14+
- [row-selection](https://github.com/TanStack/table/tree/main/examples/react/row-selection)
1515

1616
## API
1717

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

2020
## Column Filtering Guide
2121

docs/guide/column-ordering.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ title: Column Ordering Guide
66

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

9-
- [column-ordering](../framework/react/examples/column-ordering)
10-
- [column-dnd](../framework/react/examples/column-dnd)
9+
- [column-ordering](../../framework/react/examples/column-ordering)
10+
- [column-dnd](../../framework/react/examples/column-dnd)
1111

1212
## API
1313

14-
[Column Ordering API](../api/features/column-ordering)
14+
[Column Ordering API](../../api/features/column-ordering)
1515

1616
## Column Ordering Guide
1717

@@ -21,9 +21,9 @@ By default, columns are ordered in the order they are defined in the `columns` a
2121

2222
There are 3 table features that can reorder columns, which happen in the following order:
2323

24-
1. [Column Pinning](../guide/column-pinning) - If pinning, columns are split into left, center (unpinned), and right pinned columns.
24+
1. [Column Pinning](../../guide/column-pinning) - If pinning, columns are split into left, center (unpinned), and right pinned columns.
2525
2. Manual **Column Ordering** - A manually specified column order is applied.
26-
3. [Grouping](../guide/grouping) - If grouping is enabled, a grouping state is active, and `tableOptions.groupedColumnMode` is set to `'reorder' | 'remove'`, then the grouped columns are reordered to the start of the column flow.
26+
3. [Grouping](../../guide/grouping) - If grouping is enabled, a grouping state is active, and `tableOptions.groupedColumnMode` is set to `'reorder' | 'remove'`, then the grouped columns are reordered to the start of the column flow.
2727

2828
> **Note:** `columnOrder` state will only affect unpinned columns if used in conjunction with column pinning.
2929
@@ -104,7 +104,7 @@ There are undoubtedly many ways to implement drag and drop features along-side T
104104

105105
1. Do NOT try to use [`"react-dnd"`](https://react-dnd.github.io/react-dnd/docs/overview) _if you are using React 18 or newer_. React DnD was an important library for its time, but it now does not get updated very often, and it has incompatibilities with React 18, especially in React Strict Mode. It is still possible to get it to work, but there are newer alternatives that have better compatibility and are more actively maintained. React DnD's Provider may also interfere and conflict with any other DnD solutions you may want to try in your app.
106106

107-
2. Use [`"@dnd-kit/core"`](https://dndkit.com/). DnD Kit is a modern, modular and lightweight drag and drop library that is highly compatible with the modern React ecosystem, and it works well with semantic `<table>` markup. Both of the official TanStack DnD examples, [Column DnD](../framework/react/examples/column-dnd) and [Row DnD](../framework/react/examples/row-dnd), now use DnD Kit.
107+
2. Use [`"@dnd-kit/core"`](https://dndkit.com/). DnD Kit is a modern, modular and lightweight drag and drop library that is highly compatible with the modern React ecosystem, and it works well with semantic `<table>` markup. Both of the official TanStack DnD examples, [Column DnD](../../framework/react/examples/column-dnd) and [Row DnD](../../framework/react/examples/row-dnd), now use DnD Kit.
108108

109109
3. Consider other DnD libraries like [`"react-beautiful-dnd"`](https://github.com/atlassian/react-beautiful-dnd), but be aware of their potentially large bundle sizes, maintenance status, and compatibility with `<table>` markup.
110110

docs/guide/column-pinning.md

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

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

9-
- [column-pinning](../framework/react/examples/column-pinning)
10-
- [sticky-column-pinning](../framework/react/examples/column-pinning-sticky)
9+
- [column-pinning](../../framework/react/examples/column-pinning)
10+
- [sticky-column-pinning](../../framework/react/examples/column-pinning-sticky)
1111

1212
### Other Examples
1313

14-
- [Svelte column-pinning](../framework/svelte/examples/column-pinning)
15-
- [Vue column-pinning](../framework/vue/examples/column-pinning)
14+
- [Svelte column-pinning](../../framework/svelte/examples/column-pinning)
15+
- [Vue column-pinning](../../framework/vue/examples/column-pinning)
1616

1717
## API
1818

19-
[Column Pinning API](../api/features/column-pinning)
19+
[Column Pinning API](../../api/features/column-pinning)
2020

2121
## Column Pinning Guide
2222

@@ -27,8 +27,8 @@ TanStack Table offers state and APIs helpful for implementing column pinning fea
2727
There are 3 table features that can reorder columns, which happen in the following order:
2828

2929
1. **Column Pinning** - If pinning, columns are split into left, center (unpinned), and right pinned columns.
30-
2. Manual [Column Ordering](../guide/column-ordering) - A manually specified column order is applied.
31-
3. [Grouping](../guide/grouping) - If grouping is enabled, a grouping state is active, and `tableOptions.groupedColumnMode` is set to `'reorder' | 'remove'`, then the grouped columns are reordered to the start of the column flow.
30+
2. Manual [Column Ordering](../../guide/column-ordering) - A manually specified column order is applied.
31+
3. [Grouping](../../guide/grouping) - If grouping is enabled, a grouping state is active, and `tableOptions.groupedColumnMode` is set to `'reorder' | 'remove'`, then the grouped columns are reordered to the start of the column flow.
3232

3333
The only way to change the order of the pinned columns is in the `columnPinning.left` and `columnPinning.right` state itself. `columnOrder` state will only affect the order of the unpinned ("center") columns.
3434

@@ -77,13 +77,13 @@ const table = useReactTable({
7777
7878
There are a handful of useful Column API methods to help you implement column pinning features:
7979

80-
- [`column.getCanPin`](../api/features/column-pinning#getcanpin): Use to determine if a column can be pinned.
81-
- [`column.pin`](../api/features/column-pinning#pin): Use to pin a column to the left or right. Or use to unpin a column.
82-
- [`column.getIsPinned`](../api/features/column-pinning#getispinned): Use to determine where a column is pinned.
83-
- [`column.getStart`](../api/features/column-pinning#getstart): Use to provide the correct `left` CSS value for a pinned column.
84-
- [`column.getAfter`](../api/features/column-pinning#getafter): Use to provide the correct `right` CSS value for a pinned column.
85-
- [`column.getIsLastColumn`](../api/features/column-pinning#getislastcolumn): Use to determine if a column is the last column in its pinned group. Useful for adding a box-shadow
86-
- [`column.getIsFirstColumn`](../api/features/column-pinning#getisfirstcolumn): Use to determine if a column is the first column in its pinned group. Useful for adding a box-shadow
80+
- [`column.getCanPin`](../../api/features/column-pinning#getcanpin): Use to determine if a column can be pinned.
81+
- [`column.pin`](../../api/features/column-pinning#pin): Use to pin a column to the left or right. Or use to unpin a column.
82+
- [`column.getIsPinned`](../../api/features/column-pinning#getispinned): Use to determine where a column is pinned.
83+
- [`column.getStart`](../../api/features/column-pinning#getstart): Use to provide the correct `left` CSS value for a pinned column.
84+
- [`column.getAfter`](../../api/features/column-pinning#getafter): Use to provide the correct `right` CSS value for a pinned column.
85+
- [`column.getIsLastColumn`](../../api/features/column-pinning#getislastcolumn): Use to determine if a column is the last column in its pinned group. Useful for adding a box-shadow
86+
- [`column.getIsFirstColumn`](../../api/features/column-pinning#getisfirstcolumn): Use to determine if a column is the first column in its pinned group. Useful for adding a box-shadow
8787

8888
### Split Table Column Pinning
8989

docs/guide/column-sizing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ title: Column Sizing Guide
66

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

9-
- [column-sizing](../framework/react/examples/column-sizing)
10-
- [column-resizing-performant](../framework/react/examples/column-resizing-performant)
9+
- [column-sizing](../../framework/react/examples/column-sizing)
10+
- [column-resizing-performant](../../framework/react/examples/column-resizing-performant)
1111

1212
## API
1313

14-
[Column Sizing API](../api/features/column-sizing)
14+
[Column Sizing API](../../api/features/column-sizing)
1515

1616
## Column Sizing Guide
1717

@@ -166,7 +166,7 @@ TanStack Table keeps track of an state object called `columnSizingInfo` that you
166166

167167
If you are creating large or complex tables (and using React 😉), you may find that if you do not add proper memoization to your render logic, your users may experience degraded performance while resizing columns.
168168

169-
We have created a [performant column resizing example](../framework/react/examples/column-resizing-performant) that demonstrates how to achieve 60 fps column resizing renders with a complex table that may otherwise have slow renders. It is recommended that you just look at that example to see how it is done, but these are the basic things to keep in mind:
169+
We have created a [performant column resizing example](../../framework/react/examples/column-resizing-performant) that demonstrates how to achieve 60 fps column resizing renders with a complex table that may otherwise have slow renders. It is recommended that you just look at that example to see how it is done, but these are the basic things to keep in mind:
170170

171171
1. Don't use `column.getSize()` on every header and every data cell. Instead, calculate all column widths once upfront, **memoized**!
172172
2. Memoize your Table Body while resizing is in progress.

docs/guide/column-visibility.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ title: Column Visibility Guide
66

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

9-
- [column-visibility](../framework/react/examples/column-visibility)
10-
- [column-ordering](../framework/react/examples/column-ordering)
11-
- [sticky-column-pinning](../framework/react/examples/column-pinning-sticky)
9+
- [column-visibility](../../framework/react/examples/column-visibility)
10+
- [column-ordering](../../framework/react/examples/column-ordering)
11+
- [sticky-column-pinning](../../framework/react/examples/column-pinning-sticky)
1212

1313
### Other Examples
1414

15-
- [SolidJS column-visibility](../framework/solid/examples/column-visibility)
16-
- [Svelte column-visibility](../framework/svelte/examples/column-visibility)
15+
- [SolidJS column-visibility](../../framework/solid/examples/column-visibility)
16+
- [Svelte column-visibility](../../framework/svelte/examples/column-visibility)
1717

1818
## API
1919

20-
[Column Visibility API](../api/features/column-visibility)
20+
[Column Visibility API](../../api/features/column-visibility)
2121

2222
## Column Visibility Guide
2323

0 commit comments

Comments
 (0)