elink-star
/
luckysheet
12
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

docs(readme): readme 

cdn
master
lrz 5 years ago
parent
592c1638c7
commit
bf83138656
6 changed files with 65 additions and 33 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 18
      README-zh.md
  2. 19
      README.md
  3. 24
      docs/guide/README.md
  4. 25
      docs/zh/guide/README.md
  5. 11
      docs/zh/guide/cell.md
  6. 1
      src/global/api.js

18
README-zh.md
View File

@ -124,23 +124,21 @@ npm run build
## 用法 ## 用法
#### 第一步 #### 第一步
`npm run build`后`dist`文件夹下的所有文件复制到项目目录 通过CDN引入依赖
#### 第二步
引入依赖
``` ```
<link rel='stylesheet' href='./plugins/css/pluginsCss.css' /> <link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet/dist/plugins/css/pluginsCss.css' />
<link rel='stylesheet' href='./plugins/plugins.css' /> <link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet/dist/plugins/plugins.css' />
<link rel='stylesheet' href='./css/luckysheet.css' /> <link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet/dist/css/luckysheet.css' />
<script src="./plugins/js/plugin.js"></script> <script src="https://cdn.jsdelivr.net/npm/luckysheet/dist/plugins/js/plugin.js"></script>
<script src="./luckysheet.umd.js"></script> <script src="https://cdn.jsdelivr.net/npm/luckysheet/dist/luckysheet.umd.js"></script>
``` ```
#### 第三步 #### 第二步
指定一个表格容器 指定一个表格容器
``` ```
<div id="luckysheet" style="margin:0px;padding:0px;position:absolute;width:100%;height:100%;left: 0px;top: 0px;"></div> <div id="luckysheet" style="margin:0px;padding:0px;position:absolute;width:100%;height:100%;left: 0px;top: 0px;"></div>
``` ```
#### 第四步 #### 第三步
创建一个表格 创建一个表格
``` ```
<script> <script>

19
README.md
View File

@ -130,23 +130,20 @@ npm run build
## Usage ## Usage
#### First step #### First step
Copy all files in the `dist` folder after `npm run build` to the project directory Introduce dependencies through CDN
#### Second step
Introduce dependencies
``` ```
<link rel='stylesheet' href='./plugins/css/pluginsCss.css' /> <link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet/dist/plugins/css/pluginsCss.css' />
<link rel='stylesheet' href='./plugins/plugins.css' /> <link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet/dist/plugins/plugins.css' />
<link rel='stylesheet' href='./css/luckysheet.css' /> <link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet/dist/css/luckysheet.css' />
<script src="./plugins/js/plugin.js"></script> <script src="https://cdn.jsdelivr.net/npm/luckysheet/dist/plugins/js/plugin.js"></script>
<script src="./luckysheet.umd.js"></script> <script src="https://cdn.jsdelivr.net/npm/luckysheet/dist/luckysheet.umd.js"></script>
``` ```
#### Third step #### Second step
Specify a table container Specify a table container
``` ```
<div id="luckysheet" style="margin:0px;padding:0px;position:absolute;width:100%;height:100%;left: 0px;top: 0px;"></div> <div id="luckysheet" style="margin:0px;padding:0px;position:absolute;width:100%;height:100%;left: 0px;top: 0px;"></div>
``` ```
#### Fourth step #### Third step
Create a table Create a table
``` ```
<script> <script>

24
docs/guide/README.md
View File

@ -113,10 +113,24 @@ npm run build
## Steps for usage ## Steps for usage
### First step ### First step
After `npm run build`, all files in the `dist` folder are copied to the project directory
### Second step There are two ways to introduce dependencies
Introduce dependencies
#### CDN
```html
<link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet/dist/plugins/css/pluginsCss.css' />
<link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet/dist/plugins/plugins.css' />
<link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet/dist/css/luckysheet.css' />
<script src="https://cdn.jsdelivr.net/npm/luckysheet/dist/plugins/js/plugin.js"></script>
<script src="https://cdn.jsdelivr.net/npm/luckysheet/dist/luckysheet.umd.js"></script>
```
Note that `https://cdn.jsdelivr.net/npm/luckysheet/dist/luckysheet.umd.js` will pull the latest luckysheet code. If you want to specify the luckysheet version, please add the version number after the luckysheet , Such as: `https://cdn.jsdelivr.net/npm/luckysheet@2.0.0/dist/luckysheet.umd.js`
If it is not convenient to access jsdelivr.net, you can also import it locally
#### Import locally
After `npm run build`, all files in the `dist` folder are copied to the project directory
```html ```html
<link rel='stylesheet' href='./plugins/css/pluginsCss.css' /> <link rel='stylesheet' href='./plugins/css/pluginsCss.css' />
<link rel='stylesheet' href='./plugins/plugins.css' /> <link rel='stylesheet' href='./plugins/plugins.css' />
@ -124,12 +138,12 @@ Introduce dependencies
<script src="./plugins/js/plugin.js"></script> <script src="./plugins/js/plugin.js"></script>
<script src="./luckysheet.umd.js"></script> <script src="./luckysheet.umd.js"></script>
``` ```
### Third step ### Second step
Specify a table container Specify a table container
```html ```html
<div id="luckysheet" style="margin:0px;padding:0px;position:absolute;width:100%;height:100%;left: 0px;top: 0px;"></div> <div id="luckysheet" style="margin:0px;padding:0px;position:absolute;width:100%;height:100%;left: 0px;top: 0px;"></div>
``` ```
### Fourth step ### Third step
Create a table Create a table
```javascript ```javascript
<script> <script>

