Installation

Ezygrid is a pnpm workspace monorepo. Node >= 20 and pnpm 11 are recommended.

Next step

Once installed, follow the Getting started walkthrough for the fastest path to a working grid.

From the repository

git clone https://github.com/bookklik-technologies/ezygrid.git
cd ezygrid
pnpm install
pnpm build

Packages are consumed from packages/*/dist (workspace workspace:* dependencies). @ezygrid/model, @ezygrid/formula, @ezygrid/csv, @ezygrid/core and @ezygrid/xlsx ship dual builds: ESM by default plus a CommonJS build under their require export condition. @ezygrid/react, @ezygrid/vue and @ezygrid/web-component are ESM-only — framework-native consumers always use a bundler. All packages ship full .d.ts declarations.

Installing packages into your project

Once packages are published or wired via a package manager file dependency:

pnpm add @ezygrid/core @ezygrid/theme-default

WARNING

Packages are at version 0.1.1 and not yet published to npm. Until then, depend on the workspace directly.

Core packages

Import	Purpose
@ezygrid/core	Main library: Ezygrid, createGrid, Workbook, renderer, services
@ezygrid/core/auto	Declarative startup scanning for [data-ezg-editor]
@ezygrid/core/browser	Typings for the standalone script global
@ezygrid/model	Coordinates, sparse store, operations
@ezygrid/formula	Formula engine, function registry
@ezygrid/formula/worker-main	Calc web worker entry
@ezygrid/csv	CSV parse/stringify
@ezygrid/xlsx	XLSX import/export

Themes

import '@ezygrid/theme-default/index.css'; // or '@ezygrid/theme-dark/index.css'

Development workflow

pnpm test        # vitest run (unit + DOM tests)
pnpm build       # tsc project references for all packages + browser loader
pnpm typecheck   # tsc --build
pnpm lint        # eslint

TypeScript configuration is strict (ES2022 target, noUncheckedIndexedAccess).

Platform requirements

XLSX import inflates real Excel archives with the Compression Streams API (deflate-raw). Supported runtimes: Chrome/Edge ≥ 80, Safari ≥ 16.4, Firefox ≥ 113, Node ≥ 18. On older runtimes workbookFromXlsx throws a descriptive error instead of crashing; CSV and JSON import/export have no such floor.