External module "scroll/util"

Index

Type aliases

HTMLElementEventMapKey

Variables

Functions

Type aliases

HTMLElementEventMapKey

HTMLElementEventMapKey: keyof HTMLElementEventMap | "DOMMouseScroll" | "mousewheel"

Variables

Const SUPPORTS_PASSIVE

SUPPORTS_PASSIVE: boolean = _supportsPassive

Let _supportsPassive

_supportsPassive: boolean = false

Functions

$

$(selectorOrElement: string | Element): HTMLElement | null

- Defined in scroll/util.ts:36
Parameters
- selectorOrElement: string | Element
Returns HTMLElement | null

cumulativeOffset

cumulativeOffset(element: Element): object

- Defined in scroll/util.ts:42
Parameters
- element: Element
Returns object
- left: number
- top: number

error

error(message: string): Error

- Defined in scroll/util.ts:97
Parameters
- message: string
Returns Error

getContainerDimension

getContainerDimension(el: Element): object

- Defined in scroll/util.ts:19
Parameters
- el: Element
Returns object
- height: number
- width: number

isBodyElement

isBodyElement(el: Element): boolean

- Defined in scroll/util.ts:15
Parameters
- el: Element
Returns boolean

off

off(element: Element, events: HTMLElementEventMapKey | HTMLElementEventMapKey[], handler: EventListenerOrEventListenerObject): void

- Defined in scroll/util.ts:80
Parameters
- element: Element
- events: HTMLElementEventMapKey | HTMLElementEventMapKey[]
- handler: EventListenerOrEventListenerObject
Returns void

on

on(element: Element, events: HTMLElementEventMapKey | HTMLElementEventMapKey[], handler: EventListenerOrEventListenerObject, opts?: object): void

- Defined in scroll/util.ts:64
Parameters
- element: Element
- events: HTMLElementEventMapKey | HTMLElementEventMapKey[]
- handler: EventListenerOrEventListenerObject
- Default value opts: object = { passive: false }
  - passive: boolean
Returns void

warn

warn(message: string): void

- Defined in scroll/util.ts:91
Parameters
- message: string
Returns void

Generated using TypeDoc