From 9e25b2869cce924b42ea7dee659efca1b32e502c Mon Sep 17 00:00:00 2001 From: Eugene Date: Tue, 25 Jul 2023 15:38:47 +0300 Subject: [PATCH] Updated readme --- README.md | 46 ++++++++++++++++++++++++---------------------- package.json | 2 +- 2 files changed, 25 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 81305b6..20c1a61 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,40 @@ - # Modern Spreadsheet +- High performance spreadsheet based on CanvasAPI. +- TypeScript supported - - -- High performance spreadsheet based on CanvasAPI. - -- TypeScript supported - - Basic usage - -```js +## Basic usage +```ts import Spreadsheet from 'modern_spreadsheet' - -import 'modern_spreadsheet/style.css' // <= this is required +import 'modern_spreadsheet/style.css' // <= this is required const target = document.getElementById('spreadsheet') - const sheet = new Spreadsheet(target) //... - ``` -Save and load data -```js -function saveData() { - const serialized = sheet.serializeData() +## Save and load data +```ts +function saveData() { + const serialized = sheet.serializeData() localStorage.setItem('sheet_data', JSON.stringify(serialized)) } -function loadData() { - const data = localStorage.getItem('sheet_data') - const json = JSON.parse(data) +function loadData() { + const data = localStorage.getItem('sheet_data') + const json = JSON.parse(data) if(!json) return; sheet.loadData(json) } ``` - + +## Roadmap +- 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 +- Toolbar +- Context menu +- Formulas support +- Selected cell depends cells highlight +- Async formulas support +- Mutlisheets (?) +- diff --git a/package.json b/package.json index 3e13f06..e40c8a3 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "modern_spreadsheet", "private": false, - "version": "0.0.23", + "version": "0.0.25", "exports": { ".": { "import": "./dist/main.js",