[Improvement] Reorganize document (#1066)

This commit is contained in:
neverland
2018-05-15 10:39:01 +08:00
committed by GitHub
parent b1142fd862
commit e8aad7246c
124 changed files with 181 additions and 186 deletions
+69
View File
@@ -0,0 +1,69 @@
## Pagination
### Install
``` javascript
import { Pagination } from 'vant';
Vue.use(Pagination);
```
### Usage
#### Basic Usage
```html
<van-pagination
v-model="currentPage"
:total-items="24"
:items-per-page="5"
/>
```
```javascript
export default {
data() {
return {
currentPage: 1
}
}
}
```
#### Simple mode
```html
<van-pagination
v-model="currentPage"
:page-count="12"
mode="simple"
/>
```
#### Show ellipses
```html
<van-pagination
v-model="currentPage"
:total-items="125"
:show-page-size="3"
force-ellipses
/>
```
### API
| Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|
| v-model | Current page number | `Number` | - |
| mode | Mode, can be set to `simple` `multi` | `String` | `multi` |
| items-per-page | Item number per page | `Number` | `10` |
| prev-text | Previous text | `String` | `Previous` |
| next-text | Next text | `String` | `Next` |
| show-page-size | Count of page size to show | `Number` | `5` |
| force-ellipses | Whether to show ellipses | `Boolean` | `false` |
### Event
| Event | Description | Arguments |
|-----------|-----------|-----------|
| change | Triggered on page change | - |
+71
View File
@@ -0,0 +1,71 @@
## Pagination 分页
### 使用指南
``` javascript
import { Pagination } from 'vant';
Vue.use(Pagination);
```
### 代码演示
#### 基础用法
```html
<van-pagination
v-model="currentPage"
:total-items="24"
:items-per-page="5"
/>
```
```javascript
export default {
data() {
return {
currentPage: 1
}
}
}
```
#### 简单模式
```html
<van-pagination
v-model="currentPage"
:page-count="12"
mode="simple"
/>
```
#### 显示省略号
```html
<van-pagination
v-model="currentPage"
:total-items="125"
:show-page-size="3"
force-ellipses
/>
```
### API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| v-model | 当前页码 | `Number` | - |
| mode | 显示模式,可选值为 `simple` `multi` | `String` | `multi` |
| items-per-page | 每页记录数 | `Number` | `10` |
| previous-text | 上一页 | `String` | `上一页` |
| next-text | 下一页 | `String` | `下一页` |
| show-page-size | 显示的页码个数 | `Number` | `5` |
| force-ellipses | 显示省略号 | `Boolean` | `false` |
### Event
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|
| change | 页码改变时触发 | - |