Skip to content

Commit 2c12856

Browse files
authoredApr 3, 2024··
docs: fix more links for tsr migration (#5461)
1 parent 024ecda commit 2c12856

19 files changed

+48
-48
lines changed
 

‎docs/api/core/cell.md

+1-1
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).
66

77
## Cell API
88

‎docs/api/core/column.md

+1-1
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).
66

77
## Column API
88

‎docs/api/core/header-group.md

+2-2
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).
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](./header) objects that belong to this header group
33+
An array of [Header](../../header) objects that belong to this header group

‎docs/api/core/header.md

+3-3
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).
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](./column) object
41+
The header's associated [Column](../column) object
4242

4343
### `headerGroup`
4444

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

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

5151
### `subHeaders`
5252

‎docs/api/core/row.md

+2-2
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).
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](../cell) for the row.

‎docs/api/core/table.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -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).
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 Defs Guide](../../../docs/guide/column-defs) 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 example](../../framework/react/examples/editable-data).
9393
9494
### `state`
9595

‎docs/api/features/filters.md

+4-4
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](../column-faceting)
11+
- [Global Faceting](../global-faceting)
12+
- [Column Filtering](../column-filtering)
13+
- [Global Filtering](../global-filtering)

‎docs/api/features/global-filtering.md

+1-1
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 APIs](../column-filtering) to learn more about filter functions.
2929

3030
#### Using Filter Functions
3131

‎docs/api/features/pinning.md

+2-2
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](../column-pinning)
11+
- [Row Pinning](../row-pinning)

‎docs/api/features/row-selection.md

+1-1
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](../../api/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](../../../api/core/table.md#getrowid) function to the the table.
1919
2020
## Table Options
2121

‎docs/guide/column-defs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Column defs are the single most important part of building a table. They are res
1212

1313
- Building the underlying data model that will be used for everything including sorting, filtering, grouping, etc.
1414
- Formatting the data model into what will be displayed in the table
15-
- 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), [headers](../../../api/core/header) and [footers](../../../api/core/column-def#footer)
1616
- Creating columns for display-only purposes, eg. action buttons, checkboxes, expanders, sparklines, etc.
1717

1818
## Column Def Types

‎docs/guide/column-filtering.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ TanStack table supports both both client-side and manual server-side filtering.
2929

3030
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.
3131

32-
However, as also discussed in the [Pagination 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 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#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.
3333

3434
> 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.
3535

‎docs/guide/features.md

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

‎docs/guide/filters.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,7 +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-
- [Faceted Values](guide/faceted-values)
9+
- [Column Filtering](../column-filtering)
10+
- [Global Filtering](../global-filtering)
11+
- [Fuzzy Filtering](../fuzzy-filtering)
12+
- [Faceted Values](../faceted-values)

‎docs/guide/pinning.md

+2-2
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](./column-pinning)
10-
- [Row Pinning](./row-pinning)
9+
- [Column Pinning](../column-pinning)
10+
- [Row Pinning](../row-pinning)

‎docs/guide/row-selection.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Row Selection Guide
77
Want to skip to the implementation? Check out these examples:
88

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

1313
## API

‎docs/guide/tables.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -71,15 +71,15 @@ const data = ref<User[]>([])
7171
7272
#### Defining Columns
7373

74-
Column definitions are covered in detail in the next section in the [Column Def Guide](./guide/column-defs). We'll note here, however, that when you define the type of your columns, you should use the same `TData` type that you used for you data.
74+
Column definitions are covered in detail in the next section in the [Column Def Guide](../column-defs). We'll note here, however, that when you define the type of your columns, you should use the same `TData` type that you used for you data.
7575

7676
```ts
7777
const columns: ColumnDef<User>[] = [] //Pass User type as the generic TData type
7878
//or
7979
const columnHelper = createColumnHelper<User>() //Pass User type as the generic TData type
8080
```
8181

82-
The column definitions are where we will tell TanStack Table how each column should access and/or transform row data with either an `accessorKey` or `accessorFn`. See the [Column Def Guide](./guide/column-defs#creating-accessor-columns) for more info.
82+
The column definitions are where we will tell TanStack Table how each column should access and/or transform row data with either an `accessorKey` or `accessorFn`. See the [Column Def Guide](../column-defs#creating-accessor-columns) for more info.
8383

8484
#### Creating the Table Instance
8585

‎docs/guide/virtualization.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Want to skip to the implementation? Check out these examples:
88

99
- [virtualized-columns](../../framework/react/examples/virtualized-columns)
1010
- [virtualized-rows (dynamic row height)](../../framework/react/examples/virtualized-rows)
11-
- [virtualized-rows (fixed row height)](../../../../virtual/v3/docs/framework/react/examples/table)
11+
- [virtualized-rows (fixed row height)](../../../../../virtual/v3/docs/framework/react/examples/table)
1212
- [virtualized-infinite-scrolling](../../framework/react/examples/virtualized-infinite-scrolling)
1313

1414
## API

‎docs/overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ While TanStack Table is written in [TypeScript](https://www.typescriptlang.org/)
1010

1111
## Headless
1212

13-
As it was mentioned extensively in the [Intro](./guide/introduction) section, TanStack Table is **headless**. This means that it doesn't render any DOM elements, and instead relies on you, the UI/UX developer to provide the table's markup and styles. This is a great way to build a table that can be used in any UI framework, including React, Vue, Solid, Svelte, Qwik, and even JS-to-native platforms like React Native!
13+
As it was mentioned extensively in the [Intro](../introduction) section, TanStack Table is **headless**. This means that it doesn't render any DOM elements, and instead relies on you, the UI/UX developer to provide the table's markup and styles. This is a great way to build a table that can be used in any UI framework, including React, Vue, Solid, Svelte, Qwik, and even JS-to-native platforms like React Native!
1414

1515
## Core Objects and Types
1616

0 commit comments

Comments
 (0)
Please sign in to comment.