Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/schrodinger/fixed-data-table-2

A React table component designed to allow presenting millions of rows of data.
https://github.com/schrodinger/fixed-data-table-2

Last synced: about 1 month ago
JSON representation

A React table component designed to allow presenting millions of rows of data.

Awesome Lists containing this project

README 

        
[Fixed Data Table 2](https://schrodinger.github.io/fixed-data-table-2/) for React · ![CI status](https://github.com/schrodinger/fixed-data-table-2/actions/workflows/build-and-run-tests.yml/badge.svg) · [![npm version](https://badge.fury.io/js/fixed-data-table-2.svg)](https://www.npmjs.com/package/fixed-data-table-2)

====================================



#### Fixed-Data-Table-2 is a continuation of [facebook/fixed-data-table](https://github.com/facebook/fixed-data-table).  The original repo is no longer maintained and has many pull requests awaiting response.



FixedDataTable is a React component for building and presenting data in a flexible, powerful way. It supports standard table features, like headers, columns, rows, header groupings, and both fixed-position and scrolling columns.



The table was designed to handle thousands of rows of data without sacrificing performance. Scrolling smoothly is a first-class goal of FixedDataTable and it's architected in a way to allow for flexibility and extensibility.



Features of FixedDataTable:

* Fixed headers and footer

* Both fixed and scrollable columns

* Handling huge amounts of data

* Variable row heights (with adaptive scroll positions)

* Column resizing

* Performant scrolling

* Customizable styling

* Jumping to a row or column

* Controlled scroll API allows touch support



Things the FixedDataTable **doesn't** do:

* FixedDataTable does not provide a layout reflow mechanism or calculate content layout information such as width and height of the cell contents. The developer has to provide the layout information to the table instead.

* FixedDataTable does not handle sorting of data. Instead it allows the developer to supply data getters that can be sort-, filter-, or tail-loading-aware.

* FixedDataTable does not fetch the data (see above)



This version of FixedDataTable is maintained by Schrödinger, Inc. It is a forked version of Facebook’s FixedDataTable Repository available [here](https://github.com/facebook/fixed-data-table) available under the BSD License. Contributions and modifications to FixedDataTable are also subject to the BSD License [(see here)](#contributions).



Getting started

---------------



Install `fixed-data-table-2` using npm.



```shell

npm install fixed-data-table-2

```

Add the default stylesheet `dist/fixed-data-table.css` using a link tag or import it with a CSS module.



Implementing a table involves three component types- ``,``, and ``.



`` contains configuration information for the entire table, like dimensions and row count.



```javascript



  const rows =[0,1,2];



  

```    



`` defines the way data is displayed for one column in the table, including all cell behavior for that column. Rather than manipulating each cell directly, pass a cell component as a prop to the column, and the column will render a cell for each index in the data array.



```javascript

    Col 1}

      cell={Column 1}

      width={2000}

    />

```

The cell components in a column will receive the current array index of your data as a prop (`this.props.rowIndex`). Use this to access the correct value for each cell.

```javascript

    const rows = [0,1,2];

    

    Column 1}

      cell={({rowIndex, ...props}) => (

        

        {rows[rowIndex]}

        

      )}

      width={2000}

    />

```



If your data is an array of objects, define a `columnKey` prop for each column and it too will be passed to all cells in that column.

```javascript

    const rows = [

      { someKey: "someValue" },

      { someKey: "anotherValue" },

      { someKey: "yetAnother" }

    ];

    

  Col 1}

    columnKey="someKey"

    cell={({ rowIndex, columnKey, ...props }) =>

      

        {rows[rowIndex][columnKey]}

      }

    width={2000}

  />;



```



You may find it useful to define custom Cell components, which can also be passed to the Column:

```javascript

    const MyCustomCell = ({ isSpecial }) =>

      

        {isSpecial ? "I'm Special" : "I'm Not Special"}

      ;



    Col 3}

      cell={}

      width={2000}

    />



```



### Code Sample

For more detailed examples, please see the [examples section](http://schrodinger.github.io/fixed-data-table-2/example-object-data.html) of the documentation. If you need help getting started with a React build system, we recommend [create-react-app](https://github.com/facebookincubator/create-react-app).  

```javascript

import React from 'react';

import ReactDOM from 'react-dom';

import {Table, Column, Cell} from 'fixed-data-table-2';

import 'fixed-data-table-2/dist/fixed-data-table.css';



// Table data as a list of array.

const rows = [

  "first row",

  "second row",

  "third row"

  // .... and more

];



// Custom cell implementation with special prop

const MyCustomCell = ({ mySpecialProp }) =>

  

    {mySpecialProp === "column2" ? "I'm column 2" : "I'm not column 2"}

  ;



// Render your table

ReactDOM.render(

  

    Col 1}

      cell={Column 1 static content}

      width={2000}

    />

    Col 2}

      cell={}

      width={1000}

    />

    Col 3}

      cell={({rowIndex, ...props}) => (

        

          Data for column 3: {rows[rowIndex]}

        

      )}

      width={2000}

    />

  ,

  document.getElementById('example')

);

```



Browser Support

------------



| Chrome        | Firefox           | IE  | Safari 

--- | --- | --- | --- |

| Latest | Latest | 11+ | Unsupported* |



###### * Safari may function correct, but we are not actively testing with it



 



Contributions

------------



Use [GitHub issues](https://github.com/schrodinger/fixed-data-table-2/issues) for requests.



We actively welcome pull requests; learn how to [contribute](https://github.com/schrodinger/fixed-data-table-2/blob/master/CONTRIBUTING.md).



**BY CONTRIBUTING TO FIXEDDATATABLE, YOU AGREE THAT YOUR CONTRIBUTIONS WILL BE LICENSED UNDER THE BSD LICENSE [(see here)](https://github.com/schrodinger/fixed-data-table-2/blob/master/LICENSE)**. Furthermore, by contributing to FixedDataTable, you hereby grant to Schrödinger and any recipients of your contributions, including but not limited to users of this site, a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, use, make and distribute your contributions and any derivative works under all intellectual property rights including but not limited to copyright and patent. **BY CONTRIBUTING TO FIXEDDATATABLE, YOU REPRESENT AND WARRANT THAT YOU ARE LEGALLY ENTITLED TO GRANT THE FOREGOING LICENSE**.



Changelog

---------



Changes are tracked as [GitHub releases](https://github.com/schrodinger/fixed-data-table-2/releases).



License

-------



`FixedDataTable` is [BSD-licensed](https://github.com/schrodinger/fixed-data-table-2/blob/master/LICENSE). We also provide an additional [patent grant](https://github.com/schrodinger/fixed-data-table-2/blob/master/PATENTS).