refactor(all project): modular,Document promotion,Some bugs

1. Modularization, use es6, split files 2. Add English documents,enriched parameter description 3. add allowEdit 4. Delete row, insert row,hidden row 5. some bugs BREAKING CHANGE: File name change fix #11, fix #2
dream-num · Jul 24, 2020 · 37c3070 · 37c3070
1 parent 1e5bffd
commit 37c3070
Show file tree

Hide file tree

Showing 208 changed files with 409,271 additions and 99,587 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present, Mengshukeji
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README-zh.md b/README-zh.md
@@ -0,0 +1,111 @@
+# Luckysheet
+简体中文 | [English](./README.md)
+
+## 介绍
+Luckysheet ，一款纯前端类似excel的在线表格，功能强大、配置简单、完全开源。
+
+## 特性
+1. Luckysheet支持表格设置包括冻结行列、合并单元格、筛选、排序、查询、条件格式、批注
+2. 支持数据分析功能包括透视表、图表、分列、矩阵操作、内置385个计算函数
+3. 支持一键截图、复制为json数据、共享编辑、excel与Luckysheet之间数据的复制粘贴
+4. 支持移动端查看
+5. 支持sparkLine
+6. 下拉复制
+7. 快捷键
+
+![演示](https://minio.cnbabylon.com/public/luckysheet/LuckysheetDemo.gif)
+
+## 计划
+- 完善图表插件
+- 插入图片
+- 数据验证（复选框、下拉列表）
+- 打印
+- 单元格分段样式
+- 树形菜单
+- 表格功能：筛选,切片
+- excel导入/导出
+- 更多...
+
+## 文档
+[在线demo](https://mengshukeji.github.io/LuckysheetDemo/)
+
+[在线文档](https://mengshukeji.github.io/LuckysheetDocs/)
+
+## 环境
+[Node.js](https://nodejs.org/en/) Version >= 6 
+
+## 安装
+```
+npm install
+npm install gulp -g
+```
+
+## 开发
+开发
+```
+npm run dev
+```
+打包
+```
+npm run build
+```
+阅读
+
+Luckysheet的核心代码为luckysheet-core.js和luckysheet-function.js,开发者看源码只需要看这两个文件即可,接下来会讨论进行模块化方案,完善这个插件.
+
+## 用法
+
+#### 第一步
+`npm run build`后`dist`文件夹下的所有文件复制到项目目录
+
+#### 第二步
+引入依赖
+```
+<link rel='stylesheet' href='./plugins/css/pluginsCss.css' />
+<link rel='stylesheet' href='./plugins/plugins.css' />
+<link rel='stylesheet' href='./css/luckysheet.css' />
+<script src="./plugins/js/plugin.js"></script>
+<script src="./luckysheet.umd.js"></script>
+```
+#### 第三步
+指定一个表格容器
+```
+<div id="luckysheet" style="margin:0px;padding:0px;position:absolute;width:100%;height:100%;left: 0px;top: 0px;"></div>
+```
+#### 第四步
+创建一个表格
+```
+<script>
+    $(function () {
+        //配置项
+        var options = {
+            container: 'luckysheet' //luckysheet为容器id
+        }
+        luckysheet.create(options)
+    })
+</script>
+```
+
+## 联系
+mengshu@office2.cn
+
+## 交流
+
+- 添加小编微信,拉你进Luckysheet开发者交流微信群,备注:加群
+
+  <img src="https://minio.cnbabylon.com/public/luckysheet/%E5%BE%AE%E4%BF%A1%E4%BA%8C%E7%BB%B4%E7%A0%81.jpg" width = "200" alt="微信群" align="center" />
+
+或者
+
+- 加入Luckysheet开发者交流QQ群
+
+  <img src="https://minio.cnbabylon.com/public/luckysheet/QQ%E7%BE%A4%E4%BA%8C%E7%BB%B4%E7%A0%81.jpg" width = "200" alt="微信群" align="center" />
+
+## 贡献者和感谢
+- [@wpxp123456](https://github.com/wpxp123456)
+- [@Dushusir](https://github.com/Dushusir)
+
+## 版权信息
+[MIT](http://opensource.org/licenses/MIT)
+
+Copyright (c) 2020-present, mengshukeji
diff --git a/README.md b/README.md
@@ -1,103 +1,106 @@
 # Luckysheet
+[![Join the chat at https://gitter.im/mengshukeji/Luckysheet](https://badges.gitter.im/mengshukeji/Luckysheet.svg)](https://gitter.im/mengshukeji/Luckysheet?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-## Introduction - 介绍
-Luckysheet ，一款纯前端类似excel的在线表格，功能强大、配置简单、完全开源。
+English| [简体中文](./README-zh.md)
 
-## Features - 特性
-1. Luckysheet支持表格设置包括冻结行列、合并单元格、筛选、排序、查询、条件格式、批注
-2. 支持数据分析功能包括透视表、图表、分列、矩阵操作、内置385个计算函数
-3. 支持一键截图、复制为json数据、共享编辑、excel与Luckysheet之间数据的复制粘贴
-4. 支持移动端查看
-5. 支持sparkLine
-![演示](https://minio.cnbabylon.com/public/luckysheet/LuckysheetDemo.gif)
+## Introduction
+Luckysheet is an online spreadsheet like excel that is powerful, simple to configure, and completely open source.
 
-## Plan - 计划
-- 模块化(进行中)
-- excel导入/导出
-- 表单
-- 插入图片
-- 更多...
 
-## Documentation - 文档
-[在线demo](https://mengshukeji.github.io/LuckysheetDemo/)
+## Features
+1. Support table settings including freezing columns, merging cells, filtering, sorting, querying, conditional formatting, and annotations
+2. Support data analysis functions including pivottables, charts, columns, matrix operations, built-in 385 calculation functions
+3. Support one-click screenshots, data copying as json,shared editing, and free data copying and pasting between excel and luckysheet
+4. Support mobile viewing
+5. Support sparkLine
+6. Drop down copy
+7. Keyboard shortcuts
 
-[在线文档](https://mengshukeji.github.io/LuckysheetDocs/)
+![Demo](https://minio.cnbabylon.com/public/luckysheet/LuckysheetDemo.gif)
 
-## Requirements - 环境
+## Plan
+- Improve chart plugin
+- Insert picture
+- Data validation (checkbox, drop-down list)
+- Print
+- Cell segmentation style
+- Tree menu
+- Table function: filter, slice
+- Excel import/export
+- More...
+
+## Documentation
+[Online demo](https://mengshukeji.github.io/LuckysheetDemo/)
+
+[Online documentation](https://mengshukeji.github.io/LuckysheetDocs/en/)
+
+## Requirements
 [Node.js](https://nodejs.org/en/) Version >= 6 
 
-## Installation - 安装
+## Installation
 ```
 npm install
 npm install gulp -g
 ```
 
-## Development - 开发
-开发
+## Development
+Development
 ```
 npm run dev
 ```
-打包
+Package
 ```
 npm run build
 ```
-阅读
+Read
 
-Luckysheet的核心代码为luckysheet-core.js和luckysheet-function.js,开发者看源码只需要看这两个文件即可,接下来会讨论进行模块化方案,完善这个插件.
+The core code of Luckysheet is luckysheet-core.js and luckysheet-function.js, developers only need to look at these two files to see the source code, and then we will discuss the modularization scheme and improve this library.
 
-## Usage - 用法
+## Usage
 
-#### 第一步
-npm run build后dist文件夹下的所有文件复制到项目目录
+#### First step
+`npm run build`后`dist`文件夹下的所有文件复制到项目目录
 
-#### 第二步
-引入依赖
+#### Second step
+Introduce dependencies
 ```
-<link rel="stylesheet" href="plugins/css/pluginsCss.min.css">
-<link rel="stylesheet" href="plugins/plugins.min.css">
-<link rel="stylesheet" href="css/main.min.css">
-<script src="plugins/js/plugin.min.js"></script>
-<script src="main.min.js"></script>
+<link rel='stylesheet' href='./plugins/css/pluginsCss.css' />
+<link rel='stylesheet' href='./plugins/plugins.css' />
+<link rel='stylesheet' href='./css/luckysheet.css' />
+<script src="./plugins/js/plugin.js"></script>
+<script src="./luckysheet.umd.js"></script>
 ```
-#### 第三步
-指定一个表格容器
+#### Third step
+Specify a table container
 ```
 <div id="luckysheet" style="margin:0px;padding:0px;position:absolute;width:100%;height:100%;left: 0px;top: 0px;"></div>
 ```
-#### 第四步
-创建一个表格
+#### Fourth step
+Create a table
 ```
 <script>
     $(function () {
-        //配置项
+        //Configuration item
         var options = {
-            container: 'luckysheet' //luckysheet为容器id
+            container: 'luckysheet' //luckysheet is the container id
         }
         luckysheet.create(options)
     })
 </script>
 ```
 
-## Contact - 联系
+## Contact
 mengshu@office2.cn
 
-## communication - 交流
-
-- 添加小编微信,拉你进Luckysheet开发者交流微信群,备注:加群
-
-  <img src="https://minio.cnbabylon.com/public/luckysheet/%E5%BE%AE%E4%BF%A1%E4%BA%8C%E7%BB%B4%E7%A0%81.jpg" width = "200" alt="微信群" align="center" />
-
-或者
+## communication
 
-- 加入Luckysheet开发者交流QQ群
-
-  <img src="https://minio.cnbabylon.com/public/luckysheet/QQ%E7%BE%A4%E4%BA%8C%E7%BB%B4%E7%A0%81.jpg" width = "200" alt="微信群" align="center" />
+- [Gitter](https://gitter.im/mengshukeji/Luckysheet)
 
-## Authors and acknowledgment - 贡献者和感谢
-- Bug Pan ([@wpxp123456](https://github.com/wpxp123456))
-- Dushusir ([@Dushusir](https://github.com/Dushusir))
+## Authors and acknowledgment
+- [@wpxp123456](https://github.com/wpxp123456)
+- [@Dushusir](https://github.com/Dushusir)
 
-## License - 版权信息
+## License
 [MIT](http://opensource.org/licenses/MIT)
 
 Copyright (c) 2020-present, mengshukeji
diff --git a/commitlint.config.js b/commitlint.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+    extends: ['@commitlint/config-conventional']
+}
diff --git a/deploy_demo.bat b/deploy_demo.bat