Class OpenableAbstract

Openable is an abstract base class. You should not directly instantiate it but can inherit it to create your own custom openable widget.

IMPORTANT: You should not instantiate more than one Openable widget, regardless of type, on a given element. Use Openable.get to get an existing instance if any. If there is already an Openable widget of any type on this element, it will be destroyed!

See

registerOpenable

Hierarchy (View Summary)

Methods

get

Constructors

constructor

Properties

close destroy disable enable getContainer getElement getRoot getTriggerConfigs getTriggers isDestroyed isDisabled isOpen onClose onDestroy onDisable onEnable onOpen open toggle toggleEnable

Methods

Staticget

  • get(element: Element): null | Openable

    Retrieve an existing widget by its content element or any of its triggers.

    If the element is already part of a configured Openable widget, the widget instance is returned. Otherwise null.

    Note that trigger elements are not guaranteed to be unique among openable widgets as the same element can be a trigger for multiple such widgets. If the element you pass is a trigger, then the last openable widget that was created for it will be returned.

    Parameters

    • element: Element

    Returns null | Openable

Constructors

constructor

Properties

Readonlyclose

close: () => Promise<void>

Closes the widget.

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.

ReadonlygetContainer

getContainer: () => null | HTMLElement

Returns the element that was found to be the container. It is the closest ancestor that has a lisn-collapsible-container class, or if no such ancestor then the immediate parent of the content element.

ReadonlygetElement

getElement: () => Element

Returns the element passed to the widget constructor.

ReadonlygetRoot

getRoot: () => HTMLElement

Returns the root element created by us that wraps the original content element passed to the constructor. It is located in the content element's original place.

ReadonlygetTriggerConfigs

getTriggerConfigs: () => Map<Element, OpenableTriggerConfig>

Returns the trigger elements along with their configuration.

ReadonlygetTriggers

getTriggers: () => Element[]

Returns the trigger elements, if any. Note that these may be wrappers around the original triggers passed.

ReadonlyisDestroyed

isDestroyed: () => boolean

Returns true if the widget is destroyed.

ReadonlyisDisabled

isDisabled: () => boolean

Returns true if the widget is currently disabled.

ReadonlyisOpen

isOpen: () => boolean

Returns true if the widget is currently open.

ReadonlyonClose

onClose: (handler: WidgetHandler) => void

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

If it returns a promise, it will be awaited upon.

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.

ReadonlyonOpen

onOpen: (handler: WidgetHandler) => void

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

If it returns a promise, it will be awaited upon.

Readonlyopen

open: () => Promise<void>

Opens the widget unless it is disabled.

Readonlytoggle

toggle: () => Promise<void>

Closes the widget if it is open, or opens it if it is closed (unless it is disabled).

ReadonlytoggleEnable

toggleEnable: () => Promise<void>

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

Settings

Member Visibility

On This Page

Methods
Constructors
Properties