[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,65 @@
+## Layout
+
+Quickly and easily create layouts with `van-row` and `van-col`
+
+### Install
+``` javascript
+import { Row, Col } from 'vant';
+
+Vue.use(Row).use(Col);
+```
+
+### Usage
+
+#### Basic Usage
+
+Layout are based on 24-column. The attribute `span` in `Col` means the number of column the grid spans. Of course, You can use `offset` attribute to set number of spacing on the left side of the grid.
+
+
+```html
+<van-row>
+  <van-col span="8">span: 8</van-col>
+  <van-col span="8">span: 8</van-col>
+  <van-col span="8">span: 8</van-col>
+</van-row>
+
+<van-row>
+  <van-col span="4">span: 4</van-col>
+  <van-col span="10" offset="4">offset: 4, span: 10</van-col>
+  <van-col span="6">span: 6</van-col>
+</van-row>
+
+<van-row>
+  <van-col offset="12" span="12">offset: 12, span: 12</van-col>
+</van-row>
+```
+
+
+#### Column Spacing
+
+Set grid spacing using `gutter` attribute. The default value is 0
+
+
+```html
+<van-row gutter="20">
+  <van-col span="8">span: 8</van-col>
+  <van-col span="8">span: 8</van-col>
+  <van-col span="8">span: 8</van-col>
+</van-row>
+```
+
+
+### API
+
+#### Row
+
+| Attribute | Description | Type | Default |
+|-----------|-----------|-----------|-------------|
+| gutter | grid spacing（px） | `String | Number` | - |
+
+#### Column
+
+| Attribute | Description | Type | Default |
+|-----------|-----------|-----------|-------------|
+| span | number of column the grid spans | `String | Number` | - |
+| offset | number of spacing on the left side of the grid | `String | Number` | - |
@@ -0,0 +1,61 @@
+## Layout 布局
+
+提供了`van-row`和`van-col`两个组件来进行行列布局
+
+### 使用指南
+``` javascript
+import { Row, Col } from 'vant';
+
+Vue.use(Row).use(Col);
+```
+
+### 代码演示
+
+#### 基本用法
+
+Layout 组件提供了`24列栅格`，通过在`Col`上添加`span`属性设置列所占的宽度百分比    
+此外，添加`offset`属性可以设置列的偏移宽度，计算方式与 span 相同
+
+```html
+<van-row>
+  <van-col span="8">span: 8</van-col>
+  <van-col span="8">span: 8</van-col>
+  <van-col span="8">span: 8</van-col>
+</van-row>
+
+<van-row>
+  <van-col span="4">span: 4</van-col>
+  <van-col span="10" offset="4">offset: 4, span: 10</van-col>
+</van-row>
+
+<van-row>
+  <van-col offset="12" span="12">offset: 12, span: 12</van-col>
+</van-row>
+```
+
+#### 设置列元素间距
+
+通过`gutter`属性可以设置列元素之间的间距，默认间距为 0
+
+```html
+<van-row gutter="20">
+  <van-col span="8">span: 8</van-col>
+  <van-col span="8">span: 8</van-col>
+  <van-col span="8">span: 8</van-col>
+</van-row>
+```
+
+### API
+
+#### Row
+
+| 参数 | 说明 | 类型 | 默认值 |
+|-----------|-----------|-----------|-------------|
+| gutter | 列元素之间的间距（单位为px） | `String | Number` | - |
+
+#### Column
+
+| 参数 | 说明 | 类型 | 默认值 |
+|-----------|-----------|-----------|-------------|
+| span | 列元素宽度 | `String | Number` | - |
+| offset | 列元素偏移距离 | `String | Number` | - |