@sheetxl/scripting
v0.7.27TypeScript
Scripting - Scripting engine for Macros and formulas; includes TypeScript and EsBuild.
1.9K/weekUpdated 1 months agoSEE LICENSE IN <LICENSE>Unpacked: 255.8 KB
Published by michaeltford
npm install @sheetxl/scriptingSheetXL — the api-first spreadsheet
$3
SheetXL is the open spreadsheet ecosystem — modular, embeddable, and fully scriptable.
Excel-compatible. API-first. Built for speed.
If you like SheetXL give us a star ⭐ and help others find us!
Whether you're building a custom UI, adding live scripting, or integrating spreadsheet logic into your app, SheetXL
gives you full control with zero platform lock-in.
!SheetXL Animated Demo Link
Headless API. Live Scripting. CLI Tools. Built for developers.
$3
🚀 Getting Started
Get started in minutes with our production ready application.
$3
``bashUsing npm
npm install @sheetxl/sdk @sheetxl/studio-mui @mui/material @emotion/react @emotion/styled
Using yarn
yarn add @sheetxl/sdk @sheetxl/studio-mui @mui/material @emotion/react @emotion/styled
`
$3
javascript
import React from 'react';
import { Studio } from '@sheetxl/studio-mui';function App() {
// Studio will fill it's parent container.
return (
);
}
`For more advanced setup options, check out our full
Getting Started Guides.
$3
The SheetXL ecosystem is modular by design. You can use only what you need — or compose it all together.
$3
At the core of the ecosystem is a headless, high-performance SDK
,
built to power everything from lightweight grid widgets to massive enterprise-scale calculation enginesKey features:
* Blazing Speed: Executes 10M+ operations per second and handles spreadsheets with 17B+ cells.
* Powerful API: A modern, vectorized, range-based API for precise, scriptable control over data — independent of any UI.
$3
Build UIs your way — from plug-and-play dashboards to fully custom design systems.
@sheetxl/studio-mui: A complete, open-source spreadsheet UI with Excel-grade features. Ready to ship.
* Custom Interface @sheetxl/react: A flexible component and hook library for deep customization.$3
Easily load and save workbooks in popular formats:
*
xlsx (Excel)
* csv
* (in progress)
* json (native format)
Click to see the a detailed overview of all modules...
Items marked with 💎 are part of the premium licensing.| Category | Module | Description | License |
|--------------|-------------------------|-----------------------------|---------|
| Core | @sheetxl/sdk 💎 | Headless spreadsheet API | Commercial |
| | @sheetxl/formulas | Collection of 400+ formulas | MIT |
| | @sheetxl/primitives | Low level types (Scalar, IRange) | MIT |
| | @sheetxl/scripting 💎 | Scripting engine and compiler | Commercial |
| IO | @sheetxl/io | Import/export (xlsx, csv, json) | MIT |
| Applications | @sheetxl/studio-vanilla | Framework-agnostic spreadsheet app | MIT |
| | @sheetxl/studio-mui | Spreadsheet app powered by React/MUI | MIT |
| UI Toolkits | @sheetxl/react 💎 | Spreadsheet React UI components and hooks | Commercial |
| | @sheetxl/grid-react 💎 | Lightweight, standalone React data grid | Commercial |
| Utils | @sheetxl/utils | Headless utilities (math, ranges, etc) | MIT |
| | @sheetxl/utils-react | React UI helpers | MIT |
| | @sheetxl/utils-mui | MUI UI helpers (color picker, dialogs, etc) | MIT |
Key Features
SheetXL is built on four core pillars: extreme performance, deep Excel compatibility, unparalleled developer power, and a modern, extensible architecture.
* Performance & Scale
Process 10M+ ops/second and manage massive 17B+ cell workbooks, all in-browser.
* True Excel Fidelity
Go beyond basic formulas. Get the Excel-grade features your users demand, from tables and charts to cross-sheet copy/paste.
* Unmatched Developer Power
With a headless core, a powerful vectorized API, and a built-in scripting engine, you have the ultimate control to build any experience.
* Modern, Open Architecture
Built with TypeScript and a flexible plugin model, including a fully open-sourced MIT-licensed MUI design system.
🔥 Power Features
$3
Write and execute TypeScript/JavaScript directly inside your spreadsheet. Perfect for complex data transformations, custom validation, and real-time calculations.
$3
Automate spreadsheet operations, run batch processes, and integrate SheetXL into your build pipeline with our full-featured CLI.
bash
Run custom scripts
sheetxl run process-data.ts --workbook sales.xlsx
``$3
* 17B+ cells (The same as Excel)
* 400+ Excel-compatible formulas
* Full fidelity Excel import/export
* Scripting Engine
* Fast. Autofill 1,048,576 rows with formulas in 0.7s (10M+ formulas/second)
Click to see the full list of additional User Features...
* Formatted Copy/Paste (Compatible with Microsoft Excel and Google Sheet)
* Hidden Rows/Columns
* Frozen Rows/Columns
* Resizable, Auto-fit Rows/Columns
* Office Theme (Color Picker, Theme Selector)
* Cell Styles (Themes and Formatting)
* Preset Cell Style Selector
* Overflow, Word-wrap
* Borders
* Tables
* Drawings
* Multi-range selection
* Merged Cells
* Autofill
* Keyboard Accessible Support for all Excel shortcut keys
* Undo/Redo
* Find/Replace
* Sort
* Zoom
* Hyperlinks
* Mobile Friendly (Touch / Small screen accommodation)
$3
* Typescript
* Easy Integration
Click to see the full list of Developer Features...
* Built in scripting & Formula support.
* Built from the ground up using React and CSS-in-JS components.
* Fully functional MIT Open-sourced Material-UI Application.
* Headless spreadsheet API can be used without UI and on server or as library.
* Easily extend functions with simple registration.
Roadmap
* Table Filtering (in progress)
🧭 Click to see the full Roadmap...
$3
* Conditional formatting
* Full Styling in Excel Export
* Full Charting (nearly complete)
* Multi-key shortcuts
* Pivot
* Sparklines
* Slicer/Timeline
* Accessibility
* Printing
$3
* Google Sheets Interop
* Collaboration
🤔 Why SheetXL?
We believe developers have been forced to compromise between powerful but closed spreadsheet apps and flexible but limited data grids for too long. SheetXL was built to end that compromise.
$3
Importing and Exporting data from a spreadsheet is a broken part of nearly every business workflow. Instead of
importing/exporting data, just import the spreadsheet.
* Reduce errors on data due to import/export copying of data.
* Real time integration/validation of your data.
* Complete control of data as your data never leaves your systems.
* Improved user productivity.
* Combine custom user enhancements with flexible data manipulation.
$3
As a Microsoft Excel user and a React developer I have always wanted a solution that combines the flexibility and ease of use of Excel with the control and specific capabilities of my custom application.
I wanted my custom applications to have spreadsheet features!
Several great spreadsheet components exists but none of them have:
* Excel compatibility and features.
* Simple integration.
* Billions of cells.
* Comprehensive support for keyboard shortcuts (e.g. tabbing within multi-selected ranges, arrow-keys within cells).
* Enable advanced copy / paste between Excel/Excel Online/Google Sheets.
* Easily extendable libraries that use open-source and modern design patterns.
* Real-time integration to data providing a single source of truth; no copying data between systems using complex APIs.
The Competitive Landscape
We encourage you to explore the landscape. We're confident you'll see why we built SheetXL.
👐 Open-source Spreadsheets Components...
*
*
*
*
*
*
💲 Paid Spreadsheets Components...
*
*
*
*
💲 Paid Data-grids...
A data-grid is a sub-component within a spreadsheet that provides base grid-level rendering but without many of the
spreadsheet features (user styling, formulas, Excel compatibility, etc). Features vary by product but generally
include sorting, filtering, grouping, and basic cell editing.
*
*
*
*
💲 SAAS Spreadsheets...
SAAS spreadsheets are still closed solutions and lack the full experience of Excel.
*
*
*
*
🙏 Credits / 🎉 Special Thanks
* Formula.js (For function references)
* Fast Formula Parser (For grammar support)
* SheetJS (For original number format parsing and Excel import/export)
* Papa Parse (For CSV parsing)
🔗 Learn More
Whether you're ready to build, need help, or just want to see more examples, here's where to go next.
* 💬 Join our Discord Community - Get help and connect with the
* ⭐ Star us on GitHub - If you like SheetXL give us a star ⭐ and help others find us!
* 📘 Developer Docs - Guides and tutorials.
* 🔌 API Reference - Detailed documentation for all packages.
* 👀 Live Demo Gallery - A showcase of interactive examples.
* 🖼️ Storybook - Explore and test individual UI components.
team.
* 🌐 Website - Our Website.
---