react-data-grid

[![npm-badge]][npm-url]
[![type-badge]][npm-url]
[![size-badge]][size-url]
[![codecov-badge]][codecov-url]
[![ci-badge]][ci-url]

[npm-badge]: https://img.shields.io/npm/v/react-data-grid
[npm-url]: https://www.npmjs.com/package/react-data-grid
[size-badge]: https://img.shields.io/bundlephobia/minzip/react-data-grid
[size-url]: https://bundlephobia.com/package/react-data-grid
[type-badge]: https://img.shields.io/npm/types/react-data-grid
[codecov-badge]: https://codecov.io/gh/adazzle/react-data-grid/branch/main/graph/badge.svg?token=cvrRSWiz0Q
[codecov-url]: https://app.codecov.io/gh/adazzle/react-data-grid/branch/main
[ci-badge]: https://github.com/adazzle/react-data-grid/workflows/CI/badge.svg
[ci-url]: https://github.com/adazzle/react-data-grid/actions

Features

- React 16.14+ & 17.0+ support
- Evergreen browsers and server-side rendering support
- Tree-shaking support and only one npm dependency to keep your bundles slim
- Great performance thanks to virtualization: columns and rows outside the viewport are not rendered
- Strictly typed with TypeScript
- Keyboard accessibility>)
- Light and dark mode support out of the box. The light or dark themes can be enforced using the rdg-light or rdg-dark classes.
- Frozen columns
- Column resizing
- Multi-column sorting
- Click on a sortable column header to toggle between its ascending/descending sort order
- Ctrl+Click / Meta+Click to sort an additional column
- Column spanning
- Row selection
- Row grouping
- Summary rows
- Dynamic row heights
- No rows fallback
- Cell formatting
- Cell editing
- Cell copy / pasting
- Cell value dragging / filling

Links

- Examples website
- Source code
- Old website for react-data-grid v6
- Changelog
- Contributing

Install

``sh
npm install react-data-grid
`

react-data-grid is published as ECMAScript modules for evergreen browsers / bundlers, and CommonJS for server-side rendering / Jest.

Quick start

`jsx
import DataGrid from 'react-data-grid';

const columns = [
{ key: 'id', name: 'ID' },
{ key: 'title', name: 'Title' }
];

const rows = [
{ id: 0, title: 'Example' },
{ id: 1, title: 'Demo' }
];

function App() {
return ;
}
`

API

$3

####

##### Props

###### columns: readonly Column[]

See Column.

An array describing the grid's columns.

:warning: Passing a new columns array will trigger a re-render for the whole grid, avoid changing it as much as possible for optimal performance.

###### rows: readonly R[]

An array of rows, the rows data can be of any type.

###### summaryRows?: Maybe

An optional array of summary rows, usually used to display total values for example.

###### rowKeyGetter?: Maybe<(row: R) => K>

A function returning a unique key/identifier per row. rowKeyGetter is required for row selection to work.

`tsx
import DataGrid from 'react-data-grid';

interface Row {
id: number;
name: string;
}

function rowKeyGetter(row: Row) {
return row.id;
}

function MyGrid() {
return ;
}
`

:bulb: While optional, setting this prop is recommended for optimal performance as the returned value is used to set the key prop on the row elements.

###### onRowsChange?: Maybe<(rows: R[], data: RowsChangeData) => void>

A function receiving row updates.
The first parameter is a new rows array with both the updated rows and the other untouched rows.
The second parameter is an object with an indexes array highlighting which rows have changed by their index, and the column where the change happened.

`tsx
import { useState } from 'react';
import DataGrid from 'react-data-grid';

function MyGrid() {
const [rows, setRows] = useState(initialRows);

return ;
}
`

###### rowHeight?: Maybe) => number)>

Default: 35 pixels

Either a number defining the height of row in pixels, or a function returning dynamic row heights.

###### headerRowHeight?: Maybe

Default: 35 pixels

A number defining the height of the header row.

###### summaryRowHeight?: Maybe

Default: 35 pixels

A number defining the height of summary rows.

###### selectedRows?: Maybe>

###### onSelectedRowsChange?: Maybe<(selectedRows: Set) => void>

###### sortColumns?: Maybe

###### onSortColumnsChange?: Maybe<(sortColumns: SortColumn[]) => void>

###### defaultColumnOptions?: Maybe>

###### groupBy?: Maybe

###### rowGrouper?: Maybe<(rows: readonly R[], columnKey: string) => Record>

###### expandedGroupIds?: Maybe>

###### onExpandedGroupIdsChange?: Maybe<(expandedGroupIds: Set) => void>

###### onFill?: Maybe<(event: FillEvent) => R>

###### onPaste?: Maybe<(event: PasteEvent) => R>

###### onRowClick?: Maybe<(row: R, column: CalculatedColumn) => void>

###### onRowDoubleClick?: Maybe<(row: R, column: CalculatedColumn) => void>

###### onScroll?: Maybe<(event: React.UIEvent) => void>

###### onColumnResize?: Maybe<(idx: number, width: number) => void>

###### cellNavigationMode?: Maybe

###### enableVirtualization?: Maybe

###### rowRenderer?: Maybe>>

The default component can be wrapped via the rowRenderer prop to add context providers or tweak props for example.

`tsx
import DataGrid, { Row, RowRendererProps } from 'react-data-grid';

function MyRowRenderer(props: RowRendererProps) {
return (



);
}

function MyGrid() {
return ;
}
`

:warning: To prevent all rows from being unmounted on re-renders, make sure to pass a static or memoized component to rowRenderer.

###### noRowsFallback?: React.ReactNode

###### rowClass?: Maybe<(row: R) => Maybe>

###### className?: string | undefined

###### style?: CSSProperties | undefined

###### 'aria-label'?: string | undefined

###### 'aria-labelledby'?: string | undefined

###### 'aria-describedby'?: string | undefined

###### 'data-testid'?: Maybe

####

##### Props

See EditorProps

####

See rowRenderer

##### Props

See RowRendererProps

The ref prop is supported.

####

##### Props

###### onSort: (ctrlClick: boolean) => void

###### sortDirection: SortDirection | undefined

###### priority: number | undefined

###### isCellSelected: boolean

###### children: React.ReactNode

####

##### Props

See FormatterProps

####

##### Props

###### value: boolean

###### isCellSelected: boolean

###### disabled?: boolean | undefined

###### onChange: (value: boolean, isShiftClick: boolean) => void

###### onClick?: MouseEventHandler | undefined

###### 'aria-label'?: string | undefined

###### 'aria-labelledby'?: string | undefined

####

##### Props

See GroupFormatterProps

$3

#### useRowSelection(): [boolean, (selectRowEvent: SelectRowEvent) => void]

$3

#### SelectColumn: Column

#### SELECT_COLUMN_KEY = 'select-row'

$3

#### Column

#### DataGridHandle

#### EditorProps

#### FormatterProps

#### GroupFormatterProps

#### RowRendererProps

$3

- R, TRow: Row type
- SR, TSummaryRow: Summary row type
- K`: Row key type