Class ScrollListener

The ScrollListener class sets up a listener that handles element scroll events.

Index

Constructors

Properties

active callback element ticking

Methods

loop start stop update

Constructors

constructor

new ScrollListener(
callback: (top: number) => void,
element?: Element | Window,
): ScrollListener
Parameters
- callback: (top: number) => void
  The callback to run when the scroll position changes.
- element: Element | Window = window
  The element to listen for scroll events on. Defaults to window.
Returns ScrollListener
- Defined in flarum/framework/core/js/src/common/utils/ScrollListener.js:12

Properties

active

active: (() => void) | null | undefined

Type Declaration

() => void
- - (): void
  - Protected
    On each animation frame, as long as the listener is active, run the update method.
    
    Returns void
null
undefined

callback

callback: (top: number) => void

element

element: Element | Window

ticking

ticking: boolean

Methods

`Protected`loop

loop(): void
Protected
On each animation frame, as long as the listener is active, run the update method.

Returns void
- Defined in flarum/framework/core/js/src/common/utils/ScrollListener.js:24

start

start(): void
Start listening to and handling the element's scroll position.

Returns void
- Defined in flarum/framework/core/js/src/common/utils/ScrollListener.js:49

stop

stop(): void
Stop listening to and handling the element's scroll position.

Returns void
- Defined in flarum/framework/core/js/src/common/utils/ScrollListener.js:58

update

update(): void
Run the callback, whether there was a scroll event or not.

Returns void
- Defined in flarum/framework/core/js/src/common/utils/ScrollListener.js:42