Readme update

This commit is contained in:
Eugene 2023-07-25 17:29:27 +03:00
parent 55e4eb0f70
commit c34d913619
1 changed files with 8 additions and 13 deletions

View File

@ -1,10 +1,8 @@
# Modern Spreadsheet # Modern Spreadsheet
- High performance spreadsheet based on CanvasAPI. - High performance spreadsheet based on CanvasAPI.
- TypeScript supported - TypeScript supported
## Basic usage ## Basic usage
```ts ```ts
import Spreadsheet from "modern_spreadsheet"; import Spreadsheet from "modern_spreadsheet";
import "modern_spreadsheet/style.css"; // <= this is required import "modern_spreadsheet/style.css"; // <= this is required
@ -15,30 +13,27 @@ const sheet = new Spreadsheet(target);
``` ```
## Save and load data ## Save and load data
```ts ```ts
function saveData() { function saveData() {
const serialized = sheet.serializeData(); const serialized = sheet.serializeData();
localStorage.setItem("sheet_data", JSON.stringify(serialized)); localStorage.setItem("sheet_data", JSON.stringify(serialized));
} }
function loadData() { function loadData() {
const data = localStorage.getItem("sheet_data"); const data = localStorage.getItem("sheet_data");
const json = JSON.parse(data); const json = JSON.parse(data);
if (!json) return; if (!json) return;
sheet.loadData(json); sheet.loadData(json);
} }
``` ```
## Roadmap ## Roadmap
- ~~Rows number and columns heading render~~
- Custom event functions (ex.: onSelectionChange, onCellEdit...). Full list of supported events will available on this page - Custom event functions (ex.: onSelectionChange, onCellEdit...). Full list of supported events will available on this page
- Rows number and columns heading render
- Rows and columns resizing - Rows and columns resizing
- Toolbar - Toolbar
- Context menu - Context menu
- Formulas support - Formulas support
- Selected cell depends cells highlight - Selected cell depends cells highlight
- Async formulas support - Async formulas support
- Mutlisheets (?) - Mutlisheets (?)
-