[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,78 @@
+## GoodsAction
+
+### Install
+``` javascript
+import {
+  GoodsAction,
+  GoodsActionBigBtn,
+  GoodsActionMiniBtn
+} from 'vant';
+
+Vue
+  .use(GoodsAction)
+  .use(GoodsActionBigBtn)
+  .use(GoodsActionMiniBtn);
+```
+
+### Usage
+#### Basic Usage
+
+```html
+<van-goods-action>
+  <van-goods-action-mini-btn icon="chat" text="Icon1" @click="onClickMiniBtn" />
+  <van-goods-action-mini-btn icon="cart" text="Icon2" @click="onClickMiniBtn" />
+  <van-goods-action-big-btn text="Button1" @click="onClickBigBtn" />
+  <van-goods-action-big-btn text="Button2" @click="onClickBigBtn" primary />
+</van-goods-action>
+```
+
+```javascript
+export default {
+  methods: {
+    onClickMiniBtn() {
+      Toast('Click Icon');
+    },
+    onClickBigBtn() {
+      Toast('Click Button');
+    }
+  }
+}
+```
+
+#### Icon info
+Use `info` prop to show messages in upper right corner of icon
+
+```html
+<van-goods-action>
+  <van-goods-action-mini-btn icon="chat" text="Icon1" />
+  <van-goods-action-mini-btn icon="cart" text="Icon2" info="5" />
+  <van-goods-action-mini-btn icon="shop" text="Icon3" />
+  <van-goods-action-big-btn text="Button1" />
+  <van-goods-action-big-btn text="Button2" primary />
+</van-goods-action>
+```
+
+### API
+
+#### GoodsActionMiniBtn
+
+| Attribute | Description | Type | Default |
+|-----------|-----------|-----------|-------------|
+| text | Button text | `String` | - |
+| icon | Icon | `String` | - |
+| icon-class | Icon class name | `String` | `''` |
+| info | Info message | `String | Number` | - |
+| url | Link | `String` | - |
+| to | Target route of the link, same as to of `vue-router` | `String | Object` | - |
+| replace | If true, the navigation will not leave a history record | `String` | `false` |
+
+
+#### GoodsActionBigBtn
+
+| Attribute | Description | Type | Default |
+|-----------|-----------|-----------|-------------|
+| text | Button text | `String` | - |
+| primary | Is primary button (red color) | `Boolean` | `false` |
+| url | Link | `String` | - |
+| to | Target route of the link, same as to of `vue-router` | `String | Object` | - |
+| replace | If true, the navigation will not leave a history record | `String` | `false` |