# 下拉刷新配置

参数 说明 类型 默认值 可选值
refresher-enabled 是否开启下拉刷新 Boolean true false
refresher-threshold 设置自定义下拉刷新阈值,默认单位为px。

(支持传100、"100px"或"100rpx")(nvue无效)

Number|String 80rpx -
use-refresher-status-bar-placeholder 2.6.1 是否开启下拉刷新状态栏占位,适用于隐藏导航栏时,下拉刷新需要避开状态栏高度的情况 Boolean false true
refresher-only 1.6.6 是否只使用下拉刷新,设置为true后将关闭mounted自动请求数据、关闭滚动到底部加载更多,强制隐藏空数据图。

若只想关闭滚动到底部加载更多,请点击这里

Boolean false true
use-custom-refresher 是否使用自定义的下拉刷新,默认为是,即使用z-paging的下拉刷新。设置为false即代表使用uni scroll-view自带的下拉刷新,h5、App、微信小程序以外的平台不支持uni scroll-view自带的下拉刷新 Boolean true h5、App、微信小程序以外的平台设置为false时,无法使用下拉刷新
show-refresher-when-reload 1.7.2 列表刷新时自动显示下拉刷新view Boolean false true
reload-when-refresh 2.1.0 用户下拉刷新时是否触发reload方法

若设置为false,则下拉刷新时将不进行任何处理,若您想终止下拉刷新状态,请使用this.$refs.paging.endRefresh()

Boolean true false
refresher-theme-style 下拉刷新的主题样式,支持black,white String black white
refresher-img-style 2.0.2 自定义下拉刷新中左侧图标的样式 Object {} -
refresher-title-style 2.0.2 自定义下拉刷新中右侧状态描述文字的样式 Object {} -
refresher-update-time-style 2.0.2 自定义下拉刷新中右侧最后更新时间文字的样式

(show-refresher-update-time为true时有效)

Object {} -
watch-refresher-touchmove 2.1.0 在微信小程序和QQ小程序中,是否实时监听下拉刷新中进度,并通过@refresherTouchmove传递给父组件,在其他平台会自动判断,无需设置此属性 Boolean false true
show-refresher-update-time 1.6.7 是否显示最后更新时间 Boolean false true
refresher-update-time-key 1.6.7 如果需要区别不同页面的最后更新时间,请为不同页面的z-paging的refresher-update-time-key设置不同的字符串 String default -
refresher-default-text 自定义下拉刷新默认状态下的文字

(支持直接传字符串或形如:{'en':'英文配置':'zh-Hans':'中文配置'}的i18n配置)

String|Object 继续下拉刷新 -
refresher-pulling-text 自定义下拉刷新松手立即刷新状态下的文字

(支持直接传字符串或形如:{'en':'英文配置':'zh-Hans':'中文配置'}的i18n配置)

String|Object 松开立即刷新 -
refresher-refreshing-text 自定义下拉刷新刷新中状态下的文字

(支持直接传字符串或形如:{'en':'英文配置':'zh-Hans':'中文配置'}的i18n配置)

String|Object 正在刷新... -
refresher-complete-text 2.0.6 自定义下拉刷新刷新结束状态下的文字

(支持直接传字符串或形如:{'en':'英文配置':'zh-Hans':'中文配置'}的i18n配置)

(注意:默认情况下您无法看到刷新结束状态下的文字,除非您设置了refresher-complete-delay并且值足够大,例如:500)

String|Object 刷新成功 -
refresher-default-img 2.3.6 自定义下拉刷新默认状态下的图片

(建议使用绝对路径,开头不要添加"@",请以"/"开头)

String - -
refresher-pulling-img 2.3.6 自定义下拉刷新松手立即刷新状态下的图片,默认与refresher-default-img一致

(建议使用绝对路径,开头不要添加"@",请以"/"开头)

String - -
refresher-refreshing-img 2.3.6 自定义下拉刷新刷新中状态下的图片

(建议使用绝对路径,开头不要添加"@",请以"/"开头)

