`、`| `、` | `，可为标签定制属性，包括 `class`、`style` 及其他。
**参数解释**
- `data` 和 `schema`：同 `generateTable`.
- `options`：选项对象，除了支持 `generateTable` 的选项之外，还支持下列选项：
- `attributes`： 声明标签用到的属性，具体用法看示例。
**示例**
```javascript
// 添加标签属性
generateHTMLTable(data, schema, {
attributes: {
table: { class: 'c-table' },
thead: { class: 'c-table-header' },
tbody: { class: 'c-table-body' },
tr: { class: 'c-table-row' },
'thead.tr': { style: 'background: light-blue' },
'tbody.tr': { style: 'background: cyan' },
th: { class: 'c-header-cell' },
td: { class: 'c-data-cell' }
}
})
```
### `generateExcel`
**备注**
需同时安装依赖包 `xlsx`.
**定义**
```javascript
generateExcel(data, schema, options)
```
**作用**
生成 Excel 表格。
**参数解释**
- `data` 和 `schema`：同 `generateTable`.
- `options`：选项对象，除了支持 `generateTable` 的选项之外，还支持下列选项：
- `writeTo`： 一个文件路径。
**示例**
```javascript
// 写入到文件路径
generateExcel(data, schema, { writeTo: '/tmp/example.xlsx' })
// 写入到标准输出
generateExcel(data, schema, { writeTo: '/dev/stdout' })
```
### `parseDataToSchema`
**定义**
```javascript
parseDataToSchema(data, mode)
```
**作用**
通过数据推导出 Schema，支持两种推导方式。
**参数解释**
- `data`：数据
- `mode`：推导方式，支持两种推导方式 `"stack"` 和 `"flatten"`. 其详细区别可参考**数据推导表格**部分。
## 使用技巧
#### 显示标量数组
虽然很少见， 但如果我们遇到下面的数组数据：
```javascript
const data = ['A', 'B', 'C']
```
默认情况下显示在一个格子里：
我们希望对他分行显示，这时可通过定制空白的 `path` 满足目的：
```javascript
const schema = { title: 'Data', path: '' }
```
显示效果将是：
#### 将长文本数组分行显示
数组在单元格中显示文本使用的是 `array.toString()` 方法，`[1, 2, 3]` 的显示效果是 `1,2,3`. 如果遇到长文本数组，例如：
```javascript
const data = {
short: 1,
long: [
"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB",
"CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC"
]
}
```
默认的显示方式将不够好。这时可通过定制 Schema 来实现数组的分行显示：
```javascript
const schema = [
{ path: 'short' },
{ path: 'long', props: [
{ title: '', path: '' }
]}
]
```
显示效果将如下：
| short |
long |
| 1 |
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA |
| BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB |
| CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC |
**解释**
这里用到 `title` 和 `path` 的特殊用法。空字符串的 `title` 不占用表头的格子，空字符串的 `path` 提取完整数据。由于数据是数组，所以改为提取数组内的完整数据。
#### 使用 `parseDataToSchema` 了解 Schema 的用法
有些同学刚开始可能不知道 Schema 的用法，这时可通过 `parseDataToSchema` 推导出 Schema 并在控制台打印出来，打印出来的结果可调整以满足自己的需要。
```javascript
import { generateHTMLTable, parseDataToSchema } from '@yetrun/json-to-table'
const data = [
// ...
]
// 查看 Schema
console.log(parseDataToSchema(data))
// 从控制台复制 Schema，并根据自己的需要调整
const schema = [
// ...
]
// 显式应用 Schema 并生成表格
generateHTMLTable(data, schema)
```
## 贡献
可提交 PR 以改进本项目，亦可克隆源码进行二次开发。这里列出开发时常用到的命令：
```bash
# 运行单元测试
$ yarn test
# 构建和打包
$ yarn build
```
## License |