Updated readme
This commit is contained in:
parent
3edf35415b
commit
9e25b2869c
30
README.md
30
README.md
|
|
@ -1,28 +1,19 @@
|
||||||
|
|
||||||
# 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
|
||||||
```js
|
|
||||||
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
|
||||||
|
|
||||||
const target = document.getElementById('spreadsheet')
|
const target = document.getElementById('spreadsheet')
|
||||||
|
|
||||||
const sheet = new Spreadsheet(target)
|
const sheet = new Spreadsheet(target)
|
||||||
//...
|
//...
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Save and load data
|
## Save and load data
|
||||||
```js
|
```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))
|
||||||
|
|
@ -35,4 +26,15 @@ function loadData() {
|
||||||
sheet.loadData(json)
|
sheet.loadData(json)
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
</div>
|
|
||||||
|
## 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 (?)
|
||||||
|
-
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
{
|
{
|
||||||
"name": "modern_spreadsheet",
|
"name": "modern_spreadsheet",
|
||||||
"private": false,
|
"private": false,
|
||||||
"version": "0.0.23",
|
"version": "0.0.25",
|
||||||
"exports": {
|
"exports": {
|
||||||
".": {
|
".": {
|
||||||
"import": "./dist/main.js",
|
"import": "./dist/main.js",
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue