@8sheets/data-grid-react
v1.1.0
Published
React component for 8sheets Data Grid: <DataGrid> with options passed through, typed props, change event and ref.
Maintainers
Readme
8sheets Data Grid for React
<DataGrid> puts an 8sheets Data Grid in a React app. It works with React 18 and 19, StrictMode included, and with server rendering. Props, the change event and the ref are typed. This is version 1.1.0.
Install
npm i @8sheets/data-grid-react @8sheets/data-gridUse
import { useMemo, useRef } from 'react';
import { DataGrid } from '@8sheets/data-grid-react';
export function Orders({ orders }) {
const grid = useRef(null);
const options = useMemo(() => ({ title: 'Orders', data: orders, chrome: 'light' }), [orders]);
return (
<div style={{ height: 480 }}>
<DataGrid ref={grid} options={options} onChange={(change) => console.log(change.action)} />
</div>
);
}The component renders one <div> that fills its container, so the container needs a height.
optionsgoes tomountTableas it is, including options a later release of the grid adds. A changedchromegoes tosetChromein place; any other changed option mounts the grid again.datais compared by identity, so keep the same array (useMemo) until the records change.onChange(change)reports each data change, by the user or through the API. The grid's other events (onStateChange,onRangeChange,onBeforeEdit…) and any otheron…prop go to the grid as the options of those names. Handlers always come from the latest render.onReady(grid)gives the grid each time it has mounted;onError(err)reports a failed mount or an action inside the grid that failed.- The ref (
DataGridRef) hasgridand every method of the grid exceptdestroy,onandoff. - On unmount the grid is destroyed, with its Worker.
Next.js and Vite
data-grid.js is marked 'use client' and mounts in an effect, so the server sends an empty <div>. In Vite set worker: { format: 'es' }, and before Vite 8 also optimizeDeps: { exclude: ['@8sheets/data-grid', '@8sheets/data-grid-react'] }.
Documentation
Framework wrappers for this component in detail, and the API reference for every option of the grid.
Licence
8sheets is commercial software, not open source. You may install it and try it for free, to evaluate it. Using it in a product, or deploying it for your users or your own staff, needs a licence from 8sheets.com/pricing: Internal 999 USD or SaaS / OEM 2,999 USD, each paid once per company and covering every developer and every deployment, or Enterprise, quoted. One licence covers both 8sheets products, Spreadsheet and Data Grid. There is no licence key and nothing in the package checks for one. The terms are in LICENSE.md and, once you hold a licence, the 8sheets Source Licence.
