Module Triggers

Specification for the HTML API for triggers

The following describes the general syntax when using the HTML API and automatic widgets (settings.autoWidgets is true) specifically for triggers and actions.

A trigger specification should be given as a data-lisn-on-<TriggerName>="<TriggerSpecList>" attribute. A fallback option of using a CSS class of the form lisn-on-<TriggerName>--<TriggerSpec> is also supported but not recommended.

The general specification for a trigger is of the form:

<TriggerSpecList> ::= <TriggerSpec> { ";" <TriggerSpec> }

<TriggerSpec> ::= [ <TriggerArg> { "," <TriggerArg> } ]
                  "@" <ActionSpec> { "@" <ActionSpec> }
                  { "+" <TriggerOption> }

<TriggerOption> ::=
    <BooleanOptionName> [ "=" ( "false" | "true" ) ] |
    <OptionName> "=" <OptionValue>

<ActionSpec> ::= <ActionName> [ ":" <ActionArgOrOption> { "," <ActionArgOrOption> } ]

<ActionArgOrOption> ::= <ActionArg> | <OptionName> "=" <OptionValue>
Copy

where <TriggerArg> is the particular trigger's main argument, which could be required or optional (and not all triggers accept an argument). See each trigger's specification for their arguments and options.

Also refer to each action for their accepted arguments and/or options if any.

NOTE:

There can be 0 or more spaces around any of the separator characters.

At least one action (with a preceding "@" character) is always required.

The characters ";", ",", "=", "@", "+" and ":" are reserved separators and cannot be used literally as part of an argument or option value.