目 录CONTENT

文章目录

better-scroll 滚动插件的使用

俊阳IT知识库
2023-01-19 / 0 评论 / 0 点赞 / 865 阅读 / 2,167 字 / 正在检测是否收录...
温馨提示:
本文最后更新于 2023-03-16,若内容或图片失效,请留言反馈。部分素材来自网络,若不小心影响到您的利益,请联系我们删除。
广告

文章已同步至掘金:https://juejin.cn/post/6844903910629441543
欢迎访问😃,有任何问题都可留言评论哦~

better-scroll 是什么?

better-scroll 是一款重点解决移动端(已支持 PC)各种滚动场景需求的插件。它的核心是借鉴的 iscroll 的实现,它的 API 设计基本兼容 iscroll,在 iscroll 的基础上又扩展了一些 feature 以及做了一些性能优化。

better-scroll 是基于原生 JS 实现的,不依赖任何框架。它编译后的代码大小是 63kb,压缩后是 35kb,gzip 后仅有 9kb,是一款非常轻量的 JS lib。

滚动原理

先来看一下浏览器的滚动原理:浏览器的滚动条大家都会遇到,当页面内容的高度超过视口高度的时候,会出现纵向滚动条;当页面内容的宽度超过视口宽度的时候,会出现横向滚动条。也就是当我们的视口展示不下内容的时候,会通过滚动条的方式让用户滚动屏幕看到剩余的内容。

better-scroll 也是一样的原理,如下图,可以更直观的来感受一下:

js-better-scroll-1

绿色部分为 wrapper,也就是父容器,它会有固定的高度。黄色部分为 content,它是父容器的第一个子元素,它的高度会随着内容的大小而撑高。那么,当 content 的高度不超过父容器的高度,是不能滚动的,而它一旦超过了父容器的高度,我们就可以滚动内容区了,这就是 better-scroll 的滚动原理。

注:在使用的时候外部容器的需要设置固定高度,还有一个问题需要设置overflow:hidden,这是因为为了隐藏超出部分。
有一点需要特别注意:滚动的元素只能是第一个容器的第一个元素

better-scroll 的使用

例如:

通过npm引入

安装better-scroll

npm install better-scroll -S

引入better-scroll

import BScroll from 'better-scroll'

如果不支持import,请使用require来引入

开始使用插件

DOM结构

<div class="wrapper">
    <ul class="content">
      <li>...</li>
      <li>...</li>
      ...
    </ul>
</div>

wrapper里只能有一层元素,也就是需要滚动的元素,使用了better-scroll之后,会自动在content加上动画的样式。

<!-- 这种结构是不可以滚动的 -->
<div class="wrapper">
    <ul class="content">
      ...
    </ul>
    <ul class="content">
      ...
    </ul>
</div>
<!-- 如果需要滚动的话加一层div包裹着两个ul标签 -->

wrapper一定需要指定高度,不然是无法滚动的。 需要看系统使用的定位是absolute还是flex,如果是flex是有默认的高度的,就不需要自己手动设置wrapper的高度。

注:父级bscroll必须有高度,并且overflow为hidden;

插件使用

mounted(){
    this.$nextTick(() => {
        let bscrollDom = this.$refs.bscroll;
        this.bscroll = new BScroll(bscrollDom,{ Option参数 }) //重点代码
    })   
}

注:
1.插件初始化时需要具体元素,所以在DOM结构中使用ref标记元素(然后使用上面的代码$refs获取元素),以备插件使用;
2.建议放在nextTick方法里面,避免DOM结构未渲染完成,从而造成子元素bscroll-container高度计算不准确;
3.建议使用this.bscroll方式定义,以备在其他方法中使用;
4.使用时一定要 new,使用时一定要 new,使用时一定要 new
重要的事情说三遍

Option 参数

  • startX: 0 开始的X轴位置
  • startY: 0 开始的Y轴位置
  • scrollX: ‘true’ 滚动方向为 X 轴
  • scrollY: true 滚动方向为 Y 轴
  • click: true 是否派发click事件
  • 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在手指 move 的时候也会实时派发 scroll 事件,不会截流。 3除了手指 move 的时候派发scroll事件,在 swipe(手指迅速滑动一小段距离)的情况下,列表会有一个长距离的滚动动画,这个滚动的动画过程中也会实时派发滚动事件

Events 事件

例如:

let scroll = new BScroll(document.getElementById('wrapper'),{
   probeType: 3
})

scroll.on('scroll', (pos) => {
  console.log(pos.x + '~' + pos.y)
  ...
})

Events 列表

  • beforeScrollStart - 滚动开始之前触发
  • scrollStart - 滚动开始时触发
  • scroll - 滚动时触发
  • scrollCancel - 取消滚动时触发
  • scrollEnd - 滚动结束时触发
  • touchend - 手指移开屏幕时触发
  • flick - 轻拂时触发
  • refresh - 当 better-scroll 刷新时触发
  • destroy - 销毁 better-scroll 实例时触发

方法

  • scrollTo(x, y, time, easing)

滚动到某个位置,x,y 代表坐标,time 表示动画时间,easing 表示缓动函数

例如:

let scroll = new BScroll(document.getElementById('wrapper'))
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 表示横向和纵向的页面索引

  • goToPage(x, y, time, easing)

当 snap 为 true,滚动到对应的页面,x 表示横向页面索引,y 表示纵向页面索引, time 表示动画,easing 表示缓动函数

  • enable()

启用 better-scroll,默认开启

  • disable()

禁用 better-scroll

  • destroy()

销毁 better-scroll,解绑事件

那些年走过的坑

DOM相关

当 DOM 结构发生变化的时候务必要调用refresh()确保滚动的效果正常,重新渲染高度

还有就是我上面写的DOM层级关系,wrapper里面一定不能存在多个同级的标签

content是否被成功添加滚动相关style

以下面dom结构为例:

<div class="classifyTitle"  ref="wrapper">
	<ul>
	    <li v-for="(item,index) in classifyData.products">
		<router-link :to="{name:'详情'}">{{item.title}}</router-link>
	    </li>
	</ul>				
</div>

审查元素可以看到:

js-better-scroll-2

这样即添加成功的

wrapper 与 content 高度问题

只有content的高度大于wrapper高度时候,才可以滚动。

如何看?

this.$nextTick(() => {
    if (!this.scroll) {
	this.scroll = new BScroll(this.$refs.wrapper, {})
	console.log(this.scroll)
    }
 })

F12就可以看到打印结果:

js-better-scroll-3

以上就是可以滚动的情况,wrapperHeight(616) < scrollHeight(750),hasVerticalScroll为true;

如果这些数据不对,检查是否dom没有更新完就初始化BScroll了,要等dom更新完才能初始化

wrapper 样式

.wrapper元素上要给定位

position: absolute;
left: 0;
top: 0;
overflow: hidden;

^_<

0

评论区