Skip to content

Latest commit

 

History

History
203 lines (175 loc) · 8.35 KB

README.md

File metadata and controls

203 lines (175 loc) · 8.35 KB

React Table Header

Hooks for building lightweight, fast and extendable datagrids for React

#TanStack

Travis CI Bundlephobia NPM Package Join the community on Spectrum GitHub Stars Twitter Followers

Enjoy this library? Try them all! React Query, React Form, React Charts

Features

  • Lightweight (5kb - 12kb+ depending on features used and tree-shaking)
  • Headless (100% customizable, Bring-your-own-UI)
  • Auto out of the box, fully controllable API
  • Sorting (Multi and Stable)
  • Filters
  • Pivoting & Aggregation
  • Row Selection
  • Row Expansion
  • Column Ordering
  • Animatable
  • Virtualizable
  • Resizable
  • Server-side/controlled data/state
  • Extensible via hook-based plugin system

Documentation

  • Installation - Walk through how to install React Table
  • Concepts - Read how React Table works and how you can use it better
  • Examples - Experience and learn from some examples and guides of how to use React Table and implement common patterns
  • API - Get to know React Table's API
  • FAQ - Learn how to use React Table for specific challenges and tasks
  • Previous Versions
  • Contributing - Become familiar with how to contribute back to React Table
  • Code of Conduct - Be a good React Table citizen by following these repository rules

Sponsors

This library is being built and maintained by me, @tannerlinsley and I am always in need of more support to keep this project afloat. If you would like to get additional support, add your logo or name on this README, or simply just contribute to my open source Sponsorship goal, visit my Github Sponsors page!

Become a Sponsor!
Become a Sponsor!
Become a Sponsor!
Become a Sponsor!
Become a Supporter!
  • Hugo Meissner
  • Benoit Leger-Derville
  • Thomas Funk
  • David Pickut
  • Jordan Soltman
  • Robert Tajnšek
  • Eric Lanehart (@pushred)
  • Anish P Patel (@anishpatelyaadada)
  • Alin Porumb (@alinporumb)
  • Janus Reith (@janus-reith)
Become a Fan!

Previous Versions

Version 6

v6 is a great library and while it is still available to install and use, I am no longer offering any long-term support for it. If you intend to keep using v6, I recommend maintaining your own fork of the library and keeping it up to date for your version of React.

Where are the docs for the older v6 version?

Please visit the v6 branch

I want to migrate from v6 to v7. How do I do that?

The differences between the 2 versions are incredibly massive. Unfortunately, I cannot write a one-to-one upgrade guide for any of v6's API, simply because much of it is irrelevant with v7's headless approach. The best approach for migrating to v7 is to learn its API by reading the documentation and then following some of the examples to begin building your own table component.

In case you would need to have both v6 and v7 in one app during the migration process (large codebase, complex use cases), you can either (1) fork and maintain your own local version of React Table v6 or (2) install the react-table-6 alias package for use alongside the react-table package.