feat: layout component

2020-07-05 16:00:20 +08:00
parent 4a25ebf9ab
commit e671e22ea5
12 changed files with 677 additions and 31 deletions
@@ -0,0 +1,119 @@
+# Layout
+
+### Intro
+
+Quickly and easily create layouts with `van-row` and `van-col`
+
+### Install
+
+```js
+import Vue from 'vue';
+import { Col, Row } from 'vant';
+
+Vue.use(Col);
+Vue.use(Row);
+```
+
+## 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>
+```
+
+### Flex Layout
+
+Setting `type` to `flex` to enable flex layout
+
+```html
+<van-row type="flex">
+  <van-col span="6">span: 6</van-col>
+  <van-col span="6">span: 6</van-col>
+  <van-col span="6">span: 6</van-col>
+</van-row>
+
+<van-row type="flex" justify="center">
+  <van-col span="6">span: 6</van-col>
+  <van-col span="6">span: 6</van-col>
+  <van-col span="6">span: 6</van-col>
+</van-row>
+
+<van-row type="flex" justify="end">
+  <van-col span="6">span: 6</van-col>
+  <van-col span="6">span: 6</van-col>
+  <van-col span="6">span: 6</van-col>
+</van-row>
+
+<van-row type="flex" justify="space-between">
+  <van-col span="6">span: 6</van-col>
+  <van-col span="6">span: 6</van-col>
+  <van-col span="6">span: 6</van-col>
+</van-row>
+
+<van-row type="flex" justify="space-around">
+  <van-col span="6">span: 6</van-col>
+  <van-col span="6">span: 6</van-col>
+  <van-col span="6">span: 6</van-col>
+</van-row>
+```
+
+## API
+
+### Row Props
+
+| Attribute | Description | Type | Default |
+| --- | --- | --- | --- |
+| type | Layout type, can be set to `flex` | _string_ | - |
+| gutter | Grid spacing（px） | _number \| string_ | - |
+| tag | Custom element tag | _string_ | `div` |
+| justify | Flex main axis，can be set to end/center/space-around/space-between | _string_ | `start` |
+| align | Flex cross axis, be set to center/bottom | _string_ | `top` |
+
+### Col Props
+
+| Attribute | Description | Type | Default |
+| --- | --- | --- | --- |
+| span | number of column the grid spans | _number \| string_ | - |
+| offset | number of spacing on the left side of the grid | _number \| string_ | - |
+| tag | Custom element tag | _string_ | `div` |
+
+### Row Events
+
+| Event | Description              | Arguments      |
+| ----- | ------------------------ | -------------- |
+| click | Triggered when click row | _event: Event_ |
+
+### Col Events
+
+| Event | Description              | Arguments      |
+| ----- | ------------------------ | -------------- |
+| click | Triggered when click col | _event: Event_ |