[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,51 @@
+## Badge
+
+### Install
+``` javascript
+import { Badge, BadgeGroup } from 'vant';
+
+Vue.use(Badge);
+Vue.use(BadgeGroup);
+```
+
+### Usage
+
+#### Basic Usage
+Use `active-key` prop to set index of chosen 'badge'
+
+```html
+<van-badge-group :active-key="activeKey">
+  <van-badge title="Title" @click="onClick" />
+  <van-badge title="Title" @click="onClick" info="8" />
+  <van-badge title="Title" @click="onClick" info="99" />
+  <van-badge title="Title" @click="onClick" info="199" />
+</van-badge-group>
+```
+
+``` javascript
+export default {
+  data() {
+    return {
+      activeKey: 0
+    };
+  },
+  methods: {
+    onClick(key) {
+      this.activeKey = key;
+    }
+  }
+};
+```
+
+### BadgeGroup API
+
+| Attribute | Description | Type | Default |
+|-----------|-----------|-----------|-------------|
+| active-key | Index of chosen badge | `String | Number` | `0` |
+
+### Badge API
+| Attribute | Description | Type | Default |
+|-----------|-----------|-----------|-------------|
+| title | Content | `String` | `''` |
+| info | Info Message | `String | Number` | `''` |
+| url | Link | `String` | - |
@@ -0,0 +1,52 @@
+## Badge 徽章
+
+### 使用指南
+``` javascript
+import { Badge, BadgeGroup } from 'vant';
+
+Vue.use(Badge);
+Vue.use(BadgeGroup);
+```
+
+### 代码演示
+
+#### 基础用法
+
+通过在`van-badge-group`上设置`active-key`属性来控制选中的`badge`
+
+```html
+<van-badge-group :active-key="activeKey">
+  <van-badge title="标签名称" @click="onClick" />
+  <van-badge title="标签名称" @click="onClick" info="8" />
+  <van-badge title="标签名称" @click="onClick" info="99" />
+  <van-badge title="标签名称" @click="onClick" info="199" />
+</van-badge-group>
+```
+
+``` javascript
+export default {
+  data() {
+    return {
+      activeKey: 0
+    };
+  },
+  methods: {
+    onClick(key) {
+      this.activeKey = key;
+    }
+  }
+};
+```
+
+### BadgeGroup API
+
+| 参数 | 说明 | 类型 | 默认值 |
+|-----------|-----------|-----------|-------------|
+| active-key | 选中`badge`的索引 | `String | Number` | `0` |
+
+### Badge API
+| 参数 | 说明 | 类型 | 默认值 |
+|-----------|-----------|-----------|-------------|
+| title | 内容 | `String` | `''` |
+| info | 提示消息 | `String | Number` | `''` |
+| url | 跳转链接 | `String` | - |