Skip to main content

Interface: ListScrollLocation

Describes the location of the list relative to the viewport and the scroll element.

Properties​

listOffset​

• listOffset: number

The distance between the list top edge and the viewport top edge. When the list is above the viewport (when scrolling down), this value is a negative number. When the list is scrolled to the top, this value is 0.

visibleListHeight​

• visibleListHeight: number

The height of the visible portion of the list without any headers and footers.

scrollHeight​

• scrollHeight: number

The scroll height of the scroller wrapper.

bottomOffset​

• bottomOffset: number

The distance between the scroller element bottom edge and the viewport botom edge. If 0, the list is at the bottom.

isAtBottom​

• isAtBottom: boolean

A convenience flag that indicates whether the list is at the bottom. The flag is also true when the list is currently scrolling to the bottom.