[Improvement] Reorganize document (#1066)

2018-05-15 10:39:01 +08:00
parent b1142fd862
commit e8aad7246c
124 changed files with 181 additions and 186 deletions
@@ -0,0 +1,68 @@
+## Uploader
+
+### Install
+``` javascript
+import { Uploader } from 'vant';
+
+Vue.use(Uploader);
+```
+
+### Usage
+
+#### Basic Usage
+
+```html
+<div class="uploader-container">
+  <van-uploader :after-read="onRead">
+    <van-icon name="photograph" />
+  </van-uploader>
+</div>
+```
+
+```javascript
+export default {
+  methods: {
+    onRead(file) {
+      console.log(file)
+    }
+  }
+};
+```
+
+#### Set input attr
+You can set native properties such as `accpet`、`multiple` on Uploader, and the input will automatically inherits the attribute.
+
+```html
+<van-uploader :after-read="onRead" accept="image/gif, image/jpeg" multiple>
+  <van-icon name="photograph" />
+</van-uploader>
+```
+
+### API
+
+| Attribute | Description | Type | Default |
+|-----------|-----------|-----------|-------------|
+| result-type | Type of file read result, can be set to `dataUrl` `text` | `String` | `dataUrl` |
+| accept | Accepted file type | `String` | `image/*` |
+| disabled | Whether to disabled the upload | `Boolean` | `false` |
+| before-read | Hook before reading the file, return false to stop reading the file | `Function` | - |
+| after-read | Hook after reading the file | `Function` | - |
+| max-size | Max size of file | `Number` | - |
+
+### Event
+
+| Event | Description | Arguments |
+|-----------|-----------|-----------|
+| oversize | Triggered when file size over limit | Same as after-read |
+
+### Slot
+
+| Name | Description |
+|-----------|-----------|
+| - | Custom icon |
+
+### afterRead parematers
+| Key | Description | Type |
+|-----------|-----------|-----------|
+| file | file object | `Object` |
+| content | file content | `String` |
@@ -0,0 +1,66 @@
+## Uploader 图片上传
+
+### 使用指南
+``` javascript
+import { Uploader } from 'vant';
+
+Vue.use(Uploader);
+```
+
+### 代码演示
+
+#### 基础用法
+
+```html
+<van-uploader :after-read="onRead">
+  <van-icon name="photograph" />
+</van-uploader>
+```
+
+```javascript
+export default {
+  methods: {
+    onRead(file) {
+      console.log(file)
+    }
+  }
+};
+```
+
+#### 设置 Input 属性
+可以直接在 Uploader 上设置 accpet、multiple 等原生属性，input 会自动继承该属性
+
+```html
+<van-uploader :after-read="onRead" accept="image/gif, image/jpeg" multiple>
+  <van-icon name="photograph" />
+</van-uploader>
+```
+
+### API
+
+| 参数 | 说明 | 类型 | 默认值 |
+|-----------|-----------|-----------|-------------|
+| result-type | 文件读取结果类型，可选值为 `dataUrl` `test` | `String` | `dataUrl` |
+| accept | 接受的文件类型 | `String` | `image/*` |
+| disabled | 是否禁用图片上传 | `Boolean` | `false` |
+| before-read | 读取前的回调函数，返回 false 可终止文件读取 | `Function` | - |
+| after-read | 读取完成后的回调函数 | `Function` | - |
+| max-size | 文件大小限制，单位为 byte | `Number` | - |
+
+### Event
+
+| 事件名 | 说明 | 参数 |
+|-----------|-----------|-----------|
+| oversize | 文件大小超过限制时触发 | 同 after-read |
+
+### Slot
+
+| 名称 | 说明 |
+|-----------|-----------|
+| - | 自定义 uploader 内容 |
+
+### afterRead 回调参数
+| key | 说明 | 类型 |
+|-----------|-----------|-----------|
+| file | 文件解析后的 file 对象 | `Object` |
+| content | 文件内容 | `String` |