@sheetxl/scripting 0.2.6 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +11 -11
- package/README.md +309 -309
- package/browser/cjs/{hk-vy-g6CmJU9xqy.cjs → B7r9o0J98FeOpECG.cjs} +2 -2
- package/browser/cjs/{BARuVA3rLqhjAFo5.cjs → BpsMQL8WKA-7RfCC.cjs} +8 -13
- package/browser/cjs/DBkloFDekvQ92YXS.cjs +6 -0
- package/browser/cjs/{BMqIRQxRw4K8e0-c.cjs → DD5u0jJgnIfl_LRp.cjs} +3 -8
- package/browser/cjs/{liqm9acA3-nrAs3b.cjs → DwQSeolUdto6tnne.cjs} +3 -8
- package/browser/cjs/UDMd4iRmsiNDeVh4.cjs +6 -0
- package/browser/cjs/index.cjs +2 -2
- package/browser/esm/{BcvpIfnTmlQXt7_9.mjs → BB9Q-lDQb6Cd-_mI.mjs} +2 -2
- package/browser/esm/CbSvIMzV_OzOFidG.mjs +24 -0
- package/browser/esm/{RT1buZA9VR5ysUX8.mjs → CeyaVAZTjD2qkAHf.mjs} +9 -10
- package/browser/esm/{CqiaK1eCvblBDvvQ.mjs → CnhwtcVoqbW4lNsP.mjs} +8 -13
- package/browser/esm/{CouN61iEakKgCrZH.mjs → D1tRW1SWMJsVGesD.mjs} +309 -315
- package/browser/esm/{Qa4fAmu0jTRgpzKj.mjs → DQ3J4uNfIXgPKYoJ.mjs} +4 -10
- package/browser/esm/index.mjs +2 -2
- package/licenses/dependencies.txt +22 -22
- package/node/esm/{BnvW-oTnTTprwy5T.mjs → 4mi4tR_Wnw5gjYEb.mjs} +8 -13
- package/node/esm/BtNokzpAfQ4NDORx.mjs +14 -0
- package/node/esm/{DSBZsQA_mN68UsIn.mjs → CHn5nxfVUD9z6idt.mjs} +3 -9
- package/node/esm/{e681qu1_caFk4Ymu.mjs → D5AQfRIkPzleF5Ud.mjs} +1 -1
- package/node/esm/{k-nUdU0HR7EeOebA.mjs → DOzXoj7qdg53TENL.mjs} +2 -2
- package/node/esm/index.mjs +3 -9
- package/package.json +3 -3
- package/browser/cjs/DLR0X2oZPyo6cLlK.cjs +0 -6
- package/browser/cjs/ggqiJ7AVMR5OEJnW.cjs +0 -6
- package/browser/esm/DoJyfH8ar0VgQF35.mjs +0 -24
- package/node/esm/DZtDpK66kCXuqSiq.mjs +0 -14
package/LICENSE.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
# Repository Licensing
|
|
2
|
-
|
|
3
|
-
SheetXL contains a mix of open-source and commercially licensed packages. Each package is individually licensed and contains its own license file.
|
|
4
|
-
|
|
5
|
-
For the specific terms and conditions applicable to a package, please see the `LICENSE.md` file located in that package's root directory.
|
|
6
|
-
|
|
7
|
-
Generally, packages intended for public distribution (such as CLIs, adapters, and vanilla wrappers) are licensed under the MIT license. All other core packages are proprietary and require a commercial license for use.
|
|
8
|
-
|
|
9
|
-
For more details on commercial licensing, please visit our website:
|
|
10
|
-
|
|
11
|
-
https://www.sheetxl.com/licensing-pricing
|
|
1
|
+
# Repository Licensing
|
|
2
|
+
|
|
3
|
+
SheetXL contains a mix of open-source and commercially licensed packages. Each package is individually licensed and contains its own license file.
|
|
4
|
+
|
|
5
|
+
For the specific terms and conditions applicable to a package, please see the `LICENSE.md` file located in that package's root directory.
|
|
6
|
+
|
|
7
|
+
Generally, packages intended for public distribution (such as CLIs, adapters, and vanilla wrappers) are licensed under the MIT license. All other core packages are proprietary and require a commercial license for use.
|
|
8
|
+
|
|
9
|
+
For more details on commercial licensing, please visit our website:
|
|
10
|
+
|
|
11
|
+
https://www.sheetxl.com/licensing-pricing
|
package/README.md
CHANGED
|
@@ -1,309 +1,309 @@
|
|
|
1
|
-
# SheetXL — The Developer-First Spreadsheet Ecosystem
|
|
2
|
-
|
|
3
|
-

