Class CheckTrigger

CheckTrigger allows you to run actions when the user checks a target checkbox input element, and undo those actions when they uncheck the checkbox.

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

Example

Add classes active and checked when the user checks the checkbox, remove them when unchecked.

<input type="checkbox" data-lisn-on-check="@add-class: active,checked"/>

Example

As above, but using a CSS class instead of data attribute:

<input type="checkbox" class="lisn-on-check--@add-class: active,checked"/>

Example

Play the animations on the element each time the user checks the next element with class checkbox (do nothing when it's unchecked).

<div data-lisn-on-check="@animate +one-way +target=next.checkbox"></div>
<input type="checkbox" class="checkbox"/>

Example

Add class used the first time the user checks the next element with class checkbox, and play or reverse the animations 200ms after each time the user toggles the reference checkbox.

<div data-lisn-on-check="@add-class: used +once ;
                         @animate +delay=200 +target=next.checkbox"
></div>
<input type="checkbox" class="checkbox"/>

Example

When the user checks the next element with class checkbox then add classes c1 and c2 to the element (that the trigger is defined on) and enable trigger my-trigger defined on this same element; undo all of that when the user unchecks the reference checkbox.

<div data-lisn-on-check="@add-class: c1,c2 @enable: my-trigger +target=next.checkbox"
     data-lisn-on-run="@show +id=my-trigger"
></div>
<input type="checkbox" class="checkbox"/>

Example

As above, but using data-lisn-ref attribute instead of class selector.

<div data-lisn-on-check="@add-class: c1,c2 @enable: my-trigger +target=next-checkbox"
     data-lisn-on-run="@show +id=my-trigger"
></div>
<input type="checkbox" data-lisn-ref="checkbox"/>

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: () => CheckTriggerConfig

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