mirror of
https://github.com/youzan/vant.git
synced 2025-12-17 02:00:43 +08:00
[Doc] rename component README file (#3662)
This commit is contained in:
74
src/pull-refresh/README.zh-CN.md
Normal file
74
src/pull-refresh/README.zh-CN.md
Normal file
@@ -0,0 +1,74 @@
|
||||
# PullRefresh 下拉刷新
|
||||
|
||||
### 引入
|
||||
|
||||
``` javascript
|
||||
import { PullRefresh } from 'vant';
|
||||
|
||||
Vue.use(PullRefresh);
|
||||
```
|
||||
|
||||
## 代码演示
|
||||
|
||||
### 基础用法
|
||||
|
||||
下拉刷新时会触发 `refresh` 事件,在事件的回调函数中可以进行同步或异步操作,操作完成后将 `v-model` 设置为 `false`,表示加载完成。
|
||||
|
||||
```html
|
||||
<van-pull-refresh v-model="isLoading" @refresh="onRefresh">
|
||||
<p>刷新次数: {{ count }}</p>
|
||||
</van-pull-refresh>
|
||||
```
|
||||
|
||||
```javascript
|
||||
export default {
|
||||
data() {
|
||||
return {
|
||||
count: 0,
|
||||
isLoading: false
|
||||
}
|
||||
},
|
||||
|
||||
methods: {
|
||||
onRefresh() {
|
||||
setTimeout(() => {
|
||||
this.$toast('刷新成功');
|
||||
this.isLoading = false;
|
||||
this.count++;
|
||||
}, 500);
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
### Props
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||||
|------|------|------|------|------|
|
||||
| v-model | 是否在加载中 | `Boolean` | - | - |
|
||||
| pulling-text | 下拉过程文案 | `String` | `下拉即可刷新...` | - |
|
||||
| loosing-text | 释放过程文案 | `String` | `释放即可刷新...` | - |
|
||||
| loading-text | 加载过程文案 | `String` | `加载中...` | - |
|
||||
| success-text | 加载成功提示文案 | `String` | - | 1.6.2 |
|
||||
| success-duration | 加载成功提示时长(ms) | `Number` | `500` | 1.6.2 |
|
||||
| animation-duration | 动画时长 | `Number` | `300` | - |
|
||||
| head-height | 顶部内容高度 | `Number` | `50` | - |
|
||||
| disabled | 是否禁用 | `Boolean` | `false` | 1.1.10 |
|
||||
|
||||
### Events
|
||||
|
||||
| 事件名 | 说明 | 回调参数 |
|
||||
|------|------|------|
|
||||
| refresh | 下拉刷新时触发 | - |
|
||||
|
||||
### Slots
|
||||
|
||||
| 名称 | 说明 |
|
||||
|------|------|
|
||||
| default | 自定义内容 |
|
||||
| normal | 非下拉状态时顶部内容 |
|
||||
| pulling | 下拉过程中顶部内容 |
|
||||
| loosing | 释放过程中顶部内容 |
|
||||
| loading | 加载过程中顶部内容 |
|
||||
Reference in New Issue
Block a user