Skip to main content

ScrollTrigger.maxScroll

ScrollTrigger.maxScroll( scroller:Element | window, horizontal:Boolean ) : Number

A utility function for getting the maximum scroll value for a particular element/scroller. For example, if the element/scroller is 500px tall and contains 800px of content, maxScroll() would return 300.

Parameters

  • scroller: Element | window

    The element whose maximum scroll should be returned

  • horizontal: Boolean

    By default, vertical scrolling is assumed, but if you'd like to find the maximum horizontal scroll, set horizontal to true

Returns : Number​

The maximum scroll value (in pixels)

Details​

A utility function for getting the maximum scroll value for a particular element/scroller. For example, if the element/scroller is 500px tall and contains 800px of content, maxScroll() would return 300.

Contents