[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,96 @@
+## Swipe
+
+### Install
+``` javascript
+import { Swipe, SwipeItem } from 'vant';
+
+Vue.use(Swipe).use(SwipeItem);
+```
+
+### Usage
+
+#### Basic Usage
+Use `autoplay` prop to set autoplay interval
+
+```html
+<van-swipe :autoplay="3000">
+  <van-swipe-item>1</van-swipe-item>
+  <van-swipe-item>2</van-swipe-item>
+  <van-swipe-item>3</van-swipe-item>
+  <van-swipe-item>4</van-swipe-item>
+</van-swipe>
+```
+
+#### Image Lazyload
+Use [Lazyload](#/en-US/lazyload) component to lazyload image
+
+```html
+<van-swipe>
+  <van-swipe-item v-for="(image, index) in images" :key="index">
+    <img v-lazy="image" />
+  </van-swipe-item>
+</van-swipe>
+```
+
+```javascript
+export default {
+  data() {
+    return {
+      images: [
+        'https://img.yzcdn.cn/1.jpg',
+        'https://img.yzcdn.cn/2.jpg'
+      ]
+    }
+  }
+}
+```
+
+#### change event
+
+```html
+<van-swipe @change="onChange">
+  <van-swipe-item>1</van-swipe-item>
+  <van-swipe-item>2</van-swipe-item>
+  <van-swipe-item>3</van-swipe-item>
+  <van-swipe-item>4</van-swipe-item>
+</van-swipe>
+```
+
+```js
+export default {
+  methods: {
+    onChange(index) {
+      Toast('Current Swipe index:' + index);
+    }
+  }
+}
+```
+
+#### Vertical Scrolling
+
+```html
+<van-swipe :autoplay="3000" vertical>
+  <van-swipe-item>1</van-swipe-item>
+  <van-swipe-item>2</van-swipe-item>
+  <van-swipe-item>3</van-swipe-item>
+  <van-swipe-item>4</van-swipe-item>
+</van-swipe>
+```
+
+### API
+
+| Attribute | Description | Type | Default |
+|-----------|-----------|-----------|-------------|
+| autoplay | Autoplay interval (ms) | `Number` | - |
+| duration | Animation duration (ms) | `Number` | `500` |
+| loop | Whether to enable loop | `Boolean` | `true` |
+| vertical | Vertical Scrolling | `Boolean` | `false` |
+| touchable | Whether touchable | `Boolean` | `true` |
+| show-indicators | Whether to show indocators | `Boolean` | `true` |
+| initial-swipe | Index of initial swipe, start from 0 | `Number` | `0` |
+
+### Event
+
+| Event | Description | Arguments |
+|-----------|-----------|-----------|
+| change | Triggered when current swipe change | index: index of current swipe |
@@ -0,0 +1,96 @@
+## Swipe 轮播
+
+### 使用指南
+``` javascript
+import { Swipe, SwipeItem } from 'vant';
+
+Vue.use(Swipe).use(SwipeItem);
+```
+
+### 代码演示
+
+#### 基础用法
+通过`autoplay`属性设置自动轮播间隔
+
+```html
+<van-swipe :autoplay="3000">
+  <van-swipe-item>1</van-swipe-item>
+  <van-swipe-item>2</van-swipe-item>
+  <van-swipe-item>3</van-swipe-item>
+  <van-swipe-item>4</van-swipe-item>
+</van-swipe>
+```
+
+#### 图片懒加载
+配合 [Lazyload](#/zh-CN/lazyload) 组件实现图片懒加载
+
+```html
+<van-swipe :autoplay="3000">
+  <van-swipe-item v-for="(image, index) in images" :key="index">
+    <img v-lazy="image" />
+  </van-swipe-item>
+</van-swipe>
+```
+
+```javascript
+export default {
+  data() {
+    return {
+      images: [
+        'https://img.yzcdn.cn/1.jpg',
+        'https://img.yzcdn.cn/2.jpg'
+      ]
+    }
+  }
+}
+```
+
+#### 监听 change 事件
+
+```html
+<van-swipe @change="onChange">
+  <van-swipe-item>1</van-swipe-item>
+  <van-swipe-item>2</van-swipe-item>
+  <van-swipe-item>3</van-swipe-item>
+  <van-swipe-item>4</van-swipe-item>
+</van-swipe>
+```
+
+```js
+export default {
+  methods: {
+    onChange(index) {
+      Toast('当前 Swipe 索引：' + index);
+    }
+  }
+}
+```
+
+#### 纵向滚动
+
+```html
+<van-swipe :autoplay="3000" vertical>
+  <van-swipe-item>1</van-swipe-item>
+  <van-swipe-item>2</van-swipe-item>
+  <van-swipe-item>3</van-swipe-item>
+  <van-swipe-item>4</van-swipe-item>
+</van-swipe>
+```
+
+### API
+
+| 参数 | 说明 | 类型 | 默认值 |
+|-----------|-----------|-----------|-------------|
+| autoplay | 自动轮播间隔，单位为 ms | `Number` | - |
+| duration | 动画时长，单位为 ms | `Number` | `500` |
+| loop | 是否开启循环播放 | `Boolean` | `true` |
+| vertical | 是否为纵向滚动 | `Boolean` | `false` |
+| touchable | 是否可以通过手势滑动 | `Boolean` | `true` |
+| show-indicators | 是否显示指示器 | `Boolean` | `true` |
+| initial-swipe | 初始位置，从 0 开始算 | `Number` | `0` |
+
+### 事件
+
+| 事件名 | 说明 | 参数 |
+|-----------|-----------|-----------|
+| change | 每一页轮播结束后触发 | index, 当前页的索引 |