Functions

addScrollLeft()

addScrollLeft(el, value): void

增加水平滚动距离

Parameters

Parameter	Type
el	Target
value	number

Returns

void

---

addScrollTop()

addScrollTop(el, value): void

增加垂直滚动距离

Parameters

Parameter	Type
el	Target
value	number

Returns

void

---

createScrollbarHelper()

createScrollbarHelper(el): ScrollbarHelper

创建元素滚动栏辅助工具

Parameters

Parameter	Type	Description
el	MaybeFn<Target>	指定元素

Returns

ScrollbarHelper

Example

const scrollbar = createScrollbarHelper(el)

scrollbar.getScrollLeft()
// => 0

// 实现自动滚动
setInterval(() => {
  if (scrollbar.isReachBottom()) {
    scrollbar.setScrollTop(0)
  }
  else {
    scrollbar.addScrollTop(1)
  }
}, 30)

---

getScrollLeft()

getScrollLeft(el): number

获取水平滚动距离

Parameters

Parameter	Type
el	Target

Returns

number

---

getScrollTop()

getScrollTop(el): number

获取垂直滚动距离

Parameters

Parameter	Type
el	Target

Returns

number

---

isReachBottom()

isReachBottom(el): boolean

是否到达垂直末端

Parameters

Parameter	Type
el	Target

Returns

boolean

---

isReachRight()

isReachRight(el): boolean

是否到达水平末端

Parameters

Parameter	Type
el	Target

Returns

boolean

---

setScrollLeft()

setScrollLeft(el, value): void

设置水平滚动距离

Parameters

Parameter	Type
el	Target
value	number

Returns

void

---

setScrollTop()

setScrollTop(el, value): void

设置垂直滚动距离

Parameters

Parameter	Type
el	Target
value	number

Returns

void

Interfaces

ScrollbarHelper

Properties

Property	Modifier	Type	Description
addScrollLeft	public	(value: number) => void	增加水平滚动距离
addScrollTop	public	(value: number) => void	增加垂直滚动距离
getScrollLeft	public	() => number	获取水平滚动位置
getScrollTop	public	() => number	获取垂直滚动位置
isReachBottom	public	() => boolean	是否到达垂直末端
isReachRight	public	() => boolean	是否到达水平末端
setScrollLeft	public	(value: number) => void	设置水平滚动距离
setScrollTop	public	(value: number) => void	设置垂直滚动距离
target	readonly	Target	目标元素