Teal TealUI

滚动web/scroll

控制元素的滚动条。

API

函数 描述
⮞ scrollTo(elem, value, ...)(elem:Element | Document, value:Partial<Point>, duration?:number, callback?:function):void

滚动元素到指定的位置。

参数 类型 描述 默认值
elem* Element | Document —
value* Partial<Point> —
duration number 200
callback (value: Point) => void —

返回值

类型：void

示例

scrollTo(document, {y: 400})

滚动元素到指定的位置。
⮞ scrollBy(elem, value, ...)(elem:Element | Document, value:Partial<Point>, duration?:number, callback?:function):void

滚动元素指定的偏移量。

参数 类型 描述 默认值
elem* Element | Document —
value* Partial<Point> —
duration number —
callback (value: Point) => void —

返回值

类型：void

示例

scrollBy(document, {y: 400})

滚动元素指定的偏移量。
⮞ scrollSize(elem)(elem:Element | Document):Size

获取元素的滚动区域大小。

参数 类型 描述 默认值
elem* Element | Document —

返回值

类型：Size

返回一个大小。

示例

scrollSize(document.body)

获取元素的滚动区域大小。
⮞ isScrollIntoView(elem, ...)(elem:Element | Document, scrollable?:Element | Document, padding?:number):boolean

判断指定元素是否在可见区域内。

参数 类型 描述 默认值
elem* Element | Document —
scrollable Element | Document scrollParent(elem)
padding number 0

返回值

类型：boolean

如果元素部分或全部在可见区域内则返回 true，否则返回 false。

示例

isScrollIntoView(document.body)

判断指定元素是否在可见区域内。
⮞ scrollIntoView(elem, ...)(elem:Element | Document, position?:ScrollLogicalPosition, scrollable?:Element | Document, duration?:number, offset?:number, callback?:function):void

将元素滚动到可见区域。

参数 类型 描述 默认值
elem* Element | Document —
position ScrollLogicalPosition —
scrollable Element | Document scrollParent(elem)
duration number —
offset number 0
callback (value: Point) => void —

返回值

类型：void

将元素滚动到可见区域。
⮞ scrollIntoViewIfNeeded(elem, ...)(elem:Element | Document, scrollable?:Element | Document, duration?:number, padding?:number, offset?:number, callback?:function):void

如果元素可见区域内则将元素滚动到可见区域。

参数 类型 描述 默认值
elem* Element | Document —
scrollable Element | Document scrollParent(elem)
duration number —
padding number 0
offset number 0
callback (value: Point) => void —

返回值

类型：void

示例

scrollIntoViewIfNeeded(document.body)

如果元素可见区域内则将元素滚动到可见区域。
⮞ scrollShow(elem, callback, ...)(elem:Element | Document, callback:function, once?:boolean, scrollable?:Element | Document, padding?:number):void

设置滚动到当前指定元素或文档时的回调。

参数 类型 描述 默认值
elem* Element | Document —
callback* () => void —
once boolean true
scrollable Element | Document scrollParent(elem)
padding number 0

返回值

类型：void

示例

scrollShow(document.body, () => { alert("hi"); })

设置滚动到当前指定元素或文档时的回调。
⮞ scrollParent(elem)(elem:Element | Document):Element | Document

获取指定元素第一个可滚动的父元素。

参数 类型 描述 默认值
elem* Element | Document —

返回值

类型：Element | Document

返回父元素。

获取指定元素第一个可滚动的父元素。