# x-spreadsheet

**Repository Path**: strongandyzhang/x-spreadsheet

## Basic Information

- **Project Name**: x-spreadsheet
- **Description**: a javascript spreadsheet for web
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-02-20
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# x-spreadsheet
[![npm package](https://img.shields.io/npm/v/x-data-spreadsheet.svg)](https://www.npmjs.org/package/x-data-spreadsheet)
[![NPM downloads](http://img.shields.io/npm/dm/x-data-spreadsheet.svg)](https://npmjs.org/package/x-data-spreadsheet)

> a javascript(canvas) spreadsheet for web

<p align="center">
  <a href="https://github.com/myliang/x-spreadsheet">
    <img width="100%" src="https://raw.githubusercontent.com/myliang/x-spreadsheet/master/docs/demo.png">
  </a>
</p>

## Install
``` shell
npm install x-data-spreadsheet
``` 

## Quick Start
``` html
<div id="x-spreadsheet-demo"></div>
```

``` javascript
import Spreadsheet from 'x-data-spreadsheet';
// If you need to override the default options, you can set the override
// const options = {};
// new Spreadsheet('#x-spreadsheet-demo', options);
new Spreadsheet('#x-spreadsheet-demo')
  .loadData({}) // load data
  .change((data) => {
    // save data to db
  });
```

```javascript
// default options
{
  view: {
    height: () => document.documentElement.clientHeight - 41,
    width: () => document.documentElement.clientWidth,
  },
  formats: [],
  fonts: [],
  formula: [],
  row: {
    len: 100,
    height: 25,
  },
  col: {
    len: 26,
    width: 100,
    indexWidth: 60,
    minWidth: 60,
  },
  style: {
    bgcolor: '#ffffff',
    align: 'left',
    valign: 'middle',
    textwrap: false,
    textDecoration: 'normal',
    strikethrough: false,
    color: '#0a0a0a',
    font: {
      name: 'Helvetica',
      size: 10,
      bold: false,
      italic: false,
    },
  },
}
```

## Development
``` sheel
git clone https://github.com/myliang/x-spreadsheet.git
cd x-spreadsheet
npm install
npm run dev
```
Open your browser and visit http://127.0.0.1:8080.

## Browser Support
Modern browsers(chrome, firefox, Safari).

## LICENSE
MIT