Skip to content

Commit bca3dd6

Browse files
authoredFeb 11, 2024
docs: links to framework url (#5340)
1 parent a587e43 commit bca3dd6

17 files changed

+41
-41
lines changed
 

‎docs/api/core/table.md

+1-1
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 example](../examples/react/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/guide/column-filtering.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ title: Column Filtering
66

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

9-
- [filters](../examples/react/filters) (includes faceting)
10-
- [editable-data](../examples/react/editable-data)
11-
- [expanding](../examples/react/expanding)
12-
- [grouping](../examples/react/grouping)
13-
- [pagination](../examples/react/pagination)
14-
- [row-selection](../examples/react/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)
1515

1616
## API
1717

‎docs/guide/column-ordering.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Column Ordering
66

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

9-
- [column-ordering](../examples/react/column-ordering)
9+
- [column-ordering](../framework/react/examples/column-ordering)
1010

1111
## API
1212

‎docs/guide/column-pinning.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ title: Column Pinning
66

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

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

1212
## API
1313

‎docs/guide/column-sizing.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ title: Column Sizing
66

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

9-
- [column-sizing](../examples/react/column-sizing)
10-
- [column-resizing-performant](../examples/react/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

@@ -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](../examples/react/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

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ title: Column Visibility
66

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

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

1212
## API
1313

‎docs/guide/expanding.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ title: Expanding
66

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

9-
- [expanding](../examples/react/expanding)
10-
- [grouping](../examples/react/grouping)
9+
- [expanding](../framework/react/examples/expanding)
10+
- [grouping](../framework/react/examples/grouping)
1111

1212
## API
1313

‎docs/guide/faceted-values.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Faceted Values
66

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

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

1111
## API
1212

‎docs/guide/fuzzy-filtering.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Fuzzy Filtering
66

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

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

1111
## API
1212

‎docs/guide/global-filtering.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Global Filtering
66

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

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

1111
## API
1212

‎docs/guide/grouping.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Grouping
66

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

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

1111
## API
1212

‎docs/guide/pagination.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ title: Pagination
66

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

9-
- [pagination](../examples/react/pagination)
10-
- [pagination-controlled](../examples/react/pagination-controlled)
11-
- [editable-data](../examples/react/editable-data)
12-
- [expanding](../examples/react/expanding)
13-
- [filters](../examples/react/filters)
14-
- [fully-controlled](../examples/react/fully-controlled)
15-
- [row-selection](../examples/react/row-selection)
9+
- [pagination](../framework/react/examples/pagination)
10+
- [pagination-controlled](../framework/react/examples/pagination-controlled)
11+
- [editable-data](../framework/react/examples/editable-data)
12+
- [expanding](../framework/react/examples/expanding)
13+
- [filters](../framework/react/examples/filters)
14+
- [fully-controlled](../framework/react/examples/fully-controlled)
15+
- [row-selection](../framework/react/examples/row-selection)
1616

1717
## API
1818

‎docs/guide/row-models.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,10 @@ For normal rendering use cases, you will probably only need to use the `table.ge
9090
- `getPaginationRowModel` - returns a row model that only includes the rows that should be displayed on the current page based on the pagination state.
9191
- `getPrePaginationRowModel` - returns a row model without pagination applied (includes all rows).
9292
93-
- `getSelectedRowModel` - returns a row model of all selected rows (but only based on the `data` that was passed to the table). Runs after `getCoreRowModel`.
94-
- `getPreSelectedRowModel` - returns a row model before row selection is applied (Just returns `getCoreRowModel`).
95-
- `getGroupedSelectedRowModel` - returns a row model of selected rows after grouping. Runs after `getSortedRowModel`, which runs after `getGroupedRowModel`, which runs after `getFilteredRowModel`.
96-
- `getFilteredSelectedRowModel` - returns a row model of selected rows after column filtering and global filtering. Runs after `getFilteredRowModel`.
93+
- `getSelectedRowModel` - returns a row model of all selected rows (but only based on the data that was passed to the table). Runs after getCoreRowModel.
94+
- `getPreSelectedRowModel` - returns a row model before row selection is applied (Just returns getCoreRowModel).
95+
- `getGroupedSelectedRowModel` - returns a row model of selected rows after grouping. Runs after getSortedRowModel, which runs after getGroupedRowModel, which runs after getFilteredRowModel.
96+
- `getFilteredSelectedRowModel` - returns a row model of selected rows after column filtering and global filtering. Runs after getFilteredRowModel.
9797
9898
### The Order of Row Model Execution
9999
@@ -103,7 +103,7 @@ Internally, this is the order in which each of the row models are applied to the
103103
104104
`getCoreRowModel` -> `getFilteredRowModel` -> `getGroupedRowModel` -> `getSortedRowModel` -> `getExpandedRowModel` -> `getPaginationRowModel` -> `getRowModel`
105105
106-
If in any case the respective is disabled or turned off with a `"manual*" table option, the `getPre*RowModel` will be used instead in that step of the process.
106+
If in any case the respective feature is disabled or turned off with a `"manual*"` table option, the `getPre*RowModel` will be used instead in that step of the process.
107107
108108
As you can see above, first the data is filtered, then grouped, then sorted, then expanded, and then finally paginated as the final step.
109109

‎docs/guide/row-pinning.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Row Pinning
66

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

9-
- [row-pinning](../examples/react/row-pinning)
9+
- [row-pinning](../framework/react/examples/row-pinning)
1010

1111
## API
1212

‎docs/guide/row-selection.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ title: Row Selection
66

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

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

1313
## API
1414

‎docs/guide/sorting.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ title: Sorting
66

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

9-
- [sorting](../examples/react/sorting)
10-
- [filters](../examples/react/filters)
9+
- [sorting](../framework/react/examples/sorting)
10+
- [filters](../framework/react/examples/filters)
1111

1212
## API
1313

‎docs/guide/virtualization.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ title: Virtualization
66

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

9-
- [virtualized-columns](../examples/react/virtualized-columns)
10-
- [virtualized-rows (dynamic row height)](../examples/react/virtualized-rows)
9+
- [virtualized-columns](../framework/react/examples/virtualized-columns)
10+
- [virtualized-rows (dynamic row height)](../framework/react/examples/virtualized-rows)
1111
- [virtualized-rows (fixed row height)](../../../../virtual/v3/docs/examples/react/table)
12-
- [virtualized-infinite-scrolling](../examples/react/virtualized-infinite-scrolling)
12+
- [virtualized-infinite-scrolling](../framework/react/examples/virtualized-infinite-scrolling)
1313

1414
## API
1515

0 commit comments

Comments
 (0)