String - -
refresher-complete-img 2.3.6 自定义下拉刷新刷新结束状态下的图片

(建议使用绝对路径,开头不要添加"@",请以"/"开头)

(注意:默认情况下您无法看到刷新结束状态下的图片,除非您设置了refresher-complete-delay并且值足够大,例如:500)

String - -
refresher-refreshing-animated 2.5.8 自定义下拉刷新刷新中状态下是否展示旋转动画 Boolean true false
refresher-end-bounce-enabled 是否开启自定义下拉刷新刷新结束回弹动画效果(收回后上下弹一下的动画) Boolean true false
refresher-default-style 设置系统下拉刷新默认样式,支持设置 black,white,none,none 表示不使用默认样式

(不使用z-paging内置的而是使用系统的下拉刷新时才有效,也就是use-custom-refresher为false时才有效)

String black white、none
refresher-background 设置自定义下拉刷新区域背景颜色 String #FFFFFF00(透明) -
refresher-fixed-background 设置固定的自定义下拉刷新区域背景颜色

(必须设置refresher-fixed-bac-height,否则无效)

String #FFFFFF00(透明) -
refresher-fixed-bac-height 设置固定的自定义下拉刷新区域高度 Number|String 0 -
refresher-default-duration 2.3.1 设置自定义下拉刷新默认状态下回弹动画时间,单位为毫秒 Number|String 100 -
refresher-complete-delay 2.0.6 自定义下拉刷新结束以后延迟收回的时间,单位为毫秒

(默认为0,因此看不到刷新结束状态。若需要展示刷新结束状态,请设置一个合适的值,例如200)

Number|String 0 -
refresher-complete-duration 2.0.6 自定义下拉刷新结束收回动画时间,单位为毫秒(refresher-end-bounce-enabled为false时,refresher-complete-duration为设定值的1/3)

(nvue无效)

Number|String 300 -
refresher-vibrate 2.4.7 下拉刷新时下拉到“松手立即刷新”状态时是否使手机短振动

(h5无效)

Boolean false true
refresher-refreshing-scrollable 2.7.8 自定义下拉刷新刷新中状态是否允许列表滚动 Boolean true false
refresher-complete-scrollable 2.1.1 自定义下拉刷新结束状态下是否允许列表滚动 Boolean false true
refresher-out-rate 设置自定义下拉刷新下拉超出阈值后继续下拉位移衰减的比例,范围0-1,值越大代表衰减越多。

(nvue无效)

Number 0.65 -
refresher-f2-enabled 2.7.7 是否开启下拉进入二楼功能 Boolean false true
refresher-f2-threshold 2.7.7 下拉进入二楼阈值 Number|String 200rpx -
refresher-f2-duration 2.7.7 下拉进入二楼动画时间,单位为毫秒 Number|String 200 -
show-refresher-f2 2.7.7 下拉进入二楼状态松手后是否弹出二楼 Boolean true false
refresher-pull-rate 2.3.7 设置自定义下拉刷新下拉时实际下拉位移与用户下拉距离的比值,默认为0.75,即代表若用户下拉10px,则实际位移为7.5px。

(nvue无效)

Number 0.75 -
refresher-fps 自定义下拉刷新下拉帧率,默认为40,过高可能会出现抖动问题 Number|String 40 -
refresher-max-angle 自定义下拉刷新允许触发的最大下拉角度,默认为40度,当下拉角度小于设定值时,自定义下拉刷新动画不会被触发。

(值小于0或大于90时,代表不受角度限制)

Number|String 40 0-90
refresher-angle-enable-change-continued 自定义下拉刷新的角度由未达到最大角度变到达到最大角度时,是否继续下拉刷新手势 Boolean false true
refresher-no-transform 2.5.8 下拉刷新时是否禁止下拉刷新view跟随用户触摸竖直移动。注意此属性只是禁止下拉刷新view移动,其他下拉刷新逻辑依然会正常触发 Boolean false true