Class ScrollListener

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

Hierarchy

ScrollListener

Index

Constructors

Properties

active callback ticking

Methods

loop start stop update

Constructors

constructor

new ScrollListener(callback): ScrollListener
Parameters
- callback: ((top) => void)
  
  The callback to run when the scroll position changes.
  - - (top): void
    - Parameters
      
      top: number
      
      Returns void
Returns ScrollListener
- Defined in framework/core/js/src/common/utils/ScrollListener.js:10

Properties

active

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

Type declaration

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

callback

callback: ((top) => void)

Type declaration

- (top): void
- Parameters
  - top: number
  Returns void

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 framework/core/js/src/common/utils/ScrollListener.js:21

start

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

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

stop

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

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

update

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

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

Generated using TypeDoc v0.24.8