25
docs/zh/guide/README.md
View File

@ -113,10 +113,25 @@ npm run build
## 使用步骤 ## 使用步骤
### 第一步 ### 第一步
`npm run build`后`dist`文件夹下的所有文件复制到项目目录 引入依赖，有2种方式
#### CDN
```html
<link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet/dist/plugins/css/pluginsCss.css' />
<link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet/dist/plugins/plugins.css' />
<link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet/dist/css/luckysheet.css' />
<script src="https://cdn.jsdelivr.net/npm/luckysheet/dist/plugins/js/plugin.js"></script>
<script src="https://cdn.jsdelivr.net/npm/luckysheet/dist/luckysheet.umd.js"></script>
```
注意，`https://cdn.jsdelivr.net/npm/luckysheet/dist/luckysheet.umd.js`这个路径会拉取到最新的luckysheet代码，想要指定luckysheet版本，请在luckysheet后面加上版本号，如：`https://cdn.jsdelivr.net/npm/luckysheet@2.0.0/dist/luckysheet.umd.js`
如果不方便访问 jsdelivr.net，还可以采用本地方式引入
#### 本地引入
`npm run build`后`dist`文件夹下的所有文件复制到项目目录，然后通过相对路径引入
### 第二步
引入依赖
```html ```html
<link rel='stylesheet' href='./plugins/css/pluginsCss.css' /> <link rel='stylesheet' href='./plugins/css/pluginsCss.css' />
<link rel='stylesheet' href='./plugins/plugins.css' /> <link rel='stylesheet' href='./plugins/plugins.css' />
@ -124,12 +139,12 @@ npm run build
<script src="./plugins/js/plugin.js"></script> <script src="./plugins/js/plugin.js"></script>
<script src="./luckysheet.umd.js"></script> <script src="./luckysheet.umd.js"></script>
``` ```
### 第三步 ### 第二步
指定一个表格容器 指定一个表格容器
```html ```html
<div id="luckysheet" style="margin:0px;padding:0px;position:absolute;width:100%;height:100%;left: 0px;top: 0px;"></div> <div id="luckysheet" style="margin:0px;padding:0px;position:absolute;width:100%;height:100%;left: 0px;top: 0px;"></div>
``` ```
### 第四步 ### 第三步
创建一个表格 创建一个表格
```javascript ```javascript
<script> <script>

11
docs/zh/guide/cell.md
View File

@ -97,8 +97,15 @@
<tr> <tr>
<td>tr</td> <td>tr</td>
<td>textrotate</td> <td>textrotate</td>
<td>文字旋转</td> <td>竖排文字</td>
<td>0： 0、1： 45 、2：-45、3 竖排文字、4： 90 、5：-90</td> <td>3</td>
<td>setRotationAngle</td>
</tr>
<tr>
<td>rt</td>
<td>rotatetext</td>
<td>文字旋转角度</td>
<td>介于0~180之间的整数，包含0和180</td>
<td>setRotationAngle</td> <td>setRotationAngle</td>
</tr> </tr>
<tr> <tr>

1
src/global/api.js
View File

@ -77,6 +77,7 @@ export function getCellValue(row, column, options = {}) {
* @param {Object | String | Number} value 要设置的值；可以为字符串或数字，或为符合Luckysheet单元格格式的对象 * @param {Object | String | Number} value 要设置的值；可以为字符串或数字，或为符合Luckysheet单元格格式的对象
* @param {Object} options 可选参数 * @param {Object} options 可选参数
* @param {Number} options.order 工作表索引；默认值为当前工作表索引 * @param {Number} options.order 工作表索引；默认值为当前工作表索引
* @param {Boolean} options.isRefresh 是否刷新界面；默认为`true`
* @param {Function} options.success 操作结束的回调函数 * @param {Function} options.success 操作结束的回调函数
*/ */
// export function setCellValue(row, column, value, options = {}) { // export function setCellValue(row, column, value, options = {}) {

Write Preview
Loading…
Cancel
Save