react-base-table

BaseTable is a react table component to display large datasets with high performance and flexibility

Install

1# npm
2npm install @sage-bionetworks/react-base-table --save
3
4# yarn
5yarn add @sage-bionetworks/react-base-table

Usage

1import BaseTable, { Column } from '@sage-bionetworks/react-base-table'
2import '@sage-bionetworks/react-base-table/styles.css'
3// Important: if you fail to import react-base-table/styles.css then 
4// BaseTable will not render as advertised in the included examples.
5// For advanced styling see link below:
6// https://github.com/Autodesk/react-base-table#advance
7 ...
8<BaseTable data={data} width={600} height={400}>
9  <Column key="col0" dataKey="col0" width={100} />
10  <Column key="col1" dataKey="col1" width={100} />
11  ...
12</BaseTable>
13...

Learn more at the website

unique key

key is required for column definition or the column will be ignored

Make sure each item in data is unique by a key, the default key is id, you can customize it via rowKey

size

width is required for column definition, but in flex mode(fixed={false}), you can set width={0} and flexGrow={1} to achieve flexible column width, checkout the Flex Column example

width and height(or maxHeight) are required to display the table properly

In the examples we are using a wrapper const Table = props => <BaseTable width={700} height={400} {...props} /> to do that

If you want it responsive, you can use the AutoResizer to make the table fill the container, checkout the Auto Resize example

closure problem in custom renderers

In practice we tend to write inline functions for custom renderers, which would make shouldUpdateComponent always true as the inline function will create a new instance on every re-render, to avoid "unnecessary" re-renders, BaseTable ignores functions when comparing column definition by default, it works well in most cases before, but if we use external data instead of reference state in custom renderers, we always get the staled initial value although the data has changed

It's recommended to inject the external data in column definition to solve the problem, like <Column foo={foo} bar={bar} cellRenderer={({ column: { foo, bar }}) => { ... } } />, the column definition will update on external data change, with this pattern we can easily move the custom renderers out of column definition for sharing, the downside is it would bloat the column definition and bug prone

Things getting worse with the introduction of React hooks, we use primitive state instead of this.state, so it's easy to encounter the closure problem, but with React hooks, we can easily memoize functions via useCallback or useMemo, so the implicit optimization could be replaced with user land optimization which is more intuitive, to turn off the implicit optimization, set ignoreFunctionInColumnCompare to false which is introduced since v1.11.0

Here is an example to demonstrate

Browser Support

BaseTable is well tested on all modern browsers and IE11. You have to polyfill Array.prototype.findIndex to make it works on IE

The examples don't work on IE as they are powered by react-runner which is a react-live like library but only for modern browsers.

Advance

BaseTable is designed to be the base component to build your own complex table component

Styling

The simplest way is overriding the default styles (assuming you are using scss)

1// override default variables for BaseTable
2$table-prefix: AdvanceTable;
3
4$table-font-size: 13px;
5$table-padding-left: 15px;
6$table-padding-right: 15px;
7$column-padding: 7.5px;
8...
9$show-frozen-rows-shadow: false;
10$show-frozen-columns-shadow: true;
11
12@import '~@sage-bionetworks/react-base-table/es/_BaseTable.scss';
13
14.#{$table-prefix} {
15  &:not(.#{$table-prefix}--show-left-shadow) {
16    .#{$table-prefix}__table-frozen-left {
17      box-shadow: none;
18    }
19  }
20
21  &:not(.#{$table-prefix}--show-right-shadow) {
22    .#{$table-prefix}__table-frozen-right {
23      box-shadow: none;
24    }
25  }
26
27  ...
28}

You can write your own styles from scratch or use CSS-in-JS solutions to achieve that

Custom components

1<BaseTable
2  classPrefix="AdvanceTable"
3  components={{
4    TableCell: AdvanceTableCell,
5    TableHeaderCell: AdvanceTableHeaderCell,
6    ExpandIcon: AdvanceExpandIcon,
7    SortIndicator: AdvanceSortIndicator,
8  }}
9  ...
10/>

Custom renderers & props

There are a lot of highly flexible props like xxxRenderer and xxxProps for you to build your own table component, please check the api and examples for more details

Example

We are using a advanced table component based on BaseTable internally, with much more features, including row selection, row grouping, data aggregation, column settings, column reordering, and column grouping, tooltip, inline editing.

In real products

Development

We use Yarn as the package manager, checkout this repo and run yarn under both root folder and website folder in install packages, then run yarn start to start the demo site powered by Gatsby

Contributing

Please check guidelines for more details