no message

Former-commit-id: 28ec2beb0befdc6a796458fbcc1a0c3786fb8d62
Former-commit-id: 82768e538a271a2354616cd01f84fd73631a62b2
Former-commit-id: 450e74928f5d6bdba20e01ce57bebdfde0d512a1

static/md/插件 - 导出.md

@@ -0,0 +1,146 @@
+# Vue.$export
+
+本框架集成了数据导出功能，并包装成插件
+
+## 注册插件
+
+> 默认已经注册，可以直接使用
+
+```
+import pluginExport from '@/plugin/export'
+Vue.use(pluginExport)
+```
+
+之后就可以在组件中使用 `this.$export` 来调用导出功能
+
+## Vue.$export.csv()
+
+此方法将数据以 `CSV` 格式导出，并且返回一个 `Promise` 对象
+
+使用
+
+```
+this.$export.csv({
+  columns,
+  data
+})
+  .then(() => {
+    // ...可选回调
+  })
+```
+
+参数
+
+| 参数名 | 介绍 | 必选 | 值类型 | 可选值 | 默认值 |
+| --- | --- | --- | --- | --- | --- |
+| columns | 列 | 非 | Array |  | 空数组 |
+| data | 行数据 | 非 | Array |  | 空数组 |
+| table | 文件名 | 非 | String |  | table |
+| noHeader | 不导出表头 | 非 | Boolean |  | false |
+| separator | 数据分隔符 | 非 | String |  | , |
+| quoted | 每项数据是否加引号 | 非 | Boolean |  | false |
+
+示例
+
+```
+const columns = [
+  {
+    label: '姓名',
+    prop: 'name'
+  },
+  {
+    label: '年龄',
+    prop: 'age'
+  }
+]
+const data = [
+  {
+    name: 'lucy',
+    age: 24
+  },
+  {
+    name: 'bob',
+    age: 26
+  }
+]
+this.$export.csv({
+  columns,
+  data
+})
+```
+
+## Vue.$export.excel()
+
+此方法将数据以 `xlsx` 格式导出，并且返回一个 `Promise` 对象
+
+使用
+
+```
+this.$export.excel({
+  columns,
+  data
+})
+  .then(() => {
+    // ...可选回调
+  })
+```
+
+参数
+
+| 参数名 | 介绍 | 必选 | 值类型 | 可选值 | 默认值 |
+| --- | --- | --- | --- | --- | --- |
+| columns | 列 | 非 | Array |  | 空数组 |
+| data | 行数据 | 非 | Array |  | 空数组 |
+| table | 文件名 | 非 | String |  | table |
+
+示例
+
+```
+const columns = [
+  {
+    label: '姓名',
+    prop: 'name'
+  },
+  {
+    label: '年龄',
+    prop: 'age'
+  }
+]
+const data = [
+  {
+    name: 'lucy',
+    age: 24
+  },
+  {
+    name: 'bob',
+    age: 26
+  }
+]
+this.$export.excel({
+  columns,
+  data
+})
+```
+
+## Vue.$export.txt()
+
+此方法将数据以 `txt` 格式导出，并且返回一个 `Promise` 对象
+
+使用
+
+```
+this.$export.txt({
+  text: '文本内容',
+  title: '文件名'
+})
+  .then(() => {
+    // ...可选回调
+  })
+```
+
+参数
+
+| 参数名 | 介绍 | 必选 | 值类型 | 可选值 | 默认值 |
+| --- | --- | --- | --- | --- | --- |
+| text | 文件内容 | 非 | String |  | 空 |
+| title | 文件名 | 非 | String |  | 文本 |