Interface OpenableTriggerConfig

Per-trigger based configuration. Can either be given as an object as the value of the OpenableProperties.triggers map, or it can be set as a string configuration in the data-lisn-<name>-trigger data attribute. See getWidgetConfig for the syntax.

Example

<div data-lisn-collapsible-trigger="auto-close
                                    | icon=right
                                    | icon-closed=arrow-down
                                    | icon-open=x"
></div>
interface OpenableTriggerConfig {
    autoClose?: boolean;
    className?: string | string[];
    hover?: boolean;
    icon?: false | Offset;
    iconClosed?:
        | "arrow-left"
        | "arrow-right"
        | "arrow-up"
        | "arrow-down"
        | "plus";
    iconOpen?: | "x"
    | "arrow-left"
    | "arrow-right"
    | "arrow-up"
    | "arrow-down"
    | "minus";
    id?: string;
    preventDefault?: boolean;
}

Properties

autoClose? className? hover? icon? iconClosed? iconOpen? id? preventDefault?

Properties

OptionalautoClose

autoClose?: boolean

Override the widget's OpenableProperties.autoClose for this trigger.

Default Value

undefined // Widget default

OptionalclassName

className?: string | string[]

Class name(s) for the trigger. Will result in the trigger element, which could be a wrapper around the original element you passed, getting these classes.

Default Value

undefined

Optionalhover

hover?: boolean

Open the openable when this trigger is hovered.

If the device is touch and OpenableProperties.autoClose is enabled, the widget will be closed shortly after the pointer leaves both the trigger and the root element.

Default Value

false

Optionalicon

icon?: false | Offset

Override the widget's CollapsibleConfig.icon for this trigger.

Currently only relevant for Collapsibles.

Default Value

undefined // Widget default

OptionaliconClosed

iconClosed?: "arrow-left" | "arrow-right" | "arrow-up" | "arrow-down" | "plus"

Override the widget's CollapsibleConfig.iconClosed for this trigger.

Currently only relevant for Collapsibles.

Default Value

undefined // Widget default

OptionaliconOpen

iconOpen?:
    | "x"
    | "arrow-left"
    | "arrow-right"
    | "arrow-up"
    | "arrow-down"
    | "minus"

Override the widget's CollapsibleConfig.iconOpen for this trigger.

Currently only relevant for Collapsibles.

Default Value

undefined // Widget default

Optionalid

id?: string

The DOM ID of the trigger. Will result in the trigger element, which could be a wrapper around the original element (as in the case of Collapsible you passed, getting this ID.

IMPORTANT: If the trigger element already has an ID and is not being wrapped, then this will override the ID and it won't be restored on destroy.

Default Value

undefined

OptionalpreventDefault

preventDefault?: boolean

Whether to prevent default click action.

Default Value

true

Settings

Member Visibility

On This Page

Properties