Class LoadTrigger

LoadTrigger allows you to run actions one when the page is loaded.

To use with auto-widgets (HTML API), see registerTrigger for the specification.

  • Arguments: none
  • Additional trigger options: none

Example

Scroll to the given element when the page is loaded:

<div data-lisn-on-load="@scroll-to"></div>

Example

Scroll to 100px above the given element 500ms after the page is loaded:

<div data-lisn-on-load="@scroll-to: offsetY=-100 +delay=500"></div>

Example

Scroll to 100px above the given element 500ms after the page is loaded, and play animations defined on it 500ms later (1000ms after it's loaded):

<div data-lisn-on-load="@scroll-to: offsetY=-100 +delay=500 ;
                        @animate +delay=1000"
></div>

Hierarchy (View Summary)

Methods

get register

Constructors

constructor

Properties

destroy disable enable getActions getConfig getElement isDestroyed isDisabled onDestroy onDisable onEnable reverse run toggle toggleEnable

Methods

Staticget

Staticregister

Constructors

constructor

Properties

Readonlydestroy

destroy: () => Promise<void>

Undoes all modifications to the element and returns it to its original state.

You will need to recreate it if you want to enable its functionality again.

Readonlydisable

disable: () => Promise<void>

Disables the functionality of the widget. What this means is specific to each widget.

Readonlyenable

enable: () => Promise<void>

Re-enables the functionality of the widget. What this means is specific to each widget.

ReadonlygetActions

getActions: () => Action[]

Returns the trigger's actions.

ReadonlygetConfig

getConfig: () => TriggerConfig

Returns the trigger config.

ReadonlygetElement

getElement: () => Element

Returns the element passed to the widget constructor.

ReadonlyisDestroyed

isDestroyed: () => boolean

Returns true if the widget is destroyed.

ReadonlyisDisabled

isDisabled: () => boolean

Returns true if the widget is currently disabled.

ReadonlyonDestroy

onDestroy: (handler: WidgetHandler) => void

The given handler will be called when the widget is destroyed.

ReadonlyonDisable

onDisable: (handler: WidgetHandler) => void

The given handler will be called when the widget is disabled.

ReadonlyonEnable

onEnable: (handler: WidgetHandler) => void

The given handler will be called when the widget is enabled.

Readonlyreverse

reverse: () => Promise<void>

"Undo"es all the Actions linked to the trigger.

Readonlyrun

run: () => Promise<void>

"Do"es all the Actions linked to the trigger.

Readonlytoggle

toggle: () => Promise<void>

"Toggle"s all the Actions linked to the trigger.

ReadonlytoggleEnable

toggleEnable: () => Promise<void>

Re-enables the widget if disabled, otherwise disables it.

Settings

Member Visibility

On This Page

Methods
Constructors
Properties