|
|
4
|
-
|
|
5
|
-
[](https://discord.gg/NTKdwUgK9p)
|
|
6
|
-
[](https://www.npmjs.com/package/@sheetxl/studio-mui)
|
|
7
|
-
[](https://www.npmjs.com/package/@sheetxl/studio-mui)
|
|
8
|
-
|
|
9
|
-
### The full spreadsheet stack — for developers
|
|
10
|
-
|
|
11
|
-
**SheetXL is the modern spreadsheet ecosystem** — modular, embeddable, and fully scriptable.
|
|
12
|
-
|
|
13
|
-

|
|
14
|
-
|
|
15
|
-
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.
|
|
16
|
-
|
|
17
|
-
### Try it now — Live Demo
|
|
18
|
-
|
|
19
|
-
👉 [See a full SheetXL demo](https://demo.sheetxl.com)
|
|
20
|
-
|
|
21
|
-
## 🚀 Getting Started
|
|
22
|
-
|
|
23
|
-
Get started in minutes with our production ready application.
|
|
24
|
-
|
|
25
|
-
### 1. Installation
|
|
26
|
-
|
|
27
|
-
```bash
|
|
28
|
-
# Using npm
|
|
29
|
-
npm install @sheetxl/sdk @sheetxl/studio-mui @mui/material @emotion/react @emotion/styled
|
|
30
|
-
|
|
31
|
-
# Using yarn
|
|
32
|
-
yarn add @sheetxl/sdk @sheetxl/studio-mui @mui/material @emotion/react @emotion/styled
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
### 2. Basic Usage
|
|
36
|
-
|
|
37
|
-
```javascript
|
|
38
|
-
import React from 'react';
|
|
39
|
-
import { Workbook } from '@sheetxl/studio-mui';
|
|
40
|
-
|
|
41
|
-
function App() {
|
|
42
|
-
// SheetXL will fill it's parent container.
|
|
43
|
-
return (
|
|
44
|
-
<div style={{ height: '600px', width: '100%' }}>
|
|
45
|
-
<Workbook />
|
|
46
|
-
</div>
|
|
47
|
-
);
|
|
48
|
-
}
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
For more advanced setup options, check out our full
|
|
52
|
-
[Getting Started Guides](https://www.sheetxl.com/docs/category/getting-started).
|
|
53
|
-
|
|
54
|
-
### 📚 Ecosystem Overview
|
|
55
|
-
|
|
56
|
-
The SheetXL ecosystem is modular by design. You can use only what you need — or compose it all together.
|
|
57
|
-
|
|
58
|
-
### SDK
|
|
59
|
-
|
|
60
|
-
At the core of the ecosystem is a **headless, high-performance SDK** [`@sheetxl/sdk`](https://www.npmjs.com/package/@sheetxl/sdk),
|
|
61
|
-
built to power everything from lightweight grid widgets to massive enterprise-scale calculation engines
|
|
62
|
-
|
|
63
|
-
Key features:
|
|
64
|
-
|
|
65
|
-
* **Blazing Speed:** Executes 10M+ operations per second and handles spreadsheets with 17B+ cells.
|
|
66
|
-
* **Powerful API:** A modern, vectorized, range-based API for precise, scriptable control over data — independent of any UI.
|
|
67
|
-
|
|
68
|
-
### Applications and UI Toolkits
|
|
69
|
-
|
|
70
|
-
Build UIs your way — from plug-and-play dashboards to fully custom design systems.
|
|
71
|
-
|
|
72
|
-
* **Rapid Deployment** [`@sheetxl/studio-mui`](https://www.npmjs.com/package/@sheetxl/studio-mui): A complete, open-source spreadsheet UI with Excel-grade features. Ready to ship.
|
|
73
|
-
* **Custom Interface** [`@sheetxl/react`](https://www.npmjs.com/package/@sheetxl/react): A flexible component and hook library for deep customization.
|
|
74
|
-
|
|
75
|
-
### I/O Connectors
|
|
76
|
-
|
|
77
|
-
Easily load and save workbooks in popular formats:
|
|
78
|
-
|
|
79
|
-
* `xlsx` (Excel)
|
|
80
|
-
* `csv`
|
|
81
|
-
* `parquet` (in progress)
|
|
82
|
-
* `json` (native format)
|
|
83
|
-
|
|
84
|
-
`Items marked with 💎 are part of the premium licensing.`
|
|
85
|
-
|
|
86
|
-

|
|
87
|
-
|
|
88
|
-
| Category | Module | Description | License |
|
|
89
|
-
|--------------|-------------------------|-----------------------------|---------|
|
|
90
|
-
| Core | @sheetxl/sdk 💎 | Headless spreadsheet API | Commercial |
|
|
91
|
-
| | @sheetxl/formulas | Collection of 400+ formulas | MIT |
|
|
92
|
-
| | @sheetxl/primitives | Low level types (Scalar, IRange) | MIT |
|
|
93
|
-
| | @sheetxl/scripting 💎 | Scripting engine and compiler | Commercial |
|
|
94
|
-
| IO | @sheetxl/io | Import/export (xlsx, csv, json) | MIT |
|
|
95
|
-
| Applications | @sheetxl/studio-vanilla | Framework-agnostic spreadsheet app | MIT |
|
|
96
|
-
| | @sheetxl/studio-mui | Spreadsheet app powered by React/MUI | MIT |
|
|
97
|
-
| UI Toolkits | @sheetxl/react 💎 | Spreadsheet React UI components and hooks | Commercial |
|
|
98
|
-
| | @sheetxl/grid-react 💎 | Lightweight, standalone React data grid | Commercial |
|
|
99
|
-
| Utils | @sheetxl/utils | Headless utilities (math, ranges, etc) | MIT |
|
|
100
|
-
| | @sheetxl/utils-react | React UI helpers | MIT |
|
|
101
|
-
| | @sheetxl/utils-mui | MUI UI helpers (color picker, dialogs, etc) | MIT |
|
|
102
|
-
|
|
103
|
-
## Key Features
|
|
104
|
-
|
|
105
|
-
SheetXL is built on four core pillars: extreme performance, deep Excel compatibility, unparalleled developer power, and a modern, extensible architecture.
|
|
106
|
-
|
|
107
|
-
* **Performance & Scale**
|
|
108
|
-
|
|
109
|
-
* Process 10M+ ops/second and manage massive 17B+ cell workbooks, all in-browser.
|
|
110
|
-
|
|
111
|
-
* **True Excel Fidelity**
|
|
112
|
-
|
|
113
|
-
* Go beyond basic formulas. Get the Excel-grade features your users demand, from tables and charts to cross-sheet copy/paste.
|
|
114
|
-
|
|
115
|
-
* **Unmatched Developer Power**
|
|
116
|
-
|
|
117
|
-
* With a headless core, a powerful vectorized API, and a built-in scripting engine, you have the ultimate control to build any experience.
|
|
118
|
-
|
|
119
|
-
* **Modern, Open Architecture**
|
|
120
|
-
|
|
121
|
-
* Built with TypeScript and a flexible plugin model, including a fully open-sourced MIT-licensed MUI design system.
|
|
122
|
-
|
|
123
|
-
### ✨ User Features
|
|
124
|
-
|
|
125
|
-
* 17+ billion cells (The same as Excel)
|
|
126
|
-
* 400+ Formulas
|
|
127
|
-
* Scripting Engine
|
|
128
|
-
* Full fidelity Import / Export to Excel
|
|
129
|
-
|
|
130
|
-
<details>
|
|
131
|
-
<summary><b>Click to see the full list of User Features...</b></summary>
|
|
132
|
-
|
|
133
|
-
* Formatted Copy/Paste (Compatible with Microsoft Excel and Google Sheet)
|
|
134
|
-
* Hidden Rows/Columns
|
|
135
|
-
* Frozen Rows/Columns
|
|
136
|
-
* Resizable, Auto-fit Rows/Columns
|
|
137
|
-
* Office Theme (Color Picker, Theme Selector)
|
|
138
|
-
* Cell Styles (Themes and Formatting)
|
|
139
|
-
* Preset Cell Style Selector
|
|
140
|
-
* Overflow, Word-wrap
|
|
141
|
-
* Borders
|
|
142
|
-
* Tables
|
|
143
|
-
* Drawings
|
|
144
|
-
* Multi-range selection
|
|
145
|
-
* Merged Cells
|
|
146
|
-
* Autofill
|
|
147
|
-
* Keyboard Accessible Support for all Excel shortcut keys
|
|
148
|
-
* Undo/Redo
|
|
149
|
-
* Find/Replace
|
|
150
|
-
* Sort
|
|
151
|
-
* Zoom
|
|
152
|
-
* Hyperlinks
|
|
153
|
-
* Mobile Friendly (Touch / Small screen accommodation)
|
|
154
|
-
|
|
155
|
-
</details>
|
|
156
|
-
|
|
157
|
-
### 🛠️ Developer Features
|
|
158
|
-
|
|
159
|
-
* Typescript
|
|
160
|
-
* Easy Integration
|
|
161
|
-
|
|
162
|
-
<details>
|
|
163
|
-
<summary><b>Click to see the full list of Developer Features...</b></summary>
|
|
164
|
-
* Built in scripting & Formula support.
|
|
165
|
-
* Built from the ground up using React and CSS-in-JS components.
|
|
166
|
-
* Fully functional MIT Open-sourced Material-UI Application.
|
|
167
|
-
* Headless spreadsheet API can be used without UI and on server or as library.
|
|
168
|
-
* Easily extend functions with simple registration.
|
|
169
|
-
|
|
170
|
-
</details>
|
|
171
|
-
|
|
172
|
-
## Roadmap
|
|
173
|
-
|
|
174
|
-
* Table Filtering (in progress)
|
|
175
|
-
|
|
176
|
-
<details>
|
|
177
|
-
<summary><b>🧭 Click to see the full Roadmap...</b></summary>
|
|
178
|
-
|
|
179
|
-
### 2025 Roadmap
|
|
180
|
-
|
|
181
|
-
* Conditional formatting
|
|
182
|
-
* Full Styling in Excel Export
|
|
183
|
-
* Full Charting (nearly complete)
|
|
184
|
-
* Multi-key shortcuts
|
|
185
|
-
* Pivot
|
|
186
|
-
* Sparklines
|
|
187
|
-
* Slicer/Timeline
|
|
188
|
-
* Accessibility <https://www.w3.org/TR/WCAG21/>
|
|
189
|
-
* Printing
|
|
190
|
-
|
|
191
|
-
### 2026 Roadmap
|
|
192
|
-
|
|
193
|
-
* Google Sheets Interop
|
|
194
|
-
* Collaboration
|
|
195
|
-
|
|
196
|
-
</details>
|
|
197
|
-
|
|
198
|
-
## 🤔 Why SheetXL?
|
|
199
|
-
|
|
200
|
-
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.
|
|
201
|
-
|
|
202
|
-
### Why not just a spreadsheet app?
|
|
203
|
-
|
|
204
|
-
Importing and Exporting data from a spreadsheet is a broken part of nearly every business workflow. Instead of
|
|
205
|
-
importing/exporting data, just import the spreadsheet.
|
|
206
|
-
|
|
207
|
-
* Reduce errors on data due to import/export copying of data.
|
|
208
|
-
* Real time integration/validation of your data.
|
|
209
|
-
* Complete control of data as your data never leaves your systems.
|
|
210
|
-
* Improved user productivity.
|
|
211
|
-
* Combine custom user enhancements with flexible data manipulation.
|
|
212
|
-
|
|
213
|
-
### Why not just a spreadsheet component?
|
|
214
|
-
|
|
215
|
-
As a Microsoft Excel user and a React developer I have always wanted a solution that combines the
|
|
216
|
-
flexibility and ease of use of Excel with the control and specific capabilities of my custom application.
|
|
217
|
-
|
|
218
|
-
I wanted my custom applications to have spreadsheet features!
|
|
219
|
-
|
|
220
|
-
Several great spreadsheet components exists but none of them have:
|
|
221
|
-
|
|
222
|
-
* Excel compatibility and features.
|
|
223
|
-
* Simple integration.
|
|
224
|
-
* Billions of cells.
|
|
225
|
-
* Comprehensive support for keyboard shortcuts (e.g. tabbing within multi-selected ranges, arrow-keys within cells).
|
|
226
|
-
* Enable advanced copy / paste between Excel/Excel Online/Google Sheets.
|
|
227
|
-
* Easily extendable libraries that use open-source and modern design patterns.
|
|
228
|
-
* Real-time integration to data providing a single source of truth; no copying data between systems using complex APIs.
|
|
229
|
-
|
|
230
|
-
### Why Now?
|
|
231
|
-
|
|
232
|
-
* TypeScript became the new “default scripting language.”
|
|
233
|
-
* Post-VBA fatigue is real.
|
|
234
|
-
* Excel is powerful but closed.
|
|
235
|
-
* Data grids are customizable but are limited.
|
|
236
|
-
* SaaS is full of spreadsheet imposters.
|
|
237
|
-
|
|
238
|
-
## The Competitive Landscape
|
|
239
|
-
|
|
240
|
-
We encourage you to explore the landscape. We're confident you'll see why we built SheetXL.
|
|
241
|
-
|
|
242
|
-
<details>
|
|
243
|
-
<summary><b>👐 Open-source Spreadsheets Components...</b></summary>
|
|
244
|
-
|
|
245
|
-
* <https://dream-num.github.io/LuckysheetDemo/> <https://github.com/dream-num/Luckysheet> (14,500 :star:)
|
|
246
|
-
* <https://github.com/jspreadsheet/ce> <https://jspreadsheet.com/v8> (6,400 :star:)
|
|
247
|
-
* <https://github.com/myliang/x-spreadsheet> <https://myliang.github.io/x-spreadsheet> (13,500 :star:)
|
|
248
|
-
* <https://github.com/nadbm/react-datasheet> <https://nadbm.github.io/react-datasheet> (5,300 :star:)
|
|
249
|
-
* <https://github.com/adazzle/react-data-grid> (6,200 :star:)
|
|
250
|
-
* <https://iddan.github.io/react-spreadsheet> (1,000 :star:)
|
|
251
|
-
|
|
252
|
-
</details>
|
|
253
|
-
|
|
254
|
-
<details>
|
|
255
|
-
<summary><b>💲 Paid Spreadsheets Components...</b></summary>
|
|
256
|
-
|
|
257
|
-
* <https://demos.devexpress.com/ASPxSpreadSheetDemos/Features/Charts.aspx>
|
|
258
|
-
* <https://www.igniteui.com/spreadsheet/overview> <https://www.infragistics.com/products/ignite-ui-jquery/grids-and-lists/spreadsheet>
|
|
259
|
-
* <https://ej2.syncfusion.com/react/demos/#/bootstrap5/spreadsheet/default>
|
|
260
|
-
* <https://webix.com/demos/spreadsheet>
|
|
261
|
-
|
|
262
|
-
</details>
|
|
263
|
-
|
|
264
|
-
<details>
|
|
265
|
-
<summary><b>💲 Paid Data-grids...</b></summary>
|
|
266
|
-
|
|
267
|
-
A data-grid is a sub-component within a spreadsheet that provides base grid-level rendering but without many of the
|
|
268
|
-
spreadsheet features (user styling, formulas, excel compatibility, etc). Features vary by product but generally
|
|
269
|
-
include sorting, filtering, grouping, and basic cell editing.
|
|
270
|
-
|
|
271
|
-
* <https://handsontable.com/demo> (18,100 :star:)
|
|
272
|
-
* <https://www.ag-grid.com/example> (10,500 :star:)
|
|
273
|
-
* <https://mui.com/x/react-data-grid> (6,100 :star:)
|
|
274
|
-
* <https://www.datagridxl.com/>
|
|
275
|
-
|
|
276
|
-
</details>
|
|
277
|
-
|
|
278
|
-
<details>
|
|
279
|
-
<summary><b>💲 SAAS Spreadsheets...</b></summary>
|
|
280
|
-
|
|
281
|
-
I tried SAAS spreadsheets but these “next-gen spreadsheets” were just mediocre web UIs pretending to be Excel.
|
|
282
|
-
|
|
283
|
-
* <https://www.equals.app>
|
|
284
|
-
* <https://www.rows.com>
|
|
285
|
-
* <https://www.quadratichq.com/>
|
|
286
|
-
* <https://sourcetable.com//>
|
|
287
|
-
|
|
288
|
-
</details>
|
|
289
|
-
|
|
290
|
-
## 🙏 Credits / 🎉 Special Thanks
|
|
291
|
-
|
|
292
|
-
* [Formula.js](https://formulajs.info) (For function references)
|
|
293
|
-
* [Fast Formula Parser](https://github.com/LesterLyu/fast-formula-parser) (For grammar support)
|
|
294
|
-
* [SheetJS](https://sheetjs.com) (For original number format parsing and Excel import/export)
|
|
295
|
-
* [Papa Parse](https://www.papaparse.com) (For CSV parsing)
|
|
296
|
-
|
|
297
|
-
## 🔗 Community & Resources
|
|
298
|
-
|
|
299
|
-
Whether you're ready to build, need help, or just want to see more examples, here's where to go next.
|
|
300
|
-
|
|
301
|
-
* 📘 **[Developer Docs](https://www.sheetxl.com/docs)** - The official guides and tutorials.
|
|
302
|
-
* 🔌 **[API Reference](https://api.sheetxl.com)** - Detailed documentation for all packages.
|
|
303
|
-
* 🌐 **[Live Demo Gallery](https://www.sheetxl.com/demos)** - A showcase of interactive examples.
|
|
304
|
-
* ✨ **[Storybook](https://storybook.sheetxl.com)** - Explore and test individual UI components.
|
|
305
|
-
* 💬 **[Join our Discord Community](https://discord.gg/NTKdwUgK9p)** - Get help and connect with the team.
|
|
306
|
-
* ⭐ **[Star us on GitHub](https://github.com/sheetxl)** - If you find SheetXL useful, we'd appreciate a star!
|
|
307
|
-
* 🌐 **[Website](https://www.sheetxl.com)** - The official website for SheetXL.
|
|
308
|
-
|
|
309
|
-
---
|
|
1
|
+
# SheetXL — The Developer-First Spreadsheet Ecosystem
|
|
2
|
+
|
|
3
|
+

|
|
4
|
+
|
|
5
|
+
[](https://discord.gg/NTKdwUgK9p)
|
|
6
|
+
[](https://www.npmjs.com/package/@sheetxl/studio-mui)
|
|
7
|
+
[](https://www.npmjs.com/package/@sheetxl/studio-mui)
|
|
8
|
+
|
|
9
|
+
### The full spreadsheet stack — for developers
|
|
10
|
+
|
|
11
|
+
**SheetXL is the modern spreadsheet ecosystem** — modular, embeddable, and fully scriptable.
|
|
12
|
+
|
|
13
|
+

|
|
14
|
+
|
|
15
|
+
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.
|
|
16
|
+
|
|
17
|
+
### Try it now — Live Demo
|
|
18
|
+
|
|
19
|
+
👉 [See a full SheetXL demo](https://demo.sheetxl.com)
|
|
20
|
+
|
|
21
|
+
## 🚀 Getting Started
|
|
22
|
+
|
|
23
|
+
Get started in minutes with our production ready application.
|
|
24
|
+
|
|
25
|
+
### 1. Installation
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
# Using npm
|
|
29
|
+
npm install @sheetxl/sdk @sheetxl/studio-mui @mui/material @emotion/react @emotion/styled
|
|
30
|
+
|
|
31
|
+
# Using yarn
|
|
32
|
+
yarn add @sheetxl/sdk @sheetxl/studio-mui @mui/material @emotion/react @emotion/styled
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### 2. Basic Usage
|
|
36
|
+
|
|
37
|
+
```javascript
|
|
38
|
+
import React from 'react';
|
|
39
|
+
import { Workbook } from '@sheetxl/studio-mui';
|
|
40
|
+
|
|
41
|
+
function App() {
|
|
42
|
+
// SheetXL will fill it's parent container.
|
|
43
|
+
return (
|
|
44
|
+
<div style={{ height: '600px', width: '100%' }}>
|
|
45
|
+
<Workbook />
|
|
46
|
+
</div>
|
|
47
|
+
);
|
|
48
|
+
}
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
For more advanced setup options, check out our full
|
|
52
|
+
[Getting Started Guides](https://www.sheetxl.com/docs/category/getting-started).
|
|
53
|
+
|
|
54
|
+
### 📚 Ecosystem Overview
|
|
55
|
+
|
|
56
|
+
The SheetXL ecosystem is modular by design. You can use only what you need — or compose it all together.
|
|
57
|
+
|
|
58
|
+
### SDK
|
|
59
|
+
|
|
60
|
+
At the core of the ecosystem is a **headless, high-performance SDK** [`@sheetxl/sdk`](https://www.npmjs.com/package/@sheetxl/sdk),
|
|
61
|
+
built to power everything from lightweight grid widgets to massive enterprise-scale calculation engines
|
|
62
|
+
|
|
63
|
+
Key features:
|
|
64
|
+
|
|
65
|
+
* **Blazing Speed:** Executes 10M+ operations per second and handles spreadsheets with 17B+ cells.
|
|
66
|
+
* **Powerful API:** A modern, vectorized, range-based API for precise, scriptable control over data — independent of any UI.
|
|
67
|
+
|
|
68
|
+
### Applications and UI Toolkits
|
|
69
|
+
|
|
70
|
+
Build UIs your way — from plug-and-play dashboards to fully custom design systems.
|
|
71
|
+
|
|
72
|
+
* **Rapid Deployment** [`@sheetxl/studio-mui`](https://www.npmjs.com/package/@sheetxl/studio-mui): A complete, open-source spreadsheet UI with Excel-grade features. Ready to ship.
|
|
73
|
+
* **Custom Interface** [`@sheetxl/react`](https://www.npmjs.com/package/@sheetxl/react): A flexible component and hook library for deep customization.
|
|
74
|
+
|
|
75
|
+
### I/O Connectors
|
|
76
|
+
|
|
77
|
+
Easily load and save workbooks in popular formats:
|
|
78
|
+
|
|
79
|
+
* `xlsx` (Excel)
|
|
80
|
+
* `csv`
|
|
81
|
+
* `parquet` (in progress)
|
|
82
|
+
* `json` (native format)
|
|
83
|
+
|
|
84
|
+
`Items marked with 💎 are part of the premium licensing.`
|
|
85
|
+
|
|
86
|
+

|
|
87
|
+
|
|
88
|
+
| Category | Module | Description | License |
|
|
89
|
+
|--------------|-------------------------|-----------------------------|---------|
|
|
90
|
+
| Core | @sheetxl/sdk 💎 | Headless spreadsheet API | Commercial |
|
|
91
|
+
| | @sheetxl/formulas | Collection of 400+ formulas | MIT |
|
|
92
|
+
| | @sheetxl/primitives | Low level types (Scalar, IRange) | MIT |
|
|
93
|
+
| | @sheetxl/scripting 💎 | Scripting engine and compiler | Commercial |
|
|
94
|
+
| IO | @sheetxl/io | Import/export (xlsx, csv, json) | MIT |
|
|
95
|
+
| Applications | @sheetxl/studio-vanilla | Framework-agnostic spreadsheet app | MIT |
|
|
96
|
+
| | @sheetxl/studio-mui | Spreadsheet app powered by React/MUI | MIT |
|
|
97
|
+
| UI Toolkits | @sheetxl/react 💎 | Spreadsheet React UI components and hooks | Commercial |
|
|
98
|
+
| | @sheetxl/grid-react 💎 | Lightweight, standalone React data grid | Commercial |
|
|
99
|
+
| Utils | @sheetxl/utils | Headless utilities (math, ranges, etc) | MIT |
|
|
100
|
+
| | @sheetxl/utils-react | React UI helpers | MIT |
|
|
101
|
+
| | @sheetxl/utils-mui | MUI UI helpers (color picker, dialogs, etc) | MIT |
|
|
102
|
+
|
|
103
|
+
## Key Features
|
|
104
|
+
|
|
105
|
+
SheetXL is built on four core pillars: extreme performance, deep Excel compatibility, unparalleled developer power, and a modern, extensible architecture.
|
|
106
|
+
|
|
107
|
+
* **Performance & Scale**
|
|
108
|
+
|
|
109
|
+
* Process 10M+ ops/second and manage massive 17B+ cell workbooks, all in-browser.
|
|
110
|
+
|
|
111
|
+
* **True Excel Fidelity**
|
|
112
|
+
|
|
113
|
+
* Go beyond basic formulas. Get the Excel-grade features your users demand, from tables and charts to cross-sheet copy/paste.
|
|
114
|
+
|
|
115
|
+
* **Unmatched Developer Power**
|
|
116
|
+
|
|
117
|
+
* With a headless core, a powerful vectorized API, and a built-in scripting engine, you have the ultimate control to build any experience.
|
|
118
|
+
|
|
119
|
+
* **Modern, Open Architecture**
|
|
120
|
+
|
|
121
|
+
* Built with TypeScript and a flexible plugin model, including a fully open-sourced MIT-licensed MUI design system.
|
|
122
|
+
|
|
123
|
+
### ✨ User Features
|
|
124
|
+
|
|
125
|
+
* 17+ billion cells (The same as Excel)
|
|
126
|
+
* 400+ Formulas
|
|
127
|
+
* Scripting Engine
|
|
128
|
+
* Full fidelity Import / Export to Excel
|
|
129
|
+
|
|
130
|
+
<details>
|
|
131
|
+
<summary><b>Click to see the full list of User Features...</b></summary>
|
|
132
|
+
|
|
133
|
+
* Formatted Copy/Paste (Compatible with Microsoft Excel and Google Sheet)
|
|
134
|
+
* Hidden Rows/Columns
|
|
135
|
+
* Frozen Rows/Columns
|
|
136
|
+
* Resizable, Auto-fit Rows/Columns
|
|
137
|
+
* Office Theme (Color Picker, Theme Selector)
|
|
138
|
+
* Cell Styles (Themes and Formatting)
|
|
139
|
+
* Preset Cell Style Selector
|
|
140
|
+
* Overflow, Word-wrap
|
|
141
|
+
* Borders
|
|
142
|
+
* Tables
|
|
143
|
+
* Drawings
|
|
144
|
+
* Multi-range selection
|
|
145
|
+
* Merged Cells
|
|
146
|
+
* Autofill
|
|
147
|
+
* Keyboard Accessible Support for all Excel shortcut keys
|
|
148
|
+
* Undo/Redo
|
|
149
|
+
* Find/Replace
|
|
150
|
+
* Sort
|
|
151
|
+
* Zoom
|
|
152
|
+
* Hyperlinks
|
|
153
|
+
* Mobile Friendly (Touch / Small screen accommodation)
|
|
154
|
+
|
|
155
|
+
</details>
|
|
156
|
+
|
|
157
|
+
### 🛠️ Developer Features
|
|
158
|
+
|
|
159
|
+
* Typescript
|
|
160
|
+
* Easy Integration
|
|
161
|
+
|
|
162
|
+
<details>
|
|
163
|
+
<summary><b>Click to see the full list of Developer Features...</b></summary>
|
|
164
|
+
* Built in scripting & Formula support.
|
|
165
|
+
* Built from the ground up using React and CSS-in-JS components.
|
|
166
|
+
* Fully functional MIT Open-sourced Material-UI Application.
|
|
167
|
+
* Headless spreadsheet API can be used without UI and on server or as library.
|
|
168
|
+
* Easily extend functions with simple registration.
|
|
169
|
+
|
|
170
|
+
</details>
|
|
171
|
+
|
|
172
|
+
## Roadmap
|
|
173
|
+
|
|
174
|
+
* Table Filtering (in progress)
|
|
175
|
+
|
|
176
|
+
<details>
|
|
177
|
+
<summary><b>🧭 Click to see the full Roadmap...</b></summary>
|
|
178
|
+
|
|
179
|
+
### 2025 Roadmap
|
|
180
|
+
|
|
181
|
+
* Conditional formatting
|
|
182
|
+
* Full Styling in Excel Export
|
|
183
|
+
* Full Charting (nearly complete)
|
|
184
|
+
* Multi-key shortcuts
|
|
185
|
+
* Pivot
|
|
186
|
+
* Sparklines
|
|
187
|
+
* Slicer/Timeline
|
|
188
|
+
* Accessibility <https://www.w3.org/TR/WCAG21/>
|
|
189
|
+
* Printing
|
|
190
|
+
|
|
191
|
+
### 2026 Roadmap
|
|
192
|
+
|
|
193
|
+
* Google Sheets Interop
|
|
194
|
+
* Collaboration
|
|
195
|
+
|
|
196
|
+
</details>
|
|
197
|
+
|
|
198
|
+
## 🤔 Why SheetXL?
|
|
199
|
+
|
|
200
|
+
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.
|
|
201
|
+
|
|
202
|
+
### Why not just a spreadsheet app?
|
|
203
|
+
|
|
204
|
+
Importing and Exporting data from a spreadsheet is a broken part of nearly every business workflow. Instead of
|
|
205
|
+
importing/exporting data, just import the spreadsheet.
|
|
206
|
+
|
|
207
|
+
* Reduce errors on data due to import/export copying of data.
|
|
208
|
+
* Real time integration/validation of your data.
|
|
209
|
+
* Complete control of data as your data never leaves your systems.
|
|
210
|
+
* Improved user productivity.
|
|
211
|
+
* Combine custom user enhancements with flexible data manipulation.
|
|
212
|
+
|
|
213
|
+
### Why not just a spreadsheet component?
|
|
214
|
+
|
|
215
|
+
As a Microsoft Excel user and a React developer I have always wanted a solution that combines the
|
|
216
|
+
flexibility and ease of use of Excel with the control and specific capabilities of my custom application.
|
|
217
|
+
|
|
218
|
+
I wanted my custom applications to have spreadsheet features!
|
|
219
|
+
|
|
220
|
+
Several great spreadsheet components exists but none of them have:
|
|
221
|
+
|
|
222
|
+
* Excel compatibility and features.
|
|
223
|
+
* Simple integration.
|
|
224
|
+
* Billions of cells.
|
|
225
|
+
* Comprehensive support for keyboard shortcuts (e.g. tabbing within multi-selected ranges, arrow-keys within cells).
|
|
226
|
+
* Enable advanced copy / paste between Excel/Excel Online/Google Sheets.
|
|
227
|
+
* Easily extendable libraries that use open-source and modern design patterns.
|
|
228
|
+
* Real-time integration to data providing a single source of truth; no copying data between systems using complex APIs.
|
|
229
|
+
|
|
230
|
+
### Why Now?
|
|
231
|
+
|
|
232
|
+
* TypeScript became the new “default scripting language.”
|
|
233
|
+
* Post-VBA fatigue is real.
|
|
234
|
+
* Excel is powerful but closed.
|
|
235
|
+
* Data grids are customizable but are limited.
|
|
236
|
+
* SaaS is full of spreadsheet imposters.
|
|
237
|
+
|
|
238
|
+
## The Competitive Landscape
|
|
239
|
+
|
|
240
|
+
We encourage you to explore the landscape. We're confident you'll see why we built SheetXL.
|
|
241
|
+
|
|
242
|
+
<details>
|
|
243
|
+
<summary><b>👐 Open-source Spreadsheets Components...</b></summary>
|
|
244
|
+
|
|
245
|
+
* <https://dream-num.github.io/LuckysheetDemo/> <https://github.com/dream-num/Luckysheet> (14,500 :star:)
|
|
246
|
+
* <https://github.com/jspreadsheet/ce> <https://jspreadsheet.com/v8> (6,400 :star:)
|
|
247
|
+
* <https://github.com/myliang/x-spreadsheet> <https://myliang.github.io/x-spreadsheet> (13,500 :star:)
|
|
248
|
+
* <https://github.com/nadbm/react-datasheet> <https://nadbm.github.io/react-datasheet> (5,300 :star:)
|
|
249
|
+
* <https://github.com/adazzle/react-data-grid> (6,200 :star:)
|
|
250
|
+
* <https://iddan.github.io/react-spreadsheet> (1,000 :star:)
|
|
251
|
+
|
|
252
|
+
</details>
|
|
253
|
+
|
|
254
|
+
<details>
|
|
255
|
+
<summary><b>💲 Paid Spreadsheets Components...</b></summary>
|
|
256
|
+
|
|
257
|
+
* <https://demos.devexpress.com/ASPxSpreadSheetDemos/Features/Charts.aspx>
|
|
258
|
+
* <https://www.igniteui.com/spreadsheet/overview> <https://www.infragistics.com/products/ignite-ui-jquery/grids-and-lists/spreadsheet>
|
|
259
|
+
* <https://ej2.syncfusion.com/react/demos/#/bootstrap5/spreadsheet/default>
|
|
260
|
+
* <https://webix.com/demos/spreadsheet>
|
|
261
|
+
|
|
262
|
+
</details>
|
|
263
|
+
|
|
264
|
+
<details>
|
|
265
|
+
<summary><b>💲 Paid Data-grids...</b></summary>
|
|
266
|
+
|
|
267
|
+
A data-grid is a sub-component within a spreadsheet that provides base grid-level rendering but without many of the
|
|
268
|
+
spreadsheet features (user styling, formulas, excel compatibility, etc). Features vary by product but generally
|
|
269
|
+
include sorting, filtering, grouping, and basic cell editing.
|
|
270
|
+
|
|
271
|
+
* <https://handsontable.com/demo> (18,100 :star:)
|
|
272
|
+
* <https://www.ag-grid.com/example> (10,500 :star:)
|
|
273
|
+
* <https://mui.com/x/react-data-grid> (6,100 :star:)
|
|
274
|
+
* <https://www.datagridxl.com/>
|
|
275
|
+
|
|
276
|
+
</details>
|
|
277
|
+
|
|
278
|
+
<details>
|
|
279
|
+
<summary><b>💲 SAAS Spreadsheets...</b></summary>
|
|
280
|
+
|
|
281
|
+
I tried SAAS spreadsheets but these “next-gen spreadsheets” were just mediocre web UIs pretending to be Excel.
|
|
282
|
+
|
|
283
|
+
* <https://www.equals.app>
|
|
284
|
+
* <https://www.rows.com>
|
|
285
|
+
* <https://www.quadratichq.com/>
|
|
286
|
+
* <https://sourcetable.com//>
|
|
287
|
+
|
|
288
|
+
</details>
|
|
289
|
+
|
|
290
|
+
## 🙏 Credits / 🎉 Special Thanks
|
|
291
|
+
|
|
292
|
+
* [Formula.js](https://formulajs.info) (For function references)
|
|
293
|
+
* [Fast Formula Parser](https://github.com/LesterLyu/fast-formula-parser) (For grammar support)
|
|
294
|
+
* [SheetJS](https://sheetjs.com) (For original number format parsing and Excel import/export)
|
|
295
|
+
* [Papa Parse](https://www.papaparse.com) (For CSV parsing)
|
|
296
|
+
|
|
297
|
+
## 🔗 Community & Resources
|
|
298
|
+
|
|
299
|
+
Whether you're ready to build, need help, or just want to see more examples, here's where to go next.
|
|
300
|
+
|
|
301
|
+
* 📘 **[Developer Docs](https://www.sheetxl.com/docs)** - The official guides and tutorials.
|
|
302
|
+
* 🔌 **[API Reference](https://api.sheetxl.com)** - Detailed documentation for all packages.
|
|
303
|
+
* 🌐 **[Live Demo Gallery](https://www.sheetxl.com/demos)** - A showcase of interactive examples.
|
|
304
|
+
* ✨ **[Storybook](https://storybook.sheetxl.com)** - Explore and test individual UI components.
|
|
305
|
+
* 💬 **[Join our Discord Community](https://discord.gg/NTKdwUgK9p)** - Get help and connect with the team.
|
|
306
|
+
* ⭐ **[Star us on GitHub](https://github.com/sheetxl)** - If you find SheetXL useful, we'd appreciate a star!
|
|
307
|
+
* 🌐 **[Website](https://www.sheetxl.com)** - The official website for SheetXL.
|
|
308
|
+
|
|
309
|
+
---
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";/**
|
|
2
|
-
* @license @sheetxl/scripting - Scripting - Scripting engine for Macros and formulas; includes TypeScript and EsBuild. - v0.
|
|
2
|
+
* @license @sheetxl/scripting - Scripting - Scripting engine for Macros and formulas; includes TypeScript and EsBuild. - v0.3.1
|
|
3
3
|
*
|
|
4
4
|
* (C) 2025-present SheetXL Inc. & Michael T. Ford
|
|
5
5
|
* License: The license can be found at https://www.sheetxl.com/license.
|
|
6
|
-
*/Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});exports.TypeScriptCompiler=class{constructor(r={}){this.workerWrapper=null}async getWorkerWrapper(){if(this.workerWrapper)return this.workerWrapper;const{createCompilerWorker:r}=await Promise.resolve().then(()=>require("./
|
|
6
|
+
*/Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});exports.TypeScriptCompiler=class{constructor(r={}){this.workerWrapper=null}async getWorkerWrapper(){if(this.workerWrapper)return this.workerWrapper;const{createCompilerWorker:r}=await Promise.resolve().then(()=>require("./BpsMQL8WKA-7RfCC.cjs"));return this.workerWrapper=await r(),this.workerWrapper}async compileModule(r){try{return(await this.getWorkerWrapper()).execute(r)}catch(e){throw console.error("Failed to compile using worker:",e),e}}terminate(){this.workerWrapper?.terminate(),this.workerWrapper=null}};
|