Skip to content

Commit b803962

Browse files
committed
docs: update overview
1 parent 102ffd2 commit b803962

File tree

1 file changed

+15
-22
lines changed

1 file changed

+15
-22
lines changed

docs/overview.md

+15-22
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,21 @@ As it was mentioned extensively in the [Intro](../introduction) section, TanStac
1919
Since TanStack Table is headless and runs on a vanilla JavaScript core, it is agnostic in a couple of ways:
2020

2121
1. TanStack Table is **Framework Agnostic**, which means you can use it with any JavaScript framework (or library) that you want. TanStack Table provides ready-to-use adapters for React, Vue, Solid, Svelte, and Qwik out of the box, but you can create your own adapter if you need to.
22-
2. TanStack Table is **CSS / Component Library Agnostic**, which means that you can use TanStack Table with whatever CSS strategy or component library you want. TanStack Table itself does not render any table markup or styles. You bring your own! Want to use Tailwind or ShadCN? No problem! Want to use Material UI or Bootstrap? No problem!
22+
2. TanStack Table is **CSS / Component Library Agnostic**, which means that you can use TanStack Table with whatever CSS strategy or component library you want. TanStack Table itself does not render any table markup or styles. You bring your own! Want to use Tailwind or ShadCN? No problem! Want to use Material UI or Bootstrap? No problem! Have your own custom design system? TanStack Table was made for you!
23+
24+
## Core Objects and Types
25+
26+
The table core uses the following abstractions, commonly exposed by adapters:
27+
28+
- [Data](../guide/data) - The core data array you provide the table
29+
- [Column Defs](../guide/column-defs): Objects used to configure a column and its data model, display templates, and more
30+
- [Table Instance](../guide/tables): The core table object containing both state and API
31+
- [Row Models](../guide/row-models): How the `data` array is transformed into useful rows depending on the features you are using
32+
- [Rows](../guide/rows): Each row mirrors its respective row data and provides row-specific APIs
33+
- [Cells](../guide/cells): Each cell mirrors its respective row-column intersection and provides cell-specific APIs
34+
- [Header Groups](../guide/header-groups): Header groups are computed slices of nested header levels, each containing a group of headers
35+
- [Headers](../guide/headers): Each header is either directly associated with or derived from its column def and provides header-specific APIs
36+
- [Columns](../guide/columns): Each column mirrors its respective column def and also provides column-specific APIs
2337

2438
## Features
2539

@@ -47,24 +61,3 @@ These are just some of the capabilities that you can build with TanStack Table.
4761
TanStack Table also supports [Custom Features](../guide/custom-features) (plugins) that you can use to modify the table instance to add your own custom logic to the table in a more integrated way.
4862

4963
And of course, you can just write your own state and hooks to add whatever other features you want for your table. The features from the TanStack Table core are just a solid foundation to build on, with a large focus on performance and DX.
50-
51-
## Core Objects and Types
52-
53-
The table core uses the following abstractions, commonly exposed by adapters:
54-
55-
- Column Defs
56-
- Objects used to configure a column and its data model, display templates, and more
57-
- Table
58-
- The core table object containing both state and API
59-
- Table Data
60-
- The core data array you provide the table
61-
- Columns
62-
- Each column mirrors its respective column def and also provides column-specific APIs
63-
- Rows
64-
- Each row mirrors its respective row data and provides row-specific APIs
65-
- Header Groups
66-
- Header groups are computed slices of nested header levels, each containing a group of headers
67-
- Headers
68-
- Each header is either directly associated with or derived from its column def and provides header-specific APIs
69-
- Cells
70-
- Each cell mirrors its respective row-column intersection and provides cell-specific APIs

0 commit comments

Comments
 (0)