Back to Table

Installation

docs/installation.md

8.21.31.8 KB
Original Source

Before we dig in to the API, let's get you set up!

Install your table adapter as a dependency using your preferred package manager:

<!-- ::start:tabs variant="package-managers" -->

react: @tanstack/react-table vue: @tanstack/vue-table solid: @tanstack/solid-table svelte: @tanstack/svelte-table angular: @tanstack/angular-table lit: @tanstack/lit-table

<!-- ::end:tabs --> <!-- ::start:framework -->

React

The @tanstack/react-table package works with React 16.8, React 17, React 18, and React 19.

[!NOTE] Even though the React adapter works with React 19, it may not work with the new React Compiler that's coming out alongside React 19. This may be fixed in future TanStack Table updates.

Vue

The @tanstack/vue-table package works with Vue 3.

Solid

The @tanstack/solid-table package works with Solid-JS 1.

Svelte

The @tanstack/svelte-table package works with Svelte 3 and Svelte 4.

[!NOTE] There is not a built-in Svelte 5 adapter yet, but you can still use TanStack Table with Svelte 5 by installing the @tanstack/table-core package and using a custom adapter from the community. See this PR for inspiration.

Angular

The @tanstack/angular-table package works with Angular 17. The Angular adapter uses a new Angular Signal implementation.

Lit

The @tanstack/lit-table package works with Lit 3.

<!-- ::end:framework -->

Don't see your favorite framework (or favorite version of your framework) listed? You can always just use the @tanstack/table-core package and build your own adapter in your own codebase. Usually, only a thin wrapper is needed to manage state and rendering for your specific framework. Browse the source code of all of the other adapters to see how they work.