better-scroll的使用以及常见的api总结

Love The Way You Lie 2023-06-23 10:56 5阅读 0赞

##### 一、 better-scroll的使用 #####

1.  通过`cnpm i -S better-scroll` 或者是 `npm i -S better-scroll` 命令就可以进行下载`better-scroll`到项目中
2.  通过`import BScroll from 'better-scroll';`语句引入到页面当中，再通过 `new BScroll`创建BScroll对象，接受两个参数，第一个是DOM对象，第二个是options配置项，代码如下示例：

var scroll = new BScroll( this.$refs.movie_body, { 
                    tap: true,
                    probeType: 1
        });

1.  如果想要给BScroll绑定better-scroll的事件，可以通过`scroll.on`去实现，第一个参数是事件名称，第二个是回调函数，传pos参数为位置信息，代码如下示例：

// 绑定滚动事件, pos表示位置信息
                         scroll.on('scroll', (pos) => { 
                             if ( pos.y > 30 ) { 
                                 this.pullDownMsg = '正在更新中';
                             }
                         });

1.  在使用`better-scroll`的时候，最好在`mounted()`钩子函数中，在数据请求完以后，通过`this.$nextTick()`，在这个里面写回调函数，去创建`BScroll`对象以及后续的操作。因为vue实现响应式，在数据发生变化以后，DOW并不会立即更新，而是按照一定的策略进行更新，Vue中的DOM是异步加载。使用`$nextTick()`可以在数据发生变化后立即获得更新后的DOM，也就是说在数据渲染完毕以后，界面渲染完毕以后，再执行方法的回调。代码完整示例如下：

mounted() { 
            this.axios.get('/api/movieOnInfoList?cityId=10').then((res) => { 
                var msg = res.data.msg;
                if( msg === 'ok') { 
                    this.movieList = res.data.data.movieList;
                    this.isLoading = false;
                    // vue实现响应式，在数据发生变化以后，DOW并不会立即更新，而是按照一定的策略进行更新
                    // 使用 $nextTick() 可以在数据发生变化后立即获得更新后的DOM，也就是说在数据渲染完毕以后，界面渲染完毕以后，再执行方法的回调
                    this.$nextTick(() => { 
                        // 在BScroll对象中，第一个参数为DOM对象， 第二个参数为better-scroll中的配置项
                        var scroll = new BScroll( this.$refs.movie_body, { 
                            tap: true,
                            probeType: 1
                        });
                        
                        // 绑定滚动事件, pos表示位置信息
                        scroll.on('scroll', (pos) => { 
                            if ( pos.y > 30 ) { 
                                this.pullDownMsg = '正在更新中';
                            }
                        });
    
                        // 绑定点击离开事件，在鼠标或手指离开后触发
                        scroll.on('touchEnd', (pos) => { 
                            if ( pos.y > 30) { 
                                this.axios.get('/api/movieOnInfoList?cityId=10').then( (res) => { 
                                    var msg = res.data.msg;
                                    if ( msg === 'ok' ) { 
                                        this.pullDownMsg = '更新完成';
                                        setTimeout(() => { 
                                            this.movieList = res.data.data.movieList;
                                            this.pullDownMsg = '';
                                        }, 1000);
                                    }
                                });
                            }
                        });
                        
                    });
                }
            })
        },

##### 二、better-scroll的api总结 #####

1.  Options 参数

startX: 0 开始的X轴位置
    startY: 0 开始的Y轴位置
    scrollY: true 滚动方向为 Y 轴
    scrollX: true 滚动方向为 X 轴
    click: true 是否派发click事件，通常判断浏览器派发的click还是betterscroll派发的click，可以用_constructed，若是bs派发的则为true
    directionLockThreshold: 5
    momentum: true 当快速滑动时是否开启滑动惯性
    bounce: true 是否启用回弹动画效果
    selectedIndex: 0 wheel 为 true 时有效，表示被选中的 wheel 索引
    rotate: 25 wheel 为 true 时有效，表示被选中的 wheel 每一层的旋转角度
    wheel: false 该属性是给 picker 组件使用的，普通的列表滚动不需要配置
    snap: false 该属性是给 slider 组件使用的，普通的列表滚动不需要配置
    snapLoop: false 是否可以无缝循环轮播
    snapThreshold: 0.1 用手指滑动时页面可切换的阈值，大于这个阈值可以滑动的下一页
    snapSpeed: 400, 轮播图切换的动画时间
    swipeTime: 2500 swipe 持续时间
    bounceTime: 700 弹力动画持续的毫秒数
    adjustTime: 400 wheel 为 true 有用，调整停留位置的时间
    swipeBounceTime: 1200 swipe 回弹 时间
    deceleration: 0.001 滚动动量减速越大越快，建议不大于0.01
    momentumLimitTime: 300 符合惯性拖动的最大时间
    momentumLimitDistance: 15 符合惯性拖动的最小拖动距离
    resizePolling: 60 重新调整窗口大小时，重新计算better-scroll的时间间隔
    preventDefault: true 是否阻止默认事件
    preventDefaultException: { tagName: /^(INPUT|TEXTAREA|BUTTON|SELECT)$/ } 阻止默认事件
    HWCompositing: true 是否启用硬件加速
    useTransition: true 是否使用CSS3的Transition属性
    useTransform: true 是否使用CSS3的Transform属性
    probeType: 1. 滚动的时候会派发scroll事件，会截流 2. 滚动的时候实时派发scroll事件，不会截流 3. 除了实时派发scroll事件，在swipe的情况下仍然能实时派发scroll事件

1.  Events 事件

beforeScrollStart - 滚动开始之前触发
    scrollStart - 滚动开始时触发
    scroll - 滚动时触发
    scrollCancel - 取消滚动时触发
    scrollEnd - 滚动结束时触发
    touchend - 手指移开屏幕时触发
    flick - 触发了 fastclick 时的回调函数
    refresh - 当 better-scroll 刷新时触发
    destroy - 销毁 better-scroll 实例时触发
    Example:
    
    let scroll = new BScroll(document.getElementById('wrapper'),{
       probeType: 3
    })
     
    scroll.on('scroll', (pos) => {
      console.log(pos.x + '~' + pos.y)
    })

1.  函数列表

scrollTo(x, y, time, easing)
    滚动到某个位置，x,y 代表坐标，time 表示动画时间，easing 表示缓动函数
    scroll.scrollTo(0, 500)
    
    scrollToElement(el, time, offsetX, offsetY, easing)
    滚动到某个元素，el（必填）表示 dom 元素，time 表示动画时间，offsetX 和 offsetY 表示坐标偏移量，easing 表示缓动函数
    
    refresh()
    强制 scroll 重新计算，当 better-scroll 中的元素发生变化的时候调用此方法
    
    getCurrentPage()
    snap 为 true 时，获取滚动的当前页，返回的对象结构为 {x, y, pageX, pageY}，其中 x,y 代表滚动横向和纵向的位置；pageX，pageY 表示横向和纵向的页面索引。用法如：getCurrentPage().pageX
    
    goToPage(x, y, time, easing)
    snap 为 true，滚动到对应的页面，x 表示横向页面索引，y 表示纵向页面索引， time 表示动画，easing 表示缓动函数（可省略不写）
    
    enable()启用 better-scroll，默认开启
     
    disable()  禁用 better-scroll
     
    destroy() 销毁 better-scroll，解绑事件