Installation
Installation
Section titled “Installation”React Project (Recommended)
Section titled “React Project (Recommended)”Install the core engine and the React wrapper together:
npm install @witqq/spreadsheet @witqq/spreadsheet-reactThis gives you the WitTable React component with full TypeScript support.
Peer Dependencies
Section titled “Peer Dependencies”The React wrapper requires React 18 or later:
{ "peerDependencies": { "react": ">=18.0.0", "react-dom": ">=18.0.0" }}If your project already has React installed, no additional action is needed.
Core Only (Vanilla TypeScript)
Section titled “Core Only (Vanilla TypeScript)”If you are not using React, install just the core engine:
npm install @witqq/spreadsheetThe core package has zero external dependencies. It works in any JavaScript environment — browsers, Node.js, Web Workers, or any framework.
You can build your own framework wrapper on top of the core WitEngine class.
Plugins
Section titled “Plugins”Official plugins are available as a separate package:
npm install @witqq/spreadsheet-pluginsThis package includes:
| Plugin | Description |
|---|---|
| Formula | Tokenizer, parser, evaluator, dependency graph |
| Conditional Format | Gradients, data bars, icon sets |
| Excel I/O | Import/export via lazy-loaded SheetJS (Apache-2.0) |
| Context Menu | Right-click menu with keyboard navigation |
Plugins are registered via the engine’s plugin API and can be installed or removed at runtime.
Verify Installation
Section titled “Verify Installation”After installing, verify the packages are available by importing them in your project:
import { WitEngine } from '@witqq/spreadsheet';import { WitTable } from '@witqq/spreadsheet-react';
// Both imports should resolve without errorsconsole.log('witqq spreadsheet installed successfully');Run your development server or build to confirm there are no module resolution issues.
Package Sizes
Section titled “Package Sizes”| Package | Size (minified + gzipped) |
|---|---|
@witqq/spreadsheet | ~120 KB |
@witqq/spreadsheet-react | ~8 KB |
@witqq/spreadsheet-plugins | ~45 KB (without SheetJS) |
The core engine is designed to stay under 500KB total to keep bundle sizes reasonable for web applications.
Next Steps
Section titled “Next Steps”- Quick Start — Build your first table
- Configuration — All available options