Module Widgets

Specification for the HTML API for widgets

The following describes the general syntax when using the HTML API for automatic creation of widgets based on data attributes settings.autoWidgets must be true.

A widget specification should be given as a data-lisn-<WidgetName>="<WidgetConfList>" attribute.

Alternatively, if using all default configurations, you can simply add the lisn-<WidgetName> CSS class. Specifying a configuration using CSS classes is not currently possible for widgets, only for triggers (though it's discouraged).

The general specification for a widget is of the form:

<WidgetConfList> ::= <WidgetConf> { ";" <WidgetConf> }

<WidgetConf> ::= [ <WidgetOption> { "|" <WidgetOption> } ]

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

NOTE:

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

Not all widgets support multiple instances per single element and therefore multiple configurations. Refer to each specific widget.

The characters |, ;, = are reserved separators and cannot be used literally as part of an option value.

See documentation on a specific widget for examples.