Skip to content

Commit 07726d0

Browse files
committed
docs: update guides for v9
1 parent bb0144a commit 07726d0

28 files changed

Lines changed: 1352 additions & 814 deletions

README.md

Lines changed: 106 additions & 128 deletions
Original file line numberDiff line numberDiff line change
@@ -1,139 +1,117 @@
1-
![TanStack Table Header](https://github.com/tanstack/table/raw/main/media/repo-header.png)
1+
<div align="center">
2+
<img src="./media/header_table.png" alt="TanStack Table">
3+
</div>
24

3-
# [TanStack](https://tanstack.com) Table v8
5+
<br />
46

5-
Headless UI for building **powerful tables & datagrids** for **React, Solid, Vue, Svelte and TS/JS**.
6-
7-
<a href="https://twitter.com/intent/tweet?button_hashtag=TanStack" target="\_parent">
8-
<img alt="#TanStack" src="https://img.shields.io/twitter/url?color=%2308a0e9&label=%23TanStack&style=social&url=https%3A%2F%2Ftwitter.com%2Fintent%2Ftweet%3Fbutton_hashtag%3DTanStack" />
9-
</a>
10-
<a href="https://github.com/tanstack/table/actions?table=workflow%3A%22react-table+tests%22">
11-
<img src="https://github.com/tanstack/table/workflows/react-table%20tests/badge.svg" />
12-
</a>
7+
<div align="center">
138
<a href="https://npmjs.com/package/@tanstack/react-table" target="\_parent">
14-
<img alt="" src="https://img.shields.io/npm/dm/@tanstack/react-table.svg" />
9+
<img alt="npm downloads" src="https://img.shields.io/npm/dm/@tanstack/react-table.svg" />
10+
</a>
11+
<a href="https://github.com/tanstack/table" target="\_parent">
12+
<img alt="github stars" src="https://img.shields.io/github/stars/tanstack/react-table.svg?style=social&label=Star" />
1513
</a>
1614
<a href="https://bundlephobia.com/result?p=@tanstack/react-table@latest" target="\_parent">
17-
<img alt="" src="https://badgen.net/bundlephobia/minzip/@tanstack/react-table@latest" />
15+
<img alt="bundle size" src="https://badgen.net/bundlephobia/minzip/@tanstack/react-table@latest" />
1816
</a>
17+
</div>
18+
19+
<div align="center">
1920
<a href="#badge">
2021
<img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
2122
</a>
22-
<a href="https://github.com/tanstack/table/discussions">
23-
<img alt="Join the discussion on Github" src="https://img.shields.io/badge/Github%20Discussions%20%26%20Support-Chat%20now!-blue" />
24-
</a>
25-
<a href="https://github.com/tanstack/table" target="\_parent">
26-
<img alt="" src="https://img.shields.io/github/stars/tanstack/react-table.svg?style=social&label=Star" />
27-
</a>
28-
<a href="https://twitter.com/tannerlinsley" target="\_parent">
29-
<img alt="" src="https://img.shields.io/twitter/follow/tannerlinsley.svg?style=social&label=Follow" />
30-
</a>
31-
32-
> [Looking for version 7 of `react-table`? Click here!](https://github.com/tanstack/table/tree/v7)
33-
34-
## Enjoy this library?
35-
36-
Try other [TanStack](https://tanstack.com) libraries:
37-
38-
- [TanStack Query](https://github.com/TanStack/query) <img alt="" src="https://img.shields.io/github/stars/tanstack/query.svg" />
39-
- [TanStack Table](https://github.com/TanStack/table) <img alt="" src="https://img.shields.io/github/stars/tanstack/table.svg" />
40-
- [TanStack Router](https://github.com/TanStack/router) <img alt="" src="https://img.shields.io/github/stars/tanstack/router.svg" />
41-
- [TanStack Virtual](https://github.com/TanStack/virtual) <img alt="" src="https://img.shields.io/github/stars/tanstack/virtual.svg" />
42-
- [TanStack Form](https://github.com/TanStack/form) <img alt="" src="https://img.shields.io/github/stars/tanstack/form.svg" />
43-
- [TanStack Ranger](https://github.com/TanStack/ranger) <img alt="" src="https://img.shields.io/github/stars/tanstack/ranger.svg" />
44-
45-
## Visit [tanstack.com/table](https://tanstack.com/table) for docs, guides, API and more!
46-
47-
You may know **TanStack Table** by our adapter names, too!
48-
49-
- [Angular Table](https://tanstack.com/table/v8/docs/framework/angular/angular-table)
50-
- [Lit Table](https://tanstack.com/table/v8/docs/framework/lit/lit-table)
51-
- [**React Table**](https://tanstack.com/table/v8/docs/framework/react/react-table)
52-
- [Solid Table](https://tanstack.com/table/v8/docs/framework/solid/solid-table)
53-
- [Svelte Table](https://tanstack.com/table/v8/docs/framework/svelte/svelte-table)
54-
- [Vue Table](https://tanstack.com/table/v8/docs/framework/vue/vue-table)
55-
56-
## Summary
57-
58-
TanStack Table is a **headless** table library, which means it does not ship with components, markup or styles. This means that you have **full control** over markup and styles (CSS, CSS-in-JS, UI Component Libraries, etc) and this is also what gives it its portable nature. You can even use it in React Native!
59-
60-
If you want a **lightweight table with full control over markup and implementation**, then you should consider using **TanStack Table, a headless table library**.
61-
62-
If you want a **ready-to-use component-based table with more power but more constraints around markup/styles/implementation**, you should consider using [AG Grid](https://ag-grid.com/react-data-grid/?utm_source=reacttable&utm_campaign=githubreacttable), a component-based table library from our OSS partner [AG Grid](https://ag-grid.com).
63-
64-
TanStack Table and AG Grid are respectfully the
65-
**best table/datagrid libraries around**. Instead
66-
of competing, we're working together to ensure the highest
67-
quality table/datagrid options are available for the entire
68-
JS/TS ecosystem and every use-case.
69-
70-
## Quick Features
71-
72-
- Agnostic core (JS/TS)
73-
- 1st-class framework bindings for React, Vue, Solid
74-
- ~15kb or less (with tree-shaking)
75-
- 100% TypeScript (but not required)
76-
- Headless (100% customizable, Bring-your-own-UI)
77-
- Auto out of the box, opt-in controllable state
78-
- Filters (column and global)
79-
- Sorting (multi-column, multi-directional)
80-
- Grouping & Aggregation
81-
- Pivoting (coming soon!)
82-
- Row Selection
83-
- Row Expansion
84-
- Column Visibility/Ordering/Pinning/Resizing
85-
- Table Splitting
86-
- Animatable
87-
- Virtualizable
88-
- Server-side/external data model support
89-
90-
# Migrating from React Table v7
91-
92-
## Notable Changes
93-
94-
- Full rewrite to TypeScript with types included in the base package
95-
- Removal of plugin system to favor more inversion of control
96-
- Vastly larger and improved API (and new features like pinning)
97-
- Better controlled state management
98-
- Better support for server-side operations
99-
- Complete (but optional) data pipeline control
100-
- Agnostic core with framework adapters for React, Solid, Svelte, Vue, and potentially more in the future
101-
- New Dev Tools
102-
103-
## Migration
104-
105-
There are a fair amount of breaking changes (they're worth it, trust us!):
106-
107-
- Turns out that TypeScript makes your code **a lot** better/safer, but also usually requires breaking changes to architecture.
108-
- Plugin system has been removed so plugins must be rewritten to wrap/compose the new functional API. Contact us if you need help!
109-
- Column configuration options have changed, but only slightly.
110-
- Table options are mostly the same, with some larger changes around optional state management/control and data pipeline control
111-
- The `table` instance while similar in spirit to v7 has been reconfigured to be much faster.
112-
113-
## Installation
114-
115-
Install one of the following packages based on your framework of choice:
116-
117-
```bash
118-
# Npm
119-
npm install @tanstack/angular-table
120-
npm install @tanstack/lit-table
121-
npm install @tanstack/react-table
122-
npm install @tanstack/solid-table
123-
npm install @tanstack/svelte-table
124-
npm install @tanstack/vue-table
125-
npm install @tanstack/table-core #vanilla js that can work with any framework
126-
```
127-
128-
## How to help?
129-
130-
- Try out the already-migrated examples
131-
- Try it out in your own projects.
132-
- Introspect the types! Even without the docs finished, the library ships with 100% typescript to help you explore its capabilities.
133-
- [Read the contribution guidelines](https://github.com/tanstack/table/tree/main/CONTRIBUTING.md)
134-
- Write some docs! Start with the [API docs](https://github.com/TanStack/react-table/tree/main/docs/api) and try adding some information about one or more of the features. The types do a decent job of showing what's supported and the capabilities of the library.
135-
- **Using a plugin?** Try rewriting your plugin (v8 doesn't have a plugin system any more) as a functional wrapper that uses TanStack Table internally. The new API is much more powerful and easier to compose. If you find something you can't figure out, let us know and we'll add it to the API.
136-
137-
### [Become a Sponsor](https://github.com/sponsors/tannerlinsley/)
23+
<a href="https://bestofjs.org/projects/tanstack-table"><img alt="Best of JS" src="https://img.shields.io/endpoint?url=https://bestofjs-serverless.now.sh/api/project-badge?fullName=TanStack%2Ftable%26since=daily" /></a>
24+
<a href="https://twitter.com/tan_stack"><img src="https://img.shields.io/twitter/follow/tan_stack.svg?style=social" alt="Follow @TanStack"/></a>
25+
</div>
26+
27+
### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
28+
29+
</div>
30+
31+
# TanStack Table
32+
33+
> [!NOTE]
34+
> You may know TanStack Table by the adapter names:
35+
>
36+
> - [Angular Table](https://tanstack.com/table/alpha/docs/framework/angular/angular-table)
37+
> - [Lit Table](https://tanstack.com/table/alpha/docs/framework/lit/lit-table)
38+
> - [React Table](https://tanstack.com/table/alpha/docs/framework/react/react-table)
39+
> - [Solid Table](https://tanstack.com/table/alpha/docs/framework/solid/solid-table)
40+
> - [Svelte Table](https://tanstack.com/table/alpha/docs/framework/svelte/svelte-table)
41+
> - [Vue Table](https://tanstack.com/table/alpha/docs/framework/vue/vue-table)
42+
43+
A headless table library for building powerful datagrids with full control over markup, styles, and behavior.
44+
45+
- Framework‑agnostic core with bindings for React, Vue & Solid
46+
- 100% customizable — bring your own UI, components, and styles
47+
- Sorting, filtering, grouping, aggregation & row selection
48+
- Lightweight, virtualizable & server‑side friendly
49+
50+
### <a href="https://tanstack.com/table">Read the Docs →</a>
51+
52+
## Get Involved
53+
54+
- We welcome issues and pull requests!
55+
- Participate in [GitHub discussions](https://github.com/TanStack/table/discussions)
56+
- Chat with the community on [Discord](https://discord.com/invite/WrRKjPJ)
57+
- See [CONTRIBUTING.md](./CONTRIBUTING.md) for setup instructions
58+
59+
## Partners
60+
61+
<table align="center">
62+
<tr>
63+
<td>
64+
<a href="https://www.coderabbit.ai/?via=tanstack&dub_id=aCcEEdAOqqutX6OS">
65+
<picture>
66+
<source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/coderabbit-dark-CMcuvjEy.svg" height="40" />
67+
<source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" />
68+
<img src="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" alt="CodeRabbit" />
69+
</picture>
70+
</a>
71+
</td>
72+
<td padding="20">
73+
<a href="https://www.cloudflare.com?utm_source=tanstack">
74+
<picture>
75+
<source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/cloudflare-white-DQDB7UaL.svg" height="60" />
76+
<source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" />
77+
<img src="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" alt="Cloudflare" />
78+
</picture>
79+
</a>
80+
</td>
81+
<td>
82+
<a href="https://ag-grid.com/react-data-grid/?utm_source=reacttable&utm_campaign=githubreacttable" style="display: flex; align-items: center; border: none;">
83+
<picture>
84+
<source media="(prefers-color-scheme: dark)" srcset="./media/ag-grid-dark.svg" height="40" />
85+
<source media="(prefers-color-scheme: light)" srcset="./media/ag-grid-light.svg" height="40" />
86+
<img src="https://raw.githubusercontent.com/tannerlinsley/files/master/partners/ag-grid.svg" height="60" alt="AG Grid" />
87+
</picture>
88+
</a>
89+
</td>
90+
</tr>
91+
</table>
92+
93+
<div align="center">
94+
<img src="./media/partner_logo.svg" alt="Table & you?" height="65">
95+
<p>
96+
We're looking for TanStack Table Partners to join our mission! Partner with us to push the boundaries of TanStack Table and build amazing things together.
97+
</p>
98+
<a href="mailto:partners@tanstack.com?subject=TanStack Table Partnership"><b>LET'S CHAT</b></a>
99+
</div>
100+
101+
## Explore the TanStack Ecosystem
102+
103+
- <a href="https://github.com/tanstack/config"><b>TanStack Config</b></a> – Tooling for JS/TS packages
104+
- <a href="https://github.com/tanstack/db"><b>TanStack DB</b></a> – Reactive sync client store
105+
- <a href="https://github.com/tanstack/devtools"><b>TanStack DevTools</b></a> – Unified devtools panel
106+
- <a href="https://github.com/tanstack/form"><b>TanStack Form</b></a> – Type‑safe form state
107+
- <a href="https://github.com/tanstack/pacer"><b>TanStack Pacer</b></a> – Debouncing, throttling, batching <br/>
108+
- <a href="https://github.com/tanstack/query"><b>TanStack Query</b></a> – Async state & caching
109+
- <a href="https://github.com/tanstack/ranger"><b>TanStack Ranger</b></a> – Range & slider primitives
110+
- <a href="https://github.com/tanstack/router"><b>TanStack Router</b></a> – Type‑safe routing, caching & URL state
111+
- <a href="https://github.com/tanstack/router"><b>TanStack Start</b></a> – Full‑stack SSR & streaming
112+
- <a href="https://github.com/tanstack/store"><b>TanStack Store</b></a> – Reactive data store
113+
- <a href="https://github.com/tanstack/virtual"><b>TanStack Virtual</b></a> – Virtualized rendering
114+
115+
… and more at <a href="https://tanstack.com"><b>TanStack.com »</b></a>
138116

139117
<!-- USE THE FORCE LUKE -->

0 commit comments

Comments
 (0)