⚛️ Hooks for building fast and extendable tables and datagrids for React
Branch: master
Clone or download
Latest commit 33f30c7 Feb 18, 2019

README.md

React Table

Hooks for building lightweight, fast and extendable datagrids for React

Join the community on Spectrum

⚠️ Version 7

This documentation is for Version 7, which is under active development and currently in an alpha state.

Version 6

Looking for v6 information?

Features

Versions

Sponsors

React Table v7 is mostly planned and I (@tannerlinsley) am looking for Patreon support to make it a reality. It will require a decent time commitment on my part to not only implement it, but also help people migrate and continue to maintain it. If you would like to contribute to my Patreon goal for v7 and beyond, visit my Patreon and help me out!.

Table of Contents

Installation

  1. Install React Table as a dependency
# Yarn
$ yarn add react-table

# NPM
$ npm install react-table
  1. Import the react-table module
import { useReactTable } from "react-table";

Examples

React Table v7 Sandbox

Documentation

Documentation for v7 is coming soon. If you're looking for the v6 documentation, click here

Contributing

To suggest a feature, create an issue if it does not already exist. If you would like to help develop a suggested feature follow these steps:

  • Fork this repo
  • Install dependencies with $ yarn
  • Auto-build files as you edit with $ yarn run watch
  • Implement your changes to files in the src/ directory
  • Run the React Story locally with $ yarn run docs
  • View changes as you edit docs/src
  • Submit PR for review

Package Utilities

  • $ yarn run watch Watches files and builds via babel
  • $ yarn run docs Runs the storybook server
  • $ yarn run test Runs the test suite