intrasheets 3.2.0 → 6.0.1

package/README.md

@@ -0,0 +1,73 @@
+# Intrasheets
+
+The Excel experience on top of [Jspreadsheet](https://jspreadsheet.com), as a library: ribbon,
+formula bar, sheet tabs, backstage, charts, pivot tables, comments, XLSX import and export, an
+AI assistant and realtime collaboration through Jspreadsheet Server.
+
+A Jspreadsheet license is required: https://jspreadsheet.com
+
+## Install
+
+```bash
+npm install intrasheets
+```
+
+```js
+import intrasheets from 'intrasheets';
+import 'intrasheets/dist/style.css';
+```
+
+Or with a script tag (self-contained build, global `intrasheets`):
+
+```html
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/intrasheets/dist/style.css" />
+<script src="https://cdn.jsdelivr.net/npm/intrasheets/dist/index.min.js"></script>
+```
+
+## Usage
+
+```js
+intrasheets({
+    license: '...',                                        // Jspreadsheet license (required)
+    client: { url: 'https://sheets.example.com', token },  // Jspreadsheet Server and the user's token
+    google: { clientId, apiKey },                          // Google Sheets import (optional)
+    onopen: function(guid) { ... },                        // a document was created or picked; default: navigate to /{guid}
+});
+
+// One server document
+intrasheets.load(el, {
+    guid: guid,
+    width: 1000,
+    height: 600,
+    onchange: function(worksheet, cell, x, y, value) { ... },
+}).then(function(worksheets) { ... });
+
+// The user's document list
+intrasheets.list(el, { height: '100vh' });
+```
+
+- `client.api` is the REST base when the server sits behind a path that differs from the socket
+  address, for example `{ url: 'https://host', path: 's/', api: 'https://host/s' }`.
+- `width` and `height` size the container: a number is pixels, a string any CSS length. Without
+  them the container keeps the size the page gives it.
+- Every `on<event>` option of `load` is a Jspreadsheet event handler, called after the shell's own
+  handler with the same arguments.
+- `load` rejects when the document does not exist or the token cannot open it.
+- The Material Symbols icon font is loaded from Google Fonts when the page does not bring it.
+- Menus and dialogs float over the page; the backstage (File) stays inside the container.
+
+## Files
+
+| File                | Use                                                                    |
+|---------------------|------------------------------------------------------------------------|
+| `dist/index.js`     | Self-contained UMD build for a `<script>` tag (jsDelivr serves it minified as `index.min.js`) |
+| `dist/index.mjs`    | ES module for bundlers (`@jspreadsheet/bundle`, `lemonadejs`, `@lemonadejs/studio` and `markdown-it` are dependencies) |
+| `dist/style.css`    | Everything the shell needs                                             |
+
+## Server
+
+Documents live on [Jspreadsheet Server](https://jspreadsheet.com/docs/server), which handles
+persistence, authentication and realtime collaboration.
+
+A complete example with React, the server and MongoDB in Docker:
+https://github.com/intrasheets/demo