Install

import { createApp } from 'vue';
import { PullRefresh } from 'vant';

const app = createApp();
app.use(PullRefresh);

Usage

Basic Usage

The refresh event will be Emitted when pull refresh, you should set v-model to false to reset loading status after process refresh event.

<van-pull-refresh v-model="loading" @refresh="onRefresh">
  <p>Refresh Count: {{ count }}</p>
</van-pull-refresh>

import { ref } from 'vue';
import { Toast } from 'vant';

export default {
  setup() {
    const count = ref(0);
    const loading = ref(false);
    const onRefresh = () => {
      setTimeout(() => {
        Toast('Refresh Success');
        loading.value = false;
        count.value++;
      }, 1000);
    };

    return {
      count,
      loading,
      onRefresh,
    };
  },
};

Success Tip

Use success-text to set the success prompt after the refresh is successful

<van-pull-refresh
  v-model="isLoading"
  success-text="Refresh success"
  @refresh="onRefresh"
>
  <p>Refresh Count: {{ count }}</p>
</van-pull-refresh>

Custom Tips

Use slots to custom tips.

<van-pull-refresh v-model="isLoading" :head-height="80" @refresh="onRefresh">
  <template #pulling="props">
    <img
      class="doge"
      src="https://fastly.jsdelivr.net/npm/@vant/assets/doge.png"
      :style="{ transform: \`scale(\${props.distance / 80})\` }"
    />
  </template>

  <template #loosing>
    <img
      class="doge"
      src="https://fastly.jsdelivr.net/npm/@vant/assets/doge.png"
    />
  </template>

  <template #loading>
    <img
      class="doge"
      src="https://fastly.jsdelivr.net/npm/@vant/assets/doge-fire.jpeg"
    />
  </template>
  <p>Refresh Count: {{ count }}</p>
</van-pull-refresh>

<style>
  .doge {
    width: 140px;
    height: 72px;
    margin-top: 8px;
    border-radius: 4px;
  }
</style>

API

Props

Attribute	Description	Type	Default
v-model	Loading status	boolean	-
pulling-text	Text to show when pulling	string	`Pull to refresh...`
loosing-text	Text to show when loosing	string	`Loose to refresh...`
loading-text	Text to show when loading	string	`Loading...`
success-text	Text to show when loading success	string	-
success-duration	Success text display duration(ms)	number \| string	`500`
animation-duration	Animation duration	number \| string	`300`
head-height	Height of head	number \| string	`50`
pull-distance `v3.0.8`	The distance to trigger the pull refresh	number \| string	same as `head-height`
disabled	Whether to disable pull refresh	boolean	`false`

Events

Event	Description	Parameters
refresh	Emitted after pulling refresh	-
change `v3.5.1`	Emitted when draging or status changed	{ status: string, distance: number }

Slots

Name	Description	SlotProps
default	Default slot	-
normal	Content of head when at normal status	-
pulling	Content of head when at pulling	{ distance: number }
loosing	Content of head when at loosing	{ distance: number }
loading	Content of head when at loading	{ distance: number }
success	Content of head when succeed	-

Types

The component exports the following type definitions:

import type { PullRefreshProps } from 'vant';

Theming

CSS Variables

The component provides the following CSS variables, which can be used to customize styles. Please refer to ConfigProvider component.

Name	Default Value	Description
--van-pull-refresh-head-height	50px	-
--van-pull-refresh-head-font-size	var(--van-font-size-md)	-
--van-pull-refresh-head-text-color	var(--van-text-color-2)	-
--van-pull-refresh-loading-icon-size	16px	-

PullRefresh

Intro