Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Options<E>

Type parameters

  • E: HTMLElement = HTMLElement

Hierarchy

  • Options

Index

Properties

Optional element

element: null | E

The element that should gain the focus event. When this is omitted, it will default to the entire window.

Optional enabled

enabled: boolean

Boolean if the scroll listener should be enabled. You can swap this boolean to true or false to add/remove the event listeners. The event listeners will always be removed when the parent component is unmounted though.

onScroll

onScroll: EventListener

A function that is called whenever the scroll event is triggered.

Optional options

options: boolean | AddEventListenerOptions

Any event listener options to use when attaching the event.

Generated using TypeDoc