Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/denisraslov/react-spreadsheet-grid
An Excel-like grid component for React with custom cell editors, performant scroll & resizable columns
https://github.com/denisraslov/react-spreadsheet-grid
data-grid excel grid grid-component javascript keyboard react spreadsheet table
Last synced: about 1 month ago
JSON representation
An Excel-like grid component for React with custom cell editors, performant scroll & resizable columns
- Host: GitHub
- URL: https://github.com/denisraslov/react-spreadsheet-grid
- Owner: denisraslov
- License: mit
- Created: 2017-10-12T19:54:49.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-17T22:19:42.000Z (8 months ago)
- Last Synced: 2024-10-01T15:21:31.290Z (about 1 month ago)
- Topics: data-grid, excel, grid, grid-component, javascript, keyboard, react, spreadsheet, table
- Language: JavaScript
- Homepage: https://denisraslov.github.io/grid
- Size: 6.74 MB
- Stars: 1,143
- Watchers: 16
- Forks: 55
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# React Spreadsheet Grid
> An Excel-like grid component for React with custom cell editors, performant scroll & resizable columns
## The key features
This is an Excel-like Spreadsheet Grid component that supports:
✅ Custom cell editors (use built-in Input and Select, or any other components) & header content
✅ Performant scroll for as many rows as you need
✅ Resizable columns
✅ Control by mouse & from keyboard
✅ Flexible setting of disabled cells
✅ Lazy loading support
✅ Customizable CSS styling
✅ Hooks compatible
✅ TypeScript compatible
## Table of contents
- [Live playground](#live-playground)
- [Installation](#installation)
- [A primitive example](#a-primitive-example)
- [The pattern of regular usage](#the-pattern-of-regular-usage)
- [Props](#props)
- [Public methods](#public-methods)
- [Customizing cells & header content](#customizing-cells--header-content)
- [Built-in Input](#built-in-input)
- [Built-in Select](#built-in-select)
- [Another component](#another-component)
- [Performant scroll](#performant-scroll)
- [Resizable columns](#resizable-columns)
- [Control by mouse & from keyboard](#control-by-mouse--from-keyboard)
- [Lazy loading support](#lazy-loading-support)
- [Customizing CSS styles](#customizing-css-styles)
## Live playground
For examples of the grid in action, you can run the demo on your own computer:
* Clone this repository
* `npm install`
* `npm run storybook`
* Visit http://localhost:6006/
## Installation
This module is distributed via [npm](https://www.npmjs.com/) and should be installed as one of your project's `dependencies`:
```
npm install --save react-spreadsheet-grid
```
> ⚠️ **IMPORTANT!** This package also depends on `react`, `react-dom` and `prop-types`. Please make sure you have those installed as well.
## A primitive example
```jsx
import React, { useState } from 'react'
import { Grid, Input, Select } from 'react-spreadsheet-grid'
const rows = [
{ id: 'user1', name: 'John Doe', positionId: 'position1' },
// and so on...
];
const MyAwesomeGrid = () => {
return (
'Name',
value: (row, { focus }) => {
return (
);
}
}, {
title: () => 'Position',
value: (row, { focus }) => {
return (
);
}
}
]}
rows={rows}
getRowKey={row => row.id}
/>
)
}
```
## The pattern of regular usage
Take a closer look at 2 main thing: **a declaration of columns** and **work with the state of the parent component**.
To get the correct behavior of the grid you should:
* Store rows and columns of the grid in the state of the parent component.
* Describe how the grid renders values of the cells.
* Have a callback that changes values of the rows in the state of the parent component.
Let's see how it works:
```jsx
import { Grid, Input, Select } from 'react-spreadsheet-grid'
import AwesomeAutocomplete from 'awesome-autocomplete'
const rows = [
{ id: 'user1', name: 'John Doe', positionId: 'position1', managerId: 'manager1' },
// and so on...
];
const MyAwesomeGrid = () => {
// Rows are stored in the state.
const [rows, setRows] = useState(rows);
// A callback called every time a value changed.
// Every time it save a new value to the state.
const onFieldChange = (rowId, field) => (value) => {
// Find the row that is being changed
const row = rows.find({ id } => id === rowId);
// Change a value of a field
row[field] = value;
setRows([].concat(rows))
}
const initColumns = () => [
{
title: () => 'Name',
value: (row, { focus }) => {
// You can use the built-in Input.
return (
);
}
}, {
title: () => 'Position',
value: (row, { focus }) => {
// You can use the built-in Select.
return (
);
}
}, {
title: () => 'Manager',
value: (row, { active, focus }) => {
// You can use whatever component you want to change a value.
return (
);
}
}
]
return (
row.id}
/>
)
}
```
## Props
### columns
```jsx
arrayOf({
id: string / number,
title: string / func,
value: string / func(row, { active, focus, disabled }),
width: number,
getCellClassName: func(row)
})
```
> defaults to `[]`
> `required`
This is the most important prop that defines columns of the table. Every item of the array is responsible for the corresponding column.
key | Required | Mission
--- | --- | ---
`id` | yes | An identifier of a row.
`title` | yes | This is what you want to put in the header of the column, it could be passed as a string or as a func returning a React element.
`value` | yes | This is content of the cell. Works the same way as `title`, but func receives `row` and current state of the cell (`{ active, focus, disabled }`) as parameters, so you can create an output based on them.
`width` | no | Pass this property if you want to initialize the width of a column. You can set width not for all the columns, then the rest of the table width would be distributed between the columns with unspecified width. Also, you can get width of the columns from `onColumnResize` callback to store somewhere and use for the next render to make columns stay the same width.
`getCellClassName` | no | An additional class name getter for a row.
### rows
> `arrayOf(any)` | defaults to `[]`
> `required`
This is an array of rows for the table. Every row will be passed to a `column.value` func (if you use it).
### getRowKey
> `func(row)`
> `required`
This is a func that must return *unique* key for a row based on this row in a parameter.
### placeholder
> `string` | defaults to `"There are no rows"`
Used as a placeholder text when the `rows` array is empty.
### disabledCellChecker
> `func(row, columnId): bool`
Use this func to define what cells are disabled in the table. It gets `row` and `columnId` (defined as `column.id` in a `columns` array) as parameters and identifiers of a cell. It should return boolean `true / false`. A disabled cell gets special CSS-class and styles. Also, you can define a `column.value` output based on the `disabled` state parameter.
### onCellClick
> `func(row, columnId)`
A click handler function for a cell. It gets `row` and `columnId` (defined as `column.id` in the `columns` array) as parameters and identifiers of a cell.
### onActiveCellChanged
> `func({ x, y })`
A callback called every time the active cell is changed. It gets `{ x, y }` coordinates of the new active cell as parameters.
### headerHeight
> `number` | defaults to `40`
The height of the header of the table in pixels.
⚠️ Define it as a prop, not in CSS styles to not broke the scroll of the table. ⚠️
### rowHeight
> `number` | defaults to `48`
The height of a row of the table in pixels.
⚠️ Define it as a prop, not in CSS styles to not broke the scroll of the table. ⚠️
### focusOnSingleClick
> `boolean`
> defaults to `false`
By default, double clicking a cell sets the focus on the cell's input. Pass `true` if you want to set the focus on the cell's input upon single clicking it.
### isColumnsResizable
> `bool` | defaults to `false`
Switch this on if you want the table provides an opportunity to resize column width.
### onColumnResize
> `func(widthValues: object)`
A callback called every time the width of a column was resized. Gets `widthValues` object as a parameter. `widthValues` is a map of values of width for all the columns in percents (`columnId` - `value`).
### isScrollable
> `boolean`
> defaults to `true`
This defines should a grid has a scrollable container inside of a DOM-element where it was rendered, or not. When it turned on (by default), only visible rows are rendered and that improves performance. If you pass `false`, all the rows will be rendered at once (that is not a good way to handle with a big amount of them), but you will have opportunity to set up a scroll area where you want it to be and have other components (before or after the grid) included in this area.
### onScroll
> `func(scrollPosition: number)`
A callback called every time the position of the scroll of the grid was changed.
### onScrollReachesBottom
> `func()`
A callback called when the scroll of the grid reaches its bottom value. Usually, it could be used to implement the lazy loading feature in your grid (see the [Lazy loading support](#the-pattern-of-regular-usage) section for details).
## Public methods
Use public methods via a grid's ref:
```jsx
const GridWrapper = () => {
const gridRef = React.createRef()
React.useEffect(() => {
gridRef.current.resetScroll()
})
return (
)
}
```
### resetScroll()
Call to reset the scroll to the top of the container.
### focusCell({ x: number, y: number })
Call to make the cell with this `x, y` coordinates (starting from `0`) active and focused.
## Customizing cells & header content
You can customize content of titles and cells using `title` and `value` keys of elements of the `columns` property. Setting these components using `row` and `{ active, focus, disabled }` parameters of the functions.
`title` could be a string or a func returning any React element.
`value` works the same way, but func receives current `row` and current state of the cell (`{ active, focused, disabled }`) as parameters, so you can create an output based on them.
For the basic usage, the library provide 2 default components that you can use out-of-the-box: `Input` and `Select`. Perhaps, they will be enough for you. However, you can use any other React components for that purpose: autocompletes, checkboxes, etc.
### Built-in Input
`Input` prop types:
Prop | Type | Mission
--- | --- | ---
`value` | string | The value of the input
`placeholder` | string | Placeholder displaying when there is no value
`focus` | bool | Should the input has focus or not
`selectTextOnFocus` | bool | Should the input content be selected when focused or not
`onChange` | func | Blur callback. Use it to catch a changed value
Usage:
```jsx
import { Grid, Input } from 'react-spreadsheet-grid'
{
return Name
},
value: (row, { focus }) => {
return (
);
}
}
]}
/>
```
### Built-in Select
`Select` prop types:
Prop | Type | Mission
--- | --- | ---
`items` | arrayOf({ id: string / number, name: string }) | Items for select
`selectedId` | string / number | Id of a selected item
`placeholder` | string | Placeholder displaying when there is no selected item
`isOpen` | bool | Should the select be open or not
`onChange` | func | Change item callback. Use it to catch a changed value
Usage:
```jsx
import { Grid, Select } from 'react-spreadsheet-grid'
const positions = [{
id: 1,
name: 'Frontend developer'
}, {
id: 2,
name: 'Backend developer'
}];
{
return Position
},
value: (row, { focus }) => {
return (
);
}
}
]}
/>
```
### Another component
Let's suggest you need to use an autocomplete as a content of a cell. This is how it could be done:
```jsx
import { Grid } from 'react-spreadsheet-grid'
import AwesomeAutocomplete from 'awesome-autocomplete'
{
return Manager
},
value: (row, { focus, active }) => {
return (
);
}
}
]}
/>
```
## Performant scroll
A behavior of scroll depends on the `isScrollable` prop.
If `isScrollable` is `false`, the grid renders all the passed rows without a scroll. Probably, this would be useful for small amount of the rows.
If `isScrollable` is `true`, the height of the grid is equal to the height of its container, it has a scroll and renders only the rows that are visible. Therefore, you can pass to it as many rows as you want - it will work fine without any problems with rendering and scroll. This would be useful for big amount of the rows.
This is an example, how we could make a 500px height scrollable grid:
```jsx
```
## Resizable columns
`react-spreadsheet-grid` provides the opportunity to set initial width values for columns, to resize them from the UI and to react on these changes. Use relevant `columnWidthValues`, `isColumnsResizable` and `onColumnResize` properties for that purpose.
This is how it could be done:
```jsx
import React, { useState } from 'react'
import { Grid } from 'react-spreadsheet-grid'
const ResizableGrid = () => {
// Put columns to the state to be able to store there their width values.
const [columns, setColumns] = useState(initColumns())
// Change columns width values in the state to not lose them.
const onColumnResize = (widthValues) => {
const newColumns = [].concat(columns)
Object.keys(widthValues).forEach((columnId) => {
newColumns[columnId].width = widthValues[columnId]
})
setColumns(newColumns)
}
return (
row.id}
/>
)
}
```
## Control by mouse & from keyboard
`react-spreadsheet-grid` could be controlled by a mouse and from keyboard (just like Excel-table could). When a mouse is used, single click make a cell `active`, double click make a cell `focused`. When a keyboard used, `←` `→` `↑` `↓` move `active` cell, `ENTER` and `TAB` make a cell `focused`.
## Customizing CSS styles
Right now, the easiest way to tweak `react-spreadsheet-grid` is to create another stylesheet to override the default styles. For example, you could create a file named `react_spreadsheet_grid_overrides.css` with the following contents:
```css
.SpreadsheetGrid__cell_active {
box-shadow: inset 0 0 0 2px green;
}
```
This would override the color of borders for the table active cell.
⚠️ The only exception, that you have to use `headerHeight` and `rowHeight` props to redefine height of the header and rows to not broke the scroll of the table.
## Lazy loading support
`react-spreadsheet-grid` provides the opportunity to implement the lazy loading feature in your grid. Use the `onScrollReachesBottom` callback to handle a situation when the scroll position reaches its bottom. Load a new portion of the rows and put them in the state of a high-order component.
This is how it could be done:
```jsx
import React, { useState } from 'react'
import { Grid } from 'react-spreadsheet-grid'
const LazyLoadingGrid = () => {
/* Init the state with the initial portion of the rows */
const [rows, setRows] = useState(initialRows);
const onScrollReachesBottom = () => {
loadNewPortionOfRows().then((newRows) => {
setRows(rows.concat(newRows));
});
}
const loadNewPortionOfRows = () => {
/* an ajax request here */
}
return (
row.id}
onScrollReachesBottom={onScrollReachesBottom}
/>
)
}
```