Skip to content

Commit 17b84c3

Browse files
committed
docs: update feature setup sections
1 parent 7907243 commit 17b84c3

121 files changed

Lines changed: 464 additions & 943 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/config.json‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -302,13 +302,6 @@
302302
{ "label": "Virtualization", "to": "framework/vue/guide/virtualization" },
303303
{ "label": "Custom Features", "to": "framework/vue/guide/custom-features" }
304304
]
305-
},
306-
{
307-
"label": "vanilla",
308-
"children": [
309-
{ "label": "Pagination", "to": "framework/vanilla/guide/pagination" },
310-
{ "label": "Sorting", "to": "framework/vanilla/guide/sorting" }
311-
]
312305
}
313306
]
314307
},

‎docs/framework/angular/guide/column-faceting.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ Want to skip to the implementation? Check out these Angular examples:
88

99
- [Faceted Filters](../examples/filters-faceted)
1010

11-
### Angular Setup
11+
### Faceting Setup
12+
13+
Here's how you set up your table to use faceting features. Adding the faceting feature enables the related APIs. Additionally, if using client-side faceting, you also need to set up `filteredRowModel` and `facetedRowModel` after their associated features because row model slots are type-checked.
1214

1315
```ts
1416
import { signal } from '@angular/core'
@@ -17,8 +19,8 @@ import { injectTable, tableFeatures, columnFacetingFeature, columnFilteringFeatu
1719
const features = tableFeatures({
1820
columnFacetingFeature,
1921
columnFilteringFeature,
20-
filteredRowModel: createFilteredRowModel(),
21-
facetedRowModel: createFacetedRowModel(),
22+
filteredRowModel: createFilteredRowModel(), // if using client-side filtering
23+
facetedRowModel: createFacetedRowModel(), // if using client-side faceting
2224
facetedUniqueValues: createFacetedUniqueValues(),
2325
facetedMinMaxValues: createFacetedMinMaxValues(),
2426
filterFns,

‎docs/framework/angular/guide/column-filtering.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,17 @@ Want to skip to the implementation? Check out these Angular examples:
1010
- [Faceted Filters](../examples/filters-faceted)
1111
- [Fuzzy Search](../examples/filters-fuzzy)
1212

13-
### Angular Setup
13+
### Column Filtering Setup
14+
15+
Here's how you set up your table to use column filtering features. Adding the column filtering feature enables the related APIs. Additionally, if using client-side filtering, you also need to set up `filteredRowModel` after its associated feature because row model slots are type-checked.
1416

1517
```ts
1618
import { signal } from '@angular/core'
1719
import { injectTable, tableFeatures, columnFilteringFeature, createFilteredRowModel, filterFns } from '@tanstack/angular-table'
1820

1921
const features = tableFeatures({
2022
columnFilteringFeature,
21-
filteredRowModel: createFilteredRowModel(),
23+
filteredRowModel: createFilteredRowModel(), // if using client-side filtering
2224
filterFns,
2325
})
2426

‎docs/framework/angular/guide/column-ordering.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ Want to skip to the implementation? Check out these Angular examples:
88

99
- [Column Ordering](../examples/column-ordering)
1010

11-
### Angular Setup
11+
### Column Ordering Setup
12+
13+
Here's how you set up your table to use column ordering features. Adding the column ordering feature enables the related APIs.
1214

1315
```ts
1416
import { signal } from '@angular/core'

‎docs/framework/angular/guide/column-pinning.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ Want to skip to the implementation? Check out these Angular examples:
1010
- [Column Pinning Split](../examples/column-pinning-split)
1111
- [Sticky Column Pinning](../examples/column-pinning-sticky)
1212

13-
### Angular Setup
13+
### Column Pinning Setup
14+
15+
Here's how you set up your table to use column pinning features. Adding the column pinning feature enables the related APIs.
1416

1517
```ts
1618
import { signal } from '@angular/core'

‎docs/framework/angular/guide/column-resizing.md‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,18 @@ Want to skip to the implementation? Check out these Angular examples:
99
- [Column Resizing](../examples/column-resizing)
1010
- [Performant Column Resizing](../examples/column-resizing-performant)
1111

12-
### Angular Setup
12+
### Column Resizing Setup
13+
14+
Here's how you set up your table to use column resizing features. Column resizing depends on column sizing, so add `columnSizingFeature` before `columnResizingFeature`. Adding the column resizing feature enables the related APIs.
1315

1416
```ts
1517
import { signal } from '@angular/core'
16-
import { injectTable, tableFeatures, columnResizingFeature } from '@tanstack/angular-table'
18+
import { injectTable, tableFeatures, columnSizingFeature, columnResizingFeature } from '@tanstack/angular-table'
1719

18-
const features = tableFeatures({ columnResizingFeature })
20+
const features = tableFeatures({
21+
columnSizingFeature,
22+
columnResizingFeature,
23+
})
1924

2025
export class App {
2126
readonly data = signal(defaultData)
@@ -36,7 +41,7 @@ Column resizing builds on column sizing. If you only need to define starting, mi
3641

3742
### Enable Column Resizing
3843

39-
To use column resizing, add `columnResizingFeature` to your features. The `column.getCanResize()` API will return `true` by default for all columns, but you can either disable column resizing for all columns with the `enableColumnResizing` table option, or disable column resizing on a per-column basis with the `enableResizing` column option.
44+
To use column resizing, add `columnSizingFeature` and then `columnResizingFeature` to your features. The `column.getCanResize()` API will return `true` by default for all columns, but you can either disable column resizing for all columns with the `enableColumnResizing` table option, or disable column resizing on a per-column basis with the `enableResizing` column option.
4045

4146
```ts
4247
import {

‎docs/framework/angular/guide/column-sizing.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ Want to skip to the implementation? Check out these Angular examples:
88

99
- [Column Sizing](../examples/column-sizing)
1010

11-
### Angular Setup
11+
### Column Sizing Setup
12+
13+
Here's how you set up your table to use column sizing features. Adding the column sizing feature enables the related APIs.
1214

1315
```ts
1416
import { signal } from '@angular/core'

‎docs/framework/angular/guide/column-visibility.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ Want to skip to the implementation? Check out these Angular examples:
88

99
- [Column Visibility](../examples/column-visibility)
1010

11-
### Angular Setup
11+
### Column Visibility Setup
12+
13+
Here's how you set up your table to use column visibility features. Adding the column visibility feature enables the related APIs.
1214

1315
```ts
1416
import { signal } from '@angular/core'

‎docs/framework/angular/guide/expanding.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,17 @@ Want to skip to the implementation? Check out these Angular examples:
88

99
- [Expanding](../examples/expanding)
1010

11-
### Angular Setup
11+
### Expanding Setup
12+
13+
Here's how you set up your table to use expanding features. Adding the expanding feature enables the related APIs. Additionally, if using client-side expanding, you also need to set up `expandedRowModel` after its associated feature because row model slots are type-checked.
1214

1315
```ts
1416
import { signal } from '@angular/core'
1517
import { injectTable, tableFeatures, rowExpandingFeature, createExpandedRowModel } from '@tanstack/angular-table'
1618

1719
const features = tableFeatures({
1820
rowExpandingFeature,
19-
expandedRowModel: createExpandedRowModel(),
21+
expandedRowModel: createExpandedRowModel(), // if using client-side expanding
2022
})
2123

2224
export class App {

‎docs/framework/angular/guide/fuzzy-filtering.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ Want to skip to the implementation? Check out these Angular examples:
88

99
- [Fuzzy Search](../examples/filters-fuzzy)
1010

11-
### Angular Setup
11+
### Fuzzy Filtering Setup
12+
13+
Here's how you set up your table to use fuzzy filtering features. Adding the fuzzy filtering feature enables the related APIs. Additionally, if using client-side fuzzy filtering and sorting, you also need to set up `filteredRowModel` and `sortedRowModel` after their associated features because row model slots are type-checked.
1214

1315
```ts
1416
import { signal } from '@angular/core'
@@ -21,8 +23,8 @@ const features = tableFeatures({
2123
columnFilteringFeature,
2224
globalFilteringFeature,
2325
rowSortingFeature,
24-
filteredRowModel: createFilteredRowModel(),
25-
sortedRowModel: createSortedRowModel(),
26+
filteredRowModel: createFilteredRowModel(), // if using client-side filtering
27+
sortedRowModel: createSortedRowModel(), // if using client-side sorting
2628
filterFns: { ...filterFns, fuzzy: fuzzyFilter }, // fuzzyFilter defined below
2729
sortFns: { ...sortFns, fuzzy: fuzzySort }, // fuzzySort defined below
2830
filterMeta: metaHelper<FuzzyFilterMeta>(),

0 commit comments

Comments
 (0)