react-table

What is react-table?

The react-table package is a lightweight, flexible, and extensible data grid library for React. It allows developers to build complex, interactive, and performant data grids and tables with minimal effort. It provides hooks and utilities to turn any table into a fully functional data grid, including features like sorting, filtering, pagination, and more.

What are react-table's main functionalities?

Sorting

This feature allows users to sort data in the table by clicking on the column headers. The code sample demonstrates how to set up a basic table with sortable columns using react-table hooks.

const { useTable, useSortBy } = require('react-table');

function Table({ columns, data }) {
  const { getTableProps, getTableBodyProps, headerGroups, rows, prepareRow } = useTable({ columns, data }, useSortBy);

  return (
    <table {...getTableProps()}>
      <thead>
        {headerGroups.map(headerGroup => (
          <tr {...headerGroup.getHeaderGroupProps()}>
            {headerGroup.headers.map(column => (
              <th {...column.getHeaderProps(column.getSortByToggleProps())}>
                {column.render('Header')}
                <span>
                  {column.isSorted ? (column.isSortedDesc ? ' 🔽' : ' 🔼') : ''}
                </span>
              </th>
            ))}
          </tr>
        ))}
      </thead>
      <tbody {...getTableBodyProps()}>
        {rows.map(row => {
          prepareRow(row);
          return (
            <tr {...row.getRowProps()}>
              {row.cells.map(cell => {
                return <td {...cell.getCellProps()}>{cell.render('Cell')}</td>;
              })}
            </tr>
          );
        })}
      </tbody>
    </table>
  );
}

Pagination

This feature enables pagination for the table data, allowing users to navigate through pages. The code sample shows how to implement pagination controls and functionality using react-table hooks.

const { useTable, usePagination } = require('react-table');

function Table({ columns, data }) {
  const {
    getTableProps,
    getTableBodyProps,
    headerGroups,
    page,
    prepareRow,
    canPreviousPage,
    canNextPage,
    pageOptions,
    pageCount,
    gotoPage,
    nextPage,
    previousPage,
    setPageSize,
    state: { pageIndex, pageSize },
  } = useTable({ columns, data }, usePagination);

  // Table structure similar to the sorting example

  return (
    <div>
      {/* Table structure here */}
      <div className="pagination">
        <button onClick={() => gotoPage(0)} disabled={!canPreviousPage}>{'<<'}</button>
        <button onClick={() => previousPage()} disabled={!canPreviousPage}>{'<'}</button>
        <button onClick={() => nextPage()} disabled={!canNextPage}>{'>'}</button>
        <button onClick={() => gotoPage(pageCount - 1)} disabled={!canNextPage}>{'>>'}</button>
        <span>
          Page{' '}
          <strong>
            {pageIndex + 1} of {pageOptions.length}
          </strong>
        </span>
        <select
          value={pageSize}
          onChange={e => {
            setPageSize(Number(e.target.value));
          }}
        >
          {[10, 20, 30, 40, 50].map(pageSize => (
            <option key={pageSize} value={pageSize}>
              Show {pageSize}
            </option>
          ))}
        </select>
      </div>
    </div>
  );
}

Filtering

This feature allows users to filter table data based on input. The code sample illustrates how to add a simple text input for filtering data in a specific column using react-table hooks.

const { useTable, useFilters } = require('react-table');

function Table({ columns, data }) {
  const { getTableProps, getTableBodyProps, headerGroups, rows, prepareRow, setFilter } = useTable({ columns, data }, useFilters);

  // Table and header structure similar to the sorting example

  return (
    <div>
      <input
        value={filterInput}
        onChange={e => setFilter('columnName', e.target.value)}
        placeholder={`Search ${'columnName'}`}
      />
      {/* Table structure here */}
    </div>
  );
}

Other packages similar to react-table

ag-grid-react

ag-Grid is a feature-rich data grid library for React. It offers a wide range of functionalities out of the box, such as sorting, filtering, and pagination, similar to react-table. However, ag-Grid is known for its enterprise-level features, including complex data integration, custom cell rendering, and support for large datasets, making it more suitable for complex applications.

material-table

material-table is built on Material-UI and offers a modern design and user experience. It provides similar functionalities to react-table, like sorting, filtering, and pagination, but with a focus on Material Design. It's a good choice for projects already using Material-UI and looking for a table solution that integrates well with that design system.

react-data-grid

react-data-grid is another alternative to react-table, focusing on performance and flexibility. It supports features like sorting, filtering, and pagination, but it's particularly noted for its performance with large datasets and its extensible cell formatting and editing capabilities. It's a solid choice for applications that require high performance and customizable data grids.

README

---

name: Getting Started route: /

Hooks for building lightweight, fast and extendable datagrids for React

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

Become a Sponsor

Features

• Lightweight (5kb - 14kb+ 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

Visit our new documentation site at https://react-table.js.org

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!

Jon Eickmeier Richard Hefner (@rhefner) Steeve Lennmark (@snorkypie)

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) Timo Mämecke (@timomeh) Tyler Reiff (@reiff12) Matt Stvartak (@mattstvartak)

Become a Fan!

Become a Sponsor

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.