getScrollParent

Functions

getScrollParent()

getScrollParent(start, type, end): undefined | Element

获取可滚动的父元素

Parameters

Parameter	Type	Default value	Description
start	MaybeNullish<Element>	undefined	起点元素
type	ScrollType	'both'	滚动类型
end	ScrollElement	undefined	终点元素

Returns

undefined | Element

Example

// 获取 x 轴方向的可滚动父元素
getScrollParent(element, 'x', document.documentElement)

// 获取 y 轴方向的可滚动父元素
getScrollParent(element, 'y', document.documentElement)

// 获取任意轴方向的可滚动父元素
getScrollParent(element, 'both', document.documentElement)

Type Aliases

ScrollElement

ScrollElement: Element | Window

---

ScrollType

ScrollType: "x" | "y" | "both"