Skip to content

Commit

Permalink
docs: fix more links for tsr migration (#5461)
Browse files Browse the repository at this point in the history
  • Loading branch information
KevinVandy committed Apr 3, 2024
1 parent 024ecda commit 2c12856
Show file tree
Hide file tree
Showing 19 changed files with 48 additions and 48 deletions.
2 changes: 1 addition & 1 deletion docs/api/core/cell.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Cell APIs
---

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

## Cell API

Expand Down
2 changes: 1 addition & 1 deletion docs/api/core/column.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Column APIs
---

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

## Column API

Expand Down
4 changes: 2 additions & 2 deletions docs/api/core/header-group.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: HeaderGroup APIs
---

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).
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).

## Header Group API

Expand Down Expand Up @@ -30,4 +30,4 @@ The depth of the header group, zero-indexed based.
type headers = Header<TData>[]
```
An array of [Header](./header) objects that belong to this header group
An array of [Header](../../header) objects that belong to this header group
6 changes: 3 additions & 3 deletions docs/api/core/header.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Header APIs
---

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

## Header API

Expand Down Expand Up @@ -38,15 +38,15 @@ The depth of the header, zero-indexed based.
column: Column<TData>
```

The header's associated [Column](./column) object
The header's associated [Column](../column) object

### `headerGroup`

```tsx
headerGroup: HeaderGroup<TData>
```

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

### `subHeaders`

Expand Down
4 changes: 2 additions & 2 deletions docs/api/core/row.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Row APIs
---

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

## Row API

Expand Down Expand Up @@ -120,4 +120,4 @@ An array of the original subRows as returned by the `options.getSubRows` option.
type getAllCells = () => Cell<TData>[]
```
Returns all of the [Cells](api/core/cell) for the row.
Returns all of the [Cells](../cell) for the row.
6 changes: 3 additions & 3 deletions docs/api/core/table.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ These functions are used to create a table. Which one you use depends on which f
## Options
These are **core** options and API properties for the table. More options and API properties are available for other [table features](../../guide/features).
These are **core** options and API properties for the table. More options and API properties are available for other [table features](../../../guide/features).
### `data`
Expand All @@ -34,7 +34,7 @@ When the `data` option changes reference (compared via `Object.is`), the table w
type columns = ColumnDef<TData>[]
```
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.
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.
### `defaultColumn`
Expand Down Expand Up @@ -89,7 +89,7 @@ declare module '@tanstack/table-core' {
}
```

> 馃 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).
> 馃 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).
### `state`

Expand Down
8 changes: 4 additions & 4 deletions docs/api/features/filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ id: filters

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

- [Column Faceting](api/features/column-faceting)
- [Global Faceting](api/features/global-faceting)
- [Column Filtering](api/features/column-filtering)
- [Global Filtering](api/features/global-filtering)
- [Column Faceting](../column-faceting)
- [Global Faceting](../global-faceting)
- [Column Filtering](../column-filtering)
- [Global Filtering](../global-filtering)
2 changes: 1 addition & 1 deletion docs/api/features/global-filtering.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export interface GlobalFilterTableState {

## Filter Functions

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

#### Using Filter Functions

Expand Down
4 changes: 2 additions & 2 deletions docs/api/features/pinning.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ id: pinning

The pinning apis are now split into multiple api pages:

- [Column Pinning](api/features/column-pinning)
- [Row Pinning](api/features/row-pinning)
- [Column Pinning](../column-pinning)
- [Row Pinning](../row-pinning)
2 changes: 1 addition & 1 deletion docs/api/features/row-selection.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export type RowSelectionTableState = {
}
```
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.
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.
## Table Options
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/column-defs.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Column defs are the single most important part of building a table. They are res

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

## Column Def Types
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/column-filtering.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ TanStack table supports both both client-side and manual server-side filtering.

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.

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

> 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.
Expand Down
30 changes: 15 additions & 15 deletions docs/guide/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ title: Features Guide

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

- [Column Ordering](./guide/column-ordering)
- [Column Pinning](./guide/column-pinning)
- [Column Sizing](./guide/column-sizing)
- [Column Visibility](./guide/column-visibility)
- [Expanding](./guide/expanding)
- [Column Faceting](./guide/column-faceting)
- [Column Filtering](./guide/column-filtering)
- [Global Faceting](./guide/global-faceting)
- [Global Filtering](./guide/global-filtering)
- [Grouping](./guide/grouping)
- [Pagination](./guide/pagination)
- [Row Pinning](./guide/row-pinning)
- [Row Selection](./guide/row-selection)
- [Sorting](./guide/sorting)
- [Virtualization](./guide/virtualization)
- [Column Ordering](../column-ordering)
- [Column Pinning](../column-pinning)
- [Column Sizing](../column-sizing)
- [Column Visibility](../column-visibility)
- [Expanding](../expanding)
- [Column Faceting](../column-faceting)
- [Column Filtering](../column-filtering)
- [Global Faceting](../global-faceting)
- [Global Filtering](../global-filtering)
- [Grouping](../grouping)
- [Pagination](../pagination)
- [Row Pinning](../row-pinning)
- [Row Selection](../row-selection)
- [Sorting](../sorting)
- [Virtualization](../virtualization)
8 changes: 4 additions & 4 deletions docs/guide/filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Filters Guide

The filter guides are now split into multiple guides:

- [Column Filtering](guide/column-filtering)
- [Global Filtering](guide/global-filtering)
- [Fuzzy Filtering](guide/fuzzy-filtering)
- [Faceted Values](guide/faceted-values)
- [Column Filtering](../column-filtering)
- [Global Filtering](../global-filtering)
- [Fuzzy Filtering](../fuzzy-filtering)
- [Faceted Values](../faceted-values)
4 changes: 2 additions & 2 deletions docs/guide/pinning.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ title: Pinning Guide

Pinning is split into 2 different feature guides:

- [Column Pinning](./column-pinning)
- [Row Pinning](./row-pinning)
- [Column Pinning](../column-pinning)
- [Row Pinning](../row-pinning)
2 changes: 1 addition & 1 deletion docs/guide/row-selection.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: Row Selection Guide
Want to skip to the implementation? Check out these examples:

- [React row-selection](../../framework/react/examples/row-selection)
- [Vue row-selection](../examples/vue/row-selection)
- [Vue row-selection](../../framework/vue/row-selection)
- [React expanding](../../framework/react/examples/expanding)

## API
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,15 +71,15 @@ const data = ref<User[]>([])
#### Defining Columns

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

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

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

#### Creating the Table Instance

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/virtualization.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Want to skip to the implementation? Check out these examples:

- [virtualized-columns](../../framework/react/examples/virtualized-columns)
- [virtualized-rows (dynamic row height)](../../framework/react/examples/virtualized-rows)
- [virtualized-rows (fixed row height)](../../../../virtual/v3/docs/framework/react/examples/table)
- [virtualized-rows (fixed row height)](../../../../../virtual/v3/docs/framework/react/examples/table)
- [virtualized-infinite-scrolling](../../framework/react/examples/virtualized-infinite-scrolling)

## API
Expand Down
2 changes: 1 addition & 1 deletion docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ While TanStack Table is written in [TypeScript](https://www.typescriptlang.org/)

## Headless

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!
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!

## Core Objects and Types

Expand Down

0 comments on commit 2c12856

Please sign in to comment.