@8sheets/data-grid
v1.1.0
Published
Data grid for the web: open CSV and Excel files or pass records, then search, filter, sort, group, total, pivot and export to CSV, Excel or PDF. Worker-backed, a million rows, server data sources.
Maintainers
Readme
8sheets Data Grid
A data grid for the web in plain JavaScript modules with no runtime dependencies. Open a CSV or Excel file, or pass your records, and search, filter, sort, group, total, pivot and export them as CSV, Excel or PDF. Files are read in a Worker as a stream, the page keeps a bounded DOM, and a million records stay responsive. Server data plugs in through a query contract, so search, filters and totals cover the whole result.
This is version 1.1.0. Components for React, Vue and Angular build on it. For a full Excel-compatible workbook, see the Spreadsheet, @8sheets/core.
Install
npm i @8sheets/data-gridUse
import { mountTable } from '@8sheets/data-grid';
const grid = await mountTable(document.querySelector('#orders'), {
title: 'Orders',
fields: [
{ name: 'Region', type: 'string' },
{ name: 'Units', type: 'number' },
{ name: 'Price', type: 'number', format: '#,##0.00' },
{ name: 'Revenue', type: 'number', formula: '[@Units]*[@Price]', format: '#,##0.00' },
],
data: [{ Region: 'East', Units: 2, Price: 24 }],
onChange: (change) => console.log(change.action),
});
await grid.setState({ ...grid.getState(), groups: [{ field: 'Region' }], total: { field: 'Revenue', agg: 'sum' } });
const xlsx = await grid.exportResults('xlsx');
grid.destroy();The element needs a height. The grid brings its own stylesheet, scoped to the element. Pass file to open a local file, or dataSource: remoteTableSource({ queryUrl, exportUrl, detailUrl, updateUrl }) for server data. VERSION is the release.
Bundlers
The grid finds its Worker and stylesheet next to its own modules, with new URL('./…', import.meta.url), so Vite, webpack and Next.js copy them into your build. The Worker is an ES module.
- Vite: set
worker: { format: 'es' }. Before Vite 8, also addoptimizeDeps: { exclude: ['@8sheets/data-grid'] }: the older pre-bundling moves the modules away from their Worker. - Angular CLI: see @8sheets/data-grid-angular, which serves this package as static files.
- No bundler: serve the package folder and import
table-view/index.jsfrom it.
The package holds the files the grid can load, engine code included (file reading and writing, number formats, PDF). Parts load on demand: a page that never opens an Excel file or exports a PDF never downloads that code.
Documentation
- Data Grid docs: getting started, recipes and the API reference.
- Changelog. TypeScript declarations ship with the package.
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.
