[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 @@
+## Tag
+
+### Install
+``` javascript
+import { Tag } from 'vant';
+
+Vue.use(Tag);
+```
+
+### Usage
+
+#### Basic Usage
+
+```html
+<van-tag>Tag</van-tag>
+<van-tag type="danger">Tag</van-tag>
+<van-tag type="success">Tag</van-tag>
+<van-tag type="primary">Tag</van-tag>
+```
+
+#### Plain style
+
+```html
+<van-tag plain>Tag</van-tag>
+<van-tag plain type="danger">Tag</van-tag>
+<van-tag plain type="primary">Tag</van-tag>
+<van-tag plain type="success">Tag</van-tag>
+```
+
+#### Mark style
+
+```html
+<van-tag mark>Tag</van-tag>
+<van-tag mark type="danger">Tag</van-tag>
+<van-tag mark type="primary">Tag</van-tag>
+<van-tag mark type="success">Tag</van-tag>
+```
+
+### API
+
+| Attribute | Description | Type | Default |
+|-----------|-----------|-----------|-------------|
+| type | Type, can be set to `primary` `success` `danger` | `String` | `''`|
+| plain | Whether to be plain style | `Boolean` | `false` |
+| mark | Wtether to be mark style | `Boolean` | `false` |
+
+### Slot
+
+| name | Description |
+|-----------|-----------|
+| - | Default slot |
@@ -0,0 +1,54 @@
+## Tag 标记
+
+### 使用指南
+``` javascript
+import { Tag } from 'vant';
+
+Vue.use(Tag);
+```
+
+### 代码演示
+
+#### 基础用法
+通过 type 属性控制 Tag 颜色，默认为灰色
+
+```html
+<van-tag>标签</van-tag>
+<van-tag type="danger">标签</van-tag>
+<van-tag type="success">标签</van-tag>
+<van-tag type="primary">标签</van-tag>
+```
+
+#### 空心样式
+设置`plain`属性设置为空心样式
+
+```html
+<van-tag plain>标签</van-tag>
+<van-tag plain type="danger">标签</van-tag>
+<van-tag plain type="primary">标签</van-tag>
+<van-tag plain type="success">标签</van-tag>
+```
+
+#### 圆角样式
+通过`mark`设置为圆角样式
+
+```html
+<van-tag mark>标签</van-tag>
+<van-tag mark type="danger">标签</van-tag>
+<van-tag mark type="primary">标签</van-tag>
+<van-tag mark type="success">标签</van-tag>
+```
+
+### API
+
+| 参数 | 说明 | 类型 | 默认值 |
+|-----------|-----------|-----------|-------------|
+| type | 类型，可选值为`primary` `success` `danger` | `String` | `''`|
+| plain | 是否为空心样式 | `Boolean` | `false` |
+| mark | 是否为圆角样式 | `Boolean` | `false` |
+
+### Slot
+
+| 名称 | 说明 |
+|-----------|-----------|
+| default | 自定义 Tag 显示内容 |