Skip to content

Commit

Permalink
docs: data and header group docs (#5526)
Browse files Browse the repository at this point in the history
  • Loading branch information
KevinVandy committed May 7, 2024
1 parent e80b802 commit 72ab26a
Show file tree
Hide file tree
Showing 7 changed files with 359 additions and 83 deletions.
28 changes: 16 additions & 12 deletions docs/config.json
Expand Up @@ -21,6 +21,10 @@
"label": "Installation",
"to": "installation"
},
{
"label": "Migrating to V8",
"to": "guide/migrating"
},
{
"label": "FAQ",
"to": "faq"
Expand All @@ -31,7 +35,7 @@
"label": "qwik",
"children": [
{
"label": "Qwik Table",
"label": "Qwik Table Adapter",
"to": "framework/qwik/qwik-table"
}
]
Expand All @@ -40,7 +44,7 @@
"label": "react",
"children": [
{
"label": "React Table",
"label": "React Table Adapter",
"to": "framework/react/react-table"
}
]
Expand All @@ -49,7 +53,7 @@
"label": "solid",
"children": [
{
"label": "Solid Table",
"label": "Solid Table Adapter",
"to": "framework/solid/solid-table"
}
]
Expand All @@ -58,7 +62,7 @@
"label": "svelte",
"children": [
{
"label": "Svelte Table",
"label": "Svelte Table Adapter",
"to": "framework/svelte/svelte-table"
}
]
Expand All @@ -67,7 +71,7 @@
"label": "vue",
"children": [
{
"label": "Vue Table",
"label": "Vue Table Adapter",
"to": "framework/vue/vue-table"
}
]
Expand All @@ -76,7 +80,7 @@
"label": "vanilla",
"children": [
{
"label": "Vanilla JS/TS",
"label": "Vanilla JS (No Framework)",
"to": "vanilla"
}
]
Expand All @@ -87,17 +91,17 @@
"label": "Core Guides",
"children": [
{
"label": "Migrating to V8",
"to": "guide/migrating"
},
{
"label": "Table Instance",
"to": "guide/tables"
"label": "Data (and TypeScript)",
"to": "guide/data"
},
{
"label": "Column Defs",
"to": "guide/column-defs"
},
{
"label": "Table Instance",
"to": "guide/tables"
},
{
"label": "Rows Models",
"to": "guide/row-models"
Expand Down
34 changes: 33 additions & 1 deletion docs/guide/column-defs.md
Expand Up @@ -4,7 +4,7 @@ title: Columns Guide

## API

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

## Column Definitions Guide

Expand Down Expand Up @@ -145,6 +145,38 @@ columnHelper.accessor('firstName')
}
```

## Deep Keys

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

```tsx
type Person = {
name: {
first: string
last: string
}
info: {
age: number
visits: number
}
}
```
You could extract the `first` value like so:
```tsx
columnHelper.accessor('name.first'), {
id: 'firstName',
}

// OR

{
accessorKey: 'name.first',
id: 'firstName',
}
```

## Array Indices

If each of your items is an array with the following shape:
Expand Down
16 changes: 8 additions & 8 deletions docs/guide/column-filtering.md
Expand Up @@ -6,14 +6,14 @@ title: Column Filtering Guide

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

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

## API

Expand Down

0 comments on commit 72ab26a

Please sign in to comment.