Skip to content

Latest commit

 

History

History
180 lines (151 loc) · 7.88 KB

README.md

File metadata and controls

180 lines (151 loc) · 7.88 KB
Raw

React Table Header

Hooks for building lightweight, fast and extendable datagrids for React

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





Features

  • Lightweight (4kb - 9kb depending on features 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
  • "Why I wrote React Table and the problems it has solved for Nozzle.io" by Tanner Linsley

News / Q&A

What is the current state of React Table?

React Table v7 is still under active development, and its API is still changing, albeit only slightly. For this reason, it is currently in an beta release state. It's estimated that it will be fully released as a stable version sometime during October 2019.

Should I use v7@beta in production?

You can use it in production as long as you lock in the beta version in your package.json and also accept that there may be unlikely, but possible bug fixes and/or API changes before it's official release.

I'm still using v6, what should I do?

v6 is a great library and is still the default install for react-table, however, I do not intend on 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 install an official react-table-v6 package alongside the react-table.

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, how to use it and how to extend its functionality
  • 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

React Table v7 is being built and maintained by me, @tannerlinsley and I am always in need of more Patreon support to keep this project afloat. If you would like to contribute to my Patreon goal for v7 and beyond, visit my Patreon and help me out!
Jon Eickmeier
Sortmy.games
Hugo Meissner
Benoit Leger-Derville
Thomas Funk
Dan Houle
David Pickut
Jordan Soltman
Robert Tajnšek