getScrollSize

Commons
stable

Returns the scrollWidth or scrollHeight of an element depending on the axis. Returns 0 when the element is undefined. Used by SlideGroup to determine total scrollable content size.

API

Signature

Full TypeScript signature sourced from the util file.

typescript

API

Parameters

Input parameters accepted by this util.

isHorizontal
required
boolean
When true, reads scrollWidth; when false, reads scrollHeight.
element
HTMLElement
The scroll container element. Returns 0 when omitted.

API

Return value

The value returned by this util.

The full scrollable content size in pixels along the selected axis, or 0 if the element is absent.

Usage

Examples

Ready-to-paste usage snippets.

Compute whether scroll arrows should be shown

typescript