woohs / rsuite-table

A React table component.

rsuite-table

A React table component,

Features

• Support virtualized.
• Support fixed header, fixed column.
• Support custom adjustment column width.
• Support for custom cell content.
• Support for displaying a tree form.
• Support for sorting.
• Support for expandable child nodes

Preview

• Fixed Column

• Custom Cell

• Tree Table

• Expandable

More Examples

Install

npm i rsuite-table --save

Usage

import { Table, Column, HeaderCell, Cell } from 'rsuite-table';
import 'rsuite-table/lib/less/index.less';

const dataList = [
  { id: 1, name: 'a', email: '[email protected]', avartar: '...' },
  { id: 2, name: 'b', email: '[email protected]', avartar: '...' },
  { id: 3, name: 'c', email: '[email protected]', avartar: '...' }
];

const ImageCell = ({ rowData, dataKey, ...props }) => (
  <Cell {...props}>
    <img src={rowData[dataKey]} width="50" />
  </Cell>
);

<Table data={dataList}>
  <Column width={100} sort fixed resizable>
    <HeaderCell>ID</HeaderCell>
    <Cell dataKey="id" />
  </Column>

  <Column width={100} sort resizable>
    <HeaderCell>Name</HeaderCell>
    <Cell dataKey="name" />
  </Column>

  <Column width={100} sort resizable>
    <HeaderCell>Email</HeaderCell>
    <Cell>
      {(rowData, rowIndex) => {
        return <a href={`mailto:${rowData.email}`}>{rowData.email}</a>;
      }}
    </Cell>
  </Column>

  <Column width={100} resizable>
    <HeaderCell>Avartar</HeaderCell>
    <ImageCell dataKey="avartar" />
  </Column>
</Table>;

API

<Table>

Property	Type (Default)	Description
autoHeight	boolean	Automatic height
bordered	boolean	Show border
bodyRef	React.ElementRef	A ref attached to the table body element
cellBordered	boolean	Show cell border
data *	Array<Object>	Table data
defaultExpandAllRows	boolean	Expand all nodes By default
defaultExpandedRowKeys	Array<string>	Specify the default expanded row by rowkey
defaultSortType	enum: 'desc', 'asc'	Sort type
expandedRowKeys	Array<string>	Specify the default expanded row by rowkey (Controlled)
headerHeight	number(40)	Table Header Height
height	number(200)	Table height
hover	boolean (true)	The row of the table has a mouseover effect
isTree	boolean	Show as Tree table
loading	boolean	Show loading
minHeight	number (0)	Minimum height
onExpandChange	(expanded:boolean,rowData:object)=>void	Tree table, the callback function in the expanded node
onRowClick	(rowData:object, event: SyntheticEvent)=>void	Click the callback function after the row and return to rowDate
onScroll	(scrollX:object, scrollY:object)=>void	Callback function for scroll bar scrolling
onSortColumn	(dataKey:string, sortType:string)=>void	Click the callback function of the sort sequence to return the value sortColumn, sortType
renderRowExpanded	(rowDate?: Object) => React.Node	Customize what you can do to expand a zone
renderTreeToggle	(icon:node,rowData:object)=> node	Tree table, the callback function in the expanded node
renderEmpty	(info: React.Node) => React.Node	Customized data is empty display content
renderLoading	(loading: React.Node) => React.Node	Customize the display content in the data load
rowClassName	string , (rowData:object)=>string	Add an optional extra class name to row
rowExpandedHeight	number (100)	Set the height of an expandable area
rowHeight	number(46)	Row height
rowKey	string ('key')	Each row corresponds to the unique key in data
setRowHeight	(rowData:object)=> number	Custom Settings Row Height
showHeader	boolean (true)	Display header
sortColumn	string	Sort column name ˝
sortType	enum: 'desc', 'asc'	Sort type (Controlled)
virtualized	boolean	Effectively render large tabular data
width	number	Table width
locale	object: { emptyMessage: ('No data'), loading: ('Loading...') }	Messages for empty data and loading states

<Column>

Property	Type (Default)	Description
align	enum: 'left','center','right'	Alignment
colSpan	number	Merges column cells to merge when the dataKey value for the merged column is null or undefined.
fixed	boolean, 'left', 'right'	Fixed column
flexGrow	number	Set the column width automatically adjusts, when set flexGrow cannot set resizable and width property
minWidth	number(200)	When you use flexGrow, you can set a minimum width by minwidth
onResize	(columnWidth?: number, dataKey?: string) => void	Callback after column width change
resizable	boolean	Customizable Resize Column width
sortable	boolean	Sortable
width	number	Column width
verticalAlign	enum: 'top', 'middle', 'bottom'	Vertical alignment

sortable is used to define whether the column is sortable, but depending on what key sort needs to set a dataKey in Cell. The sort here is the service-side sort, so you need to handle the logic in the ' Onsortcolumn ' callback function of <Table>, and the callback function returns sortColumn, sortType values.

<Cell>

Property	Type (Default)	Description
dataKey	string	Data binding key, but also a sort of key
rowData	object	Row data
rowIndex	number	Row number

There are three ways to use <Cell>, as follows:

• 1.Associate the fields in the data with dataKey.

<Column width="{100}" align="center">
  <HeaderCell>Name</HeaderCell>
  <Cell dataKey="name" />
</Column>

• 2.Customize a <Cell>.

const NameCell = ({ rowData, ...props }) => (
  <Cell {...props}>
    <a href={`mailto:${rowData.email}`}>{rowData.name}<a>
  </Cell>
);

<Column width={100} align="center">
  <HeaderCell>Name</HeaderCell>
  <NameCell />
</Column>

• 3.Customize functions directly within the <Cell>.

<Column width={100} align="center">
  <HeaderCell>Name</HeaderCell>
  <Cell>
    {(rowData, rowIndex) => {
      return <a href={`mailto:${rowData.email}`}>{rowData.name}</a>;
    }}
  </Cell>
</Column>

Methods

• scrollTop(top:number = 0)
• scrollLeft(left:number = 0)