diff --git a/docs/api/core/cell.md b/docs/api/core/cell.md index 2eb84ab992..6c1ff4a073 100644 --- a/docs/api/core/cell.md +++ b/docs/api/core/cell.md @@ -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 diff --git a/docs/api/core/column.md b/docs/api/core/column.md index 42f56a004f..626287b836 100644 --- a/docs/api/core/column.md +++ b/docs/api/core/column.md @@ -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 diff --git a/docs/api/core/header-group.md b/docs/api/core/header-group.md index f7a3af2192..3d9a4628cb 100644 --- a/docs/api/core/header-group.md +++ b/docs/api/core/header-group.md @@ -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 @@ -30,4 +30,4 @@ The depth of the header group, zero-indexed based. type headers = Header[] ``` -An array of [Header](./header) objects that belong to this header group +An array of [Header](../../header) objects that belong to this header group diff --git a/docs/api/core/header.md b/docs/api/core/header.md index d672c557ec..120a9fc29a 100644 --- a/docs/api/core/header.md +++ b/docs/api/core/header.md @@ -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 @@ -38,7 +38,7 @@ The depth of the header, zero-indexed based. column: Column ``` -The header's associated [Column](./column) object +The header's associated [Column](../column) object ### `headerGroup` @@ -46,7 +46,7 @@ The header's associated [Column](./column) object headerGroup: HeaderGroup ``` -The header's associated [HeaderGroup](./header-group) object +The header's associated [HeaderGroup](../header-group) object ### `subHeaders` diff --git a/docs/api/core/row.md b/docs/api/core/row.md index 2d9159962d..b010df2811 100644 --- a/docs/api/core/row.md +++ b/docs/api/core/row.md @@ -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 @@ -120,4 +120,4 @@ An array of the original subRows as returned by the `options.getSubRows` option. type getAllCells = () => Cell[] ``` -Returns all of the [Cells](api/core/cell) for the row. +Returns all of the [Cells](../cell) for the row. diff --git a/docs/api/core/table.md b/docs/api/core/table.md index 46d5579adb..8787bb6e64 100644 --- a/docs/api/core/table.md +++ b/docs/api/core/table.md @@ -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` @@ -34,7 +34,7 @@ When the `data` option changes reference (compared via `Object.is`), the table w type columns = ColumnDef[] ``` -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` @@ -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` diff --git a/docs/api/features/filters.md b/docs/api/features/filters.md index 94a94f2a2d..c7c05fcd73 100644 --- a/docs/api/features/filters.md +++ b/docs/api/features/filters.md @@ -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) \ No newline at end of file +- [Column Faceting](../column-faceting) +- [Global Faceting](../global-faceting) +- [Column Filtering](../column-filtering) +- [Global Filtering](../global-filtering) \ No newline at end of file diff --git a/docs/api/features/global-filtering.md b/docs/api/features/global-filtering.md index 109687827f..7b48f55ad7 100644 --- a/docs/api/features/global-filtering.md +++ b/docs/api/features/global-filtering.md @@ -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 diff --git a/docs/api/features/pinning.md b/docs/api/features/pinning.md index aee9879466..92222ac7fe 100644 --- a/docs/api/features/pinning.md +++ b/docs/api/features/pinning.md @@ -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) \ No newline at end of file +- [Column Pinning](../column-pinning) +- [Row Pinning](../row-pinning) \ No newline at end of file diff --git a/docs/api/features/row-selection.md b/docs/api/features/row-selection.md index 4b39aa1ea0..bea187b5ee 100644 --- a/docs/api/features/row-selection.md +++ b/docs/api/features/row-selection.md @@ -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 diff --git a/docs/guide/column-defs.md b/docs/guide/column-defs.md index c89b96c156..97529e7ab6 100644 --- a/docs/guide/column-defs.md +++ b/docs/guide/column-defs.md @@ -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 diff --git a/docs/guide/column-filtering.md b/docs/guide/column-filtering.md index 736e6759e8..6cfcb018a7 100644 --- a/docs/guide/column-filtering.md +++ b/docs/guide/column-filtering.md @@ -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. diff --git a/docs/guide/features.md b/docs/guide/features.md index 1eec54638e..83d961c5b5 100644 --- a/docs/guide/features.md +++ b/docs/guide/features.md @@ -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) \ No newline at end of file +- [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) \ No newline at end of file diff --git a/docs/guide/filters.md b/docs/guide/filters.md index 39c72807e7..caf9d2379f 100644 --- a/docs/guide/filters.md +++ b/docs/guide/filters.md @@ -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) \ No newline at end of file +- [Column Filtering](../column-filtering) +- [Global Filtering](../global-filtering) +- [Fuzzy Filtering](../fuzzy-filtering) +- [Faceted Values](../faceted-values) \ No newline at end of file diff --git a/docs/guide/pinning.md b/docs/guide/pinning.md index aa8c116291..c8951f9695 100644 --- a/docs/guide/pinning.md +++ b/docs/guide/pinning.md @@ -6,5 +6,5 @@ title: Pinning Guide Pinning is split into 2 different feature guides: -- [Column Pinning](./column-pinning) -- [Row Pinning](./row-pinning) \ No newline at end of file +- [Column Pinning](../column-pinning) +- [Row Pinning](../row-pinning) \ No newline at end of file diff --git a/docs/guide/row-selection.md b/docs/guide/row-selection.md index 224ebd39e8..c3e7b29651 100644 --- a/docs/guide/row-selection.md +++ b/docs/guide/row-selection.md @@ -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 diff --git a/docs/guide/tables.md b/docs/guide/tables.md index 4d63b19a5c..c3334b81a7 100644 --- a/docs/guide/tables.md +++ b/docs/guide/tables.md @@ -71,7 +71,7 @@ const data = ref([]) #### 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[] = [] //Pass User type as the generic TData type @@ -79,7 +79,7 @@ const columns: ColumnDef[] = [] //Pass User type as the generic TData type const columnHelper = createColumnHelper() //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 diff --git a/docs/guide/virtualization.md b/docs/guide/virtualization.md index 6a0ee83961..7eb9fc18cb 100644 --- a/docs/guide/virtualization.md +++ b/docs/guide/virtualization.md @@ -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 diff --git a/docs/overview.md b/docs/overview.md index 4f01c59376..c8d2c93a89 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -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