jq960素材网

当前位置: 主页 > JQ/JS插件 > vue插件 > 布局 >

Vue-Pull-To

官方网址:http:// 下载次数:
插件描述

一个集成了下拉刷新、上拉加载、无限滚动加载的Vue组件。

安装

 npm install vue-pull-to --save

快速上手

<template>
  <div>
    <pull-to :top-load-method="refresh">
      <ul v-for="item in dataList">
        <li>{{ item }}</li>
      </ul>
    </pull-to>
  </div> 
</template>

<script>
  import PullTo from 'vue-pull-to'
  import { fetchDataList } from 'api'
  
  export default {
    name: 'example',
    components: {
      PullTo
    },
    data() {
      return {
        dataList: []
      }
    },
    methods: {
      refresh(loaded) {
       fetchDataList()
        .then((res) => {
          this.dataList = res.data.dataList
          loaded('done')
        })
      }
    }
  }
</script>

组件会默认占据父元素的百分之百高度。props top-load-methodbottom-load-method会默认传进一个loaded参数,该参数是一个改变组件加载状态的函数,必须调用一次loaded不然组件就会一直处于加载状态,如果执行loaded('done')组件内部状态就会变成成功加载的状态,loaded('fail')为失败。

更多使用示例请参考Examples的代码

API文档

props

属性说明类型默认值
distance-index滑动的阀值(值越大滑动的速度越慢)Number2
top-block-height顶部在滚动容器外的块级元素区域高度Number50
bottom-block-height底部在滚动容器外的块级元素区域高度Number50
wrapper-height滚动容器的高度String'100%'
top-load-method顶部下拉时执行的方法Function
bottom-load-method底部上拉时执行的方法Function
is-throttle-top-pull是否截流top-pull事件的触发以保证性能,如果需要实时触发设为falseBooleantrue
is-throttle-bottom-pull是否截流bottom-pull事件的触发以保证性能,如果需要实时触发设为falseBooleantrue
is-throttle-scroll是否截流scroll事件的触发以保证性能,如果需要实时触发设为falseBooleantrue
is-top-bounce是否启用下拉回弹效果Booleantrue
is-bottom-bounce是否启用上拉回弹效果Booleantrue
top-config滚动容器顶部信息的一些配置Object默认配置
bottom-config滚动容器底部信息的一些配置Object默认配置

topConfigbottomConfig可配置的选项和默认配置项的值

const TOP_DEFAULT_CONFIG = {
  pullText: '下拉刷新', // 下拉时显示的文字
  triggerText: '释放更新', // 下拉到触发距离时显示的文字
  loadingText: '加载中...', // 加载中的文字
  doneText: '加载完成', // 加载完成的文字
  failText: '加载失败', // 加载失败的文字
  loadedStayTime: 400, // 加载完后停留的时间ms
  stayDistance: 50, // 触发刷新后停留的距离
  triggerDistance: 70 // 下拉刷新触发的距离
}

const BOTTOM_DEFAULT_CONFIG = {
  pullText: '上拉加载',
  triggerText: '释放更新',
  loadingText: '加载中...',
  doneText: '加载完成',
  failText: '加载失败',
  loadedStayTime: 400,
  stayDistance: 50,
  triggerDistance: 70
}

slots

名称说明scope
default默认slot滚动容器的内容
top-block滚动容器外顶部的内容(支持作用域slot需用template标签加上scope属性)state:当前的状态、state-text:状态对应的文本
bottom-block滚动容器外底部的内容(支持作用域slot需用template标签加上scope属性)state:当前的状态、state-text:状态对应的文本

events

事件名说明
top-state-change顶部状态发生了改变时触发,第一个参数为当前的状态
bottom-state-change底部状态发生了改变时触发,第一个参数为当前的状态
top-pull下拉时触发,第一个参数为当前拉动的距离值,默认会被截流,可配置props isThrottle来实时触发
bottom-pull上拉时触发,第一个参数为当前拉动的距离值,默认会被截流,可配置props isThrottle来实时触发
infinite-scroll当滚动容器滚动到底部时触发
scroll滚动时触发,事件回调函数第一个参数为原生的event对象


顶一下
(0)
0%
踩一下
(0)
0%
------分隔线----------------------------
栏目列表
推荐素材