Class ScrollListener

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

Hierarchy

ScrollListener

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ScrollListener(callback: (top: number) => void): ScrollListener

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

Properties

active

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

callback

callback: (top: number) => void

Type declaration

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

ticking

ticking: boolean

Methods

Protected loop

loop(): void

- Defined in src/common/utils/ScrollListener.js:21
On each animation frame, as long as the listener is active, run the update method.

Returns void

start

start(): void

- Defined in src/common/utils/ScrollListener.js:46
Start listening to and handling the window's scroll position.

Returns void

stop

stop(): void

- Defined in src/common/utils/ScrollListener.js:55
Stop listening to and handling the window's scroll position.

Returns void

update

update(): void

- Defined in src/common/utils/ScrollListener.js:39
Run the callback, whether there was a scroll event or not.

Returns void

Generated using TypeDoc version 0.22.10