[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,79 @@
+## CellSwipe
+
+### Install
+``` javascript
+import { CellSwipe } from 'vant';
+
+Vue.use(CellSwipe);
+```
+
+### Usage
+
+#### Basic Usage
+
+```html
+<van-cell-swipe :right-width="65" :left-width="65">
+  <span slot="left">Select</span>
+  <van-cell-group>
+    <van-cell title="Cell" value="Cell Content" />
+  </van-cell-group>
+  <span slot="right">Delete</span>
+</van-cell-swipe>
+```
+
+#### Async close
+
+```html
+<van-cell-swipe :right-width="65" :left-width="65" :on-close="onClose">
+  <span slot="left">Select</span>
+  <van-cell-group>
+    <van-cell title="Cell" value="Cell Content" />
+  </van-cell-group>
+  <span slot="right">Delete</span>
+</van-cell-swipe>
+```
+
+```js
+export default {
+  methods: {
+    onClose(clickPosition, instance) {
+      switch (clickPosition) {
+        case 'left':
+        case 'cell':
+        case 'outside':
+          instance.close();
+          break;
+        case 'right':
+          Dialog.confirm({
+            message: 'Are you sure to delete?'
+          }).then(() => {
+            instance.close();
+          });
+          break;
+      }
+    }
+  }
+}
+```
+
+### API
+
+| Attribute | Description | Type | Default |
+|-----------|-----------|-----------|-------------|
+| left-width | Width of the left scrollable area | `Number` | `0` |
+| right-width | Width of the right scrollable area | `Number` | `0` |
+| on-close | Callback function before close | `Function` | - |
+
+### Slot
+
+| name | Description |
+|-----------|-----------|
+| - | custom content |
+| left | content of left scrollable area |
+| right | content of right scrollabe area |
+
+### onClose Params
+| Argument | Type | Description |
+|-----------|-----------|-----------|
+| clickPosition | `String` | Click positon (`left` `right` `cell` `outside`) |
+| instance | `Object` | CellSwipe instance with a close method |
@@ -0,0 +1,79 @@
+## CellSwipe 滑动单元格
+
+### 使用指南
+``` javascript
+import { CellSwipe } from 'vant';
+
+Vue.use(CellSwipe);
+```
+
+### 代码演示
+
+#### 基础用法
+
+```html
+<van-cell-swipe :right-width="65" :left-width="65">
+  <span slot="left">选择</span>
+  <van-cell-group>
+    <van-cell title="单元格" value="内容" />
+  </van-cell-group>
+  <span slot="right">删除</span>
+</van-cell-swipe>
+```
+
+#### 异步关闭
+
+```html
+<van-cell-swipe :right-width="65" :left-width="65" :on-close="onClose">
+  <span slot="left">选择</span>
+  <van-cell-group>
+    <van-cell title="单元格" value="内容" />
+  </van-cell-group>
+  <span slot="right">删除</span>
+</van-cell-swipe>
+```
+
+```js
+export default {
+  methods: {
+    onClose(clickPosition, instance) {
+      switch (clickPosition) {
+        case 'left':
+        case 'cell':
+        case 'outside':
+          instance.close();
+          break;
+        case 'right':
+          Dialog.confirm({
+            message: '确定删除吗？'
+          }).then(() => {
+            instance.close();
+          });
+          break;
+      }
+    }
+  }
+}
+```
+
+### API
+
+| 参数 | 说明 | 类型 | 默认值 |
+|-----------|-----------|-----------|-------------|
+| left-width | 左侧滑动区域宽度 | `Number` | `0` |
+| right-width | 右侧滑动区域宽度 | `Number` | `0` |
+| on-close | 关闭时的回调函数 | `Function` | - |
+
+### Slot
+
+| 名称 | 说明 |
+|-----------|-----------|
+| - | 自定义显示内容 |
+| left | 左侧滑动内容 |
+| right | 右侧滑动内容 |
+
+### onClose 参数
+| 参数 | 类型 | 说明 |
+|-----------|-----------|-----------|
+| clickPosition | `String` | 关闭时的点击位置 (`left` `right` `cell` `outside`) |
+| instance | `Object` | CellSwipe 实例，挂载有 close 方法 |