用于提供下拉刷新的交互操作。
import Vue from 'vue';
import { PullRefresh } from 'vant';
Vue.use(PullRefresh);
下拉刷新時(shí)會(huì)觸發(fā) refresh
事件,在事件的回調(diào)函數(shù)中可以進(jìn)行同步或異步操作,操作完成后將 v-model
設(shè)置為 false
,表示加載完成。
<van-pull-refresh v-model="isLoading" @refresh="onRefresh">
<p>刷新次數(shù): {{ count }}</p>
</van-pull-refresh>
import { Toast } from 'vant';
export default {
data() {
return {
count: 0,
isLoading: false,
};
},
methods: {
onRefresh() {
setTimeout(() => {
Toast('刷新成功');
this.isLoading = false;
this.count++;
}, 1000);
},
},
};
通過(guò) success-text
可以設(shè)置刷新成功后的頂部提示文案。
<van-pull-refresh
v-model="isLoading"
success-text="刷新成功"
@refresh="onRefresh"
>
<p>刷新次數(shù): {{ count }}</p>
</van-pull-refresh>
通過(guò)插槽可以自定義下拉刷新過(guò)程中的提示內(nèi)容。
<van-pull-refresh v-model="isLoading" :head-height="80" @refresh="onRefresh">
<!-- 下拉提示,通過(guò) scale 實(shí)現(xiàn)一個(gè)縮放效果 -->
<template #pulling="props">
<img
class="doge"
src="https://img01.yzcdn.cn/vant/doge.png" rel="external nofollow" rel="external nofollow"
:style="{ transform: `scale(${props.distance / 80})` }"
/>
</template>
<!-- 釋放提示 -->
<template #loosing>
<img class="doge" src="https://img01.yzcdn.cn/vant/doge.png" rel="external nofollow" rel="external nofollow" />
</template>
<!-- 加載提示 -->
<template #loading>
<img class="doge" src="https://img01.yzcdn.cn/vant/doge-fire.jpg" rel="external nofollow" />
</template>
<p>刷新次數(shù): {{ count }}</p>
</van-pull-refresh>
<style>
.doge {
width: 140px;
height: 72px;
margin-top: 8px;
border-radius: 4px;
}
</style>
參數(shù) | 說(shuō)明 | 類(lèi)型 | 默認(rèn)值 |
---|---|---|---|
v-model | 是否處于加載中狀態(tài) | boolean | - |
pulling-text | 下拉過(guò)程提示文案 | string | 下拉即可刷新...
|
loosing-text | 釋放過(guò)程提示文案 | string | 釋放即可刷新...
|
loading-text | 加載過(guò)程提示文案 | string | 加載中...
|
success-text | 刷新成功提示文案 | string | - |
success-duration | 刷新成功提示展示時(shí)長(zhǎng)(ms) | number | string | 500
|
animation-duration | 動(dòng)畫(huà)時(shí)長(zhǎng) | number | string | 300
|
head-height | 頂部?jī)?nèi)容高度 | number | string | 50
|
pull-distance v2.12.8
|
觸發(fā)下拉刷新的距離 | number | string | 與 head-height 一致 |
disabled | 是否禁用下拉刷新 | boolean | false
|
事件名 | 說(shuō)明 | 回調(diào)參數(shù) |
---|---|---|
refresh | 下拉刷新時(shí)觸發(fā) | - |
名稱(chēng) | 說(shuō)明 | 參數(shù) |
---|---|---|
default | 自定義內(nèi)容 | - |
normal | 非下拉狀態(tài)時(shí)頂部?jī)?nèi)容 | - |
pulling | 下拉過(guò)程中頂部?jī)?nèi)容 | { distance: 當(dāng)前下拉距離 } |
loosing | 釋放過(guò)程中頂部?jī)?nèi)容 | { distance: 當(dāng)前下拉距離 } |
loading | 加載過(guò)程中頂部?jī)?nèi)容 | { distance: 當(dāng)前下拉距離 } |
success | 刷新成功提示內(nèi)容 | - |
組件提供了下列 Less 變量,可用于自定義樣式,使用方法請(qǐng)參考主題定制。
名稱(chēng) | 默認(rèn)值 | 描述 |
---|---|---|
@pull-refresh-head-height | 50px
|
- |
@pull-refresh-head-font-size | @font-size-md
|
- |
@pull-refresh-head-text-color | @gray-6
|
- |
默認(rèn)情況下,下拉區(qū)域的高度是和內(nèi)容高度保持一致的,如果需要讓下拉區(qū)域始終為全屏,可以給 PullRefresh 設(shè)置一個(gè)與屏幕大小相等的最小高度:
<van-pull-refresh style="min-height: 100vh;" />
PullRefresh 的觸發(fā)條件是「父級(jí)滾動(dòng)元素的滾動(dòng)條在頂部位置」。
window
,則要求 window.pageYOffset === 0
。Element
,則要求 Element.scrollTop === 0
。參見(jiàn)桌面端適配。
更多建議: