Skip to content

Commit 72ab26a

Browse files
authoredMay 7, 2024··
docs: data and header group docs (#5526)
1 parent e80b802 commit 72ab26a

File tree

7 files changed

+359
-83
lines changed

7 files changed

+359
-83
lines changed
 

‎docs/config.json

+16-12
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@
2121
"label": "Installation",
2222
"to": "installation"
2323
},
24+
{
25+
"label": "Migrating to V8",
26+
"to": "guide/migrating"
27+
},
2428
{
2529
"label": "FAQ",
2630
"to": "faq"
@@ -31,7 +35,7 @@
3135
"label": "qwik",
3236
"children": [
3337
{
34-
"label": "Qwik Table",
38+
"label": "Qwik Table Adapter",
3539
"to": "framework/qwik/qwik-table"
3640
}
3741
]
@@ -40,7 +44,7 @@
4044
"label": "react",
4145
"children": [
4246
{
43-
"label": "React Table",
47+
"label": "React Table Adapter",
4448
"to": "framework/react/react-table"
4549
}
4650
]
@@ -49,7 +53,7 @@
4953
"label": "solid",
5054
"children": [
5155
{
52-
"label": "Solid Table",
56+
"label": "Solid Table Adapter",
5357
"to": "framework/solid/solid-table"
5458
}
5559
]
@@ -58,7 +62,7 @@
5862
"label": "svelte",
5963
"children": [
6064
{
61-
"label": "Svelte Table",
65+
"label": "Svelte Table Adapter",
6266
"to": "framework/svelte/svelte-table"
6367
}
6468
]
@@ -67,7 +71,7 @@
6771
"label": "vue",
6872
"children": [
6973
{
70-
"label": "Vue Table",
74+
"label": "Vue Table Adapter",
7175
"to": "framework/vue/vue-table"
7276
}
7377
]
@@ -76,7 +80,7 @@
7680
"label": "vanilla",
7781
"children": [
7882
{
79-
"label": "Vanilla JS/TS",
83+
"label": "Vanilla JS (No Framework)",
8084
"to": "vanilla"
8185
}
8286
]
@@ -87,17 +91,17 @@
8791
"label": "Core Guides",
8892
"children": [
8993
{
90-
"label": "Migrating to V8",
91-
"to": "guide/migrating"
92-
},
93-
{
94-
"label": "Table Instance",
95-
"to": "guide/tables"
94+
"label": "Data (and TypeScript)",
95+
"to": "guide/data"
9696
},
9797
{
9898
"label": "Column Defs",
9999
"to": "guide/column-defs"
100100
},
101+
{
102+
"label": "Table Instance",
103+
"to": "guide/tables"
104+
},
101105
{
102106
"label": "Rows Models",
103107
"to": "guide/row-models"

‎docs/guide/column-defs.md

+33-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Columns Guide
44

55
## API
66

7-
[Table API](../../api/core/table)
7+
[Column Def](../../api/core/column-def)
88

99
## Column Definitions Guide
1010

@@ -145,6 +145,38 @@ columnHelper.accessor('firstName')
145145
}
146146
```
147147

148+
## Deep Keys
149+
150+
If each of your items is an object with the following shape:
151+
152+
```tsx
153+
type Person = {
154+
name: {
155+
first: string
156+
last: string
157+
}
158+
info: {
159+
age: number
160+
visits: number
161+
}
162+
}
163+
```
164+
165+
You could extract the `first` value like so:
166+
167+
```tsx
168+
columnHelper.accessor('name.first'), {
169+
id: 'firstName',
170+
}
171+
172+
// OR
173+
174+
{
175+
accessorKey: 'name.first',
176+
id: 'firstName',
177+
}
178+
```
179+
148180
## Array Indices
149181

150182
If each of your items is an array with the following shape:

‎docs/guide/column-filtering.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ title: Column Filtering Guide
66

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

9-
- [filters](../../framework/react/examples/filters) (includes faceting)
10-
- [filters-faceted](../../framework/react/examples/filters-faceted)
11-
- [filters-fuzzy](../../framework/react/examples/filters-fuzzy)
12-
- [editable-data](../../framework/react/examples/editable-data)
13-
- [expanding](../../framework/react/examples/expanding)
14-
- [grouping](../../framework/react/examples/grouping)
15-
- [pagination](../../framework/react/examples/pagination)
16-
- [row-selection](../../framework/react/examples/row-selection)
9+
- [Column Filters](../../framework/react/examples/filters)
10+
- [Faceted Filters](../../framework/react/examples/filters-faceted) (Autocomplete and Range filters)
11+
- [Fuzzy Search](../../framework/react/examples/filters-fuzzy) (Match Sorter)
12+
- [Editable Data](../../framework/react/examples/editable-data)
13+
- [Expanding](../../framework/react/examples/expanding) (Filtering from Sub-Rows)
14+
- [Grouping](../../framework/react/examples/grouping)
15+
- [Pagination](../../framework/react/examples/pagination)
16+
- [Row Selection](../../framework/react/examples/row-selection)
1717

1818
## API
1919

0 commit comments

Comments
 (0)
Please sign in to comment.