中文文檔地址

let obj = new BScroll(object,{[option1,],.,.});

1、 Options 參數(shù)

startX: 0 開(kāi)始的X軸位置
startY: 0 開(kāi)始的Y軸位置
scrollY: true 滾動(dòng)方向?yàn)?Y 軸
scrollX: true 滾動(dòng)方向?yàn)?X 軸
click: true 是否派發(fā)click事件，通常判斷瀏覽器派發(fā)的click還是betterscroll派發(fā)的click石景，可以用_constructed，若是bs派發(fā)的則為true
directionLockThreshold: 5
momentum: true 當(dāng)快速滑動(dòng)時(shí)是否開(kāi)啟滑動(dòng)慣性
bounce: true 是否啟用回彈動(dòng)畫(huà)效果
selectedIndex: 0 wheel 為 true 時(shí)有效，表示被選中的 wheel 索引
rotate: 25 wheel 為 true 時(shí)有效竟痰，表示被選中的 wheel 每一層的旋轉(zhuǎn)角度
wheel: false 該屬性是給 picker 組件使用的，普通的列表滾動(dòng)不需要配置
snap: false 該屬性是給 slider 組件使用的掏呼，普通的列表滾動(dòng)不需要配置
snapLoop: false 是否可以無(wú)縫循環(huán)輪播
snapThreshold: 0.1 用手指滑動(dòng)時(shí)頁(yè)面可切換的閾值坏快，大于這個(gè)閾值可以滑動(dòng)的下一頁(yè)
snapSpeed: 400, 輪播圖切換的動(dòng)畫(huà)時(shí)間
swipeTime: 2500 swipe 持續(xù)時(shí)間
bounceTime: 700 彈力動(dòng)畫(huà)持續(xù)的毫秒數(shù)
adjustTime: 400 wheel 為 true 有用，調(diào)整停留位置的時(shí)間
swipeBounceTime: 1200 swipe 回彈 時(shí)間
deceleration: 0.001 滾動(dòng)動(dòng)量減速越大越快憎夷，建議不大于0.01
momentumLimitTime: 300 符合慣性拖動(dòng)的最大時(shí)間
momentumLimitDistance: 15 符合慣性拖動(dòng)的最小拖動(dòng)距離
resizePolling: 60 重新調(diào)整窗口大小時(shí)假消，重新計(jì)算better-scroll的時(shí)間間隔
preventDefault: true 是否阻止默認(rèn)事件
preventDefaultException: { tagName: /^(INPUT|TEXTAREA|BUTTON|SELECT)$/ } 阻止默認(rèn)事件
HWCompositing: true 是否啟用硬件加速
useTransition: true 是否使用CSS3的Transition屬性
useTransform: true 是否使用CSS3的Transform屬性
probeType: 1 滾動(dòng)的時(shí)候會(huì)派發(fā)scroll事件，會(huì)截流岭接。2滾動(dòng)的時(shí)候?qū)崟r(shí)派發(fā)scroll事件富拗，不會(huì)截流臼予。 3除了實(shí)時(shí)派發(fā)scroll事件，在swipe的情況下仍然能實(shí)時(shí)派發(fā)scroll事件

2啃沪、Events 事件

beforeScrollStart - 滾動(dòng)開(kāi)始之前觸發(fā)
scrollStart - 滾動(dòng)開(kāi)始時(shí)觸發(fā)
scroll - 滾動(dòng)時(shí)觸發(fā)
scrollCancel - 取消滾動(dòng)時(shí)觸發(fā)
scrollEnd - 滾動(dòng)結(jié)束時(shí)觸發(fā)
touchend - 手指移開(kāi)屏幕時(shí)觸發(fā)
flick - 觸發(fā)了 fastclick 時(shí)的回調(diào)函數(shù)
refresh - 當(dāng) better-scroll 刷新時(shí)觸發(fā)
destroy - 銷毀 better-scroll 實(shí)例時(shí)觸發(fā)

• 事件例子

Example:

let scroll = new BScroll(document.getElementById('wrapper'),{
   probeType: 3
})
 
scroll.on('scroll', (pos) => {
  console.log(pos.x + '~' + pos.y)
})

3粘拾、函數(shù)列表

scrollTo(x, y, time, easing)
滾動(dòng)到某個(gè)位置，x,y 代表坐標(biāo)创千，time 表示動(dòng)畫(huà)時(shí)間缰雇，easing 表示緩動(dòng)函數(shù)
scroll.scrollTo(0, 500)

 

scrollToElement(el, time, offsetX, offsetY, easing)
滾動(dòng)到某個(gè)元素，el（必填）表示 dom 元素追驴，time 表示動(dòng)畫(huà)時(shí)間械哟，offsetX 和 offsetY 表示坐標(biāo)偏移量，easing 表示緩動(dòng)函數(shù)

 

refresh()
強(qiáng)制 scroll 重新計(jì)算殿雪，當(dāng) better-scroll 中的元素發(fā)生變化的時(shí)候調(diào)用此方法

 

getCurrentPage()
snap 為 true 時(shí)暇咆，獲取滾動(dòng)的當(dāng)前頁(yè)，返回的對(duì)象結(jié)構(gòu)為 {x, y, pageX, pageY}丙曙，其中 x,y 代表滾動(dòng)橫向和縱向的位置爸业；pageX，pageY 表示橫向和縱向的頁(yè)面索引亏镰。用法如：getCurrentPage().pageX

 

goToPage(x, y, time, easing)
snap 為 true扯旷，滾動(dòng)到對(duì)應(yīng)的頁(yè)面，x 表示橫向頁(yè)面索引索抓，y 表示縱向頁(yè)面索引钧忽， time 表示動(dòng)畫(huà)，easing 表示緩動(dòng)函數(shù)（可省略不寫(xiě)）

enable()啟用 better-scroll逼肯，默認(rèn)開(kāi)啟
 

disable()  禁用 better-scroll
 

destroy() 銷毀 better-scroll耸黑，解綁事件

• 使用實(shí)例

  this.scroll.scrollTo(0,-top,500,'swipe')