/reactabular

Spectacular tables for React (MIT)

Primary LanguageJavaScriptMIT LicenseMIT

Join the chat at https://gitter.im/bebraw/reactabular build status bitHound Score Dependency Status codecov

Reactabular - Spectacular tables for React

Reactabular has been designed to be extensible. Rather than implementing a lot of functionality in its core, it provides extension points. You can, for instance, customize rendering on cell level. It is possible to implement functionality, such as search, pagination, sorting, and inline editing, through composition. The library includes a variety of utilities for this even though you may use third party ones as well.

By default Reactabular operates using a column and a data definition. It doesn't care where those come from. It just renders the table for you. This means Reactabular will fit right into your current data architecture. It doesn't constrain it in any manner.

The chosen approach pushes a lot of complexity out of the core. As a result it might take more code to achieve certain functionalities. This is the price of flexibility. And that's the primary design goal of Reactabular.

If you want to learn more about React, read SurviveJS - Webpack and React.

Example

The following example illustrates the approach used by Reactabular:

const data = [
  {
    id: 100,
    name: 'John',
    tools: {
      hammer: true
    },
    country: 'fi'
  },
  {
    id: 101,
    name: 'Jack',
    tools: {
      hammer: false
    },
    country: 'dk'
  }
];
const countries = {
  fi: 'Finland',
  dk: 'Denmark'
};

const columns = [
  {
    header: {
      label: 'Name',
      transform: label => ({
        onClick: () => alert(`clicked ${label}`)
      })
    },
    cell: {
      property: 'name'
    }
  },
  {
    header: {
      label: 'Active',
      transform: label => ({
        onClick: () => alert(`clicked ${label}`)
      })
    },
    cell: {
      property: 'tools.hammer',
      format: hasHammer => hasHammer ? 'Hammertime' : 'nope'
    }
  },
  {
    header: {
      label: 'Country',
      transform: label => ({
        onClick: () => alert(`clicked ${label}`)
      })
    },
    cell: {
      property: 'country',
      resolve: country => countries[country]
    }
  },
];

<Table
  className="pure-table pure-table-striped"
  columns={columns}
  data={data}
  rowKey="id"
>
  <Table.Header />

  <Table.Body />
</Table>

Sponsors

SurviveJS Kenandy

License

MIT. See LICENSE for details.