turbodombuilder - v0.9.5
    Preparing search index...

    Class TurboDropdown<ValueType, SecondaryValueType, EntryType, ViewType, DataType, ModelType, EmitterType>

    Dropdown class for creating Turbo button elements. TurboDropdown

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    config customSelectorTag entries values select selected initialized view model data dataId dataIndex dataSize unsetDefaultClasses mvc onAttach onDetach onAdopt

    Accessors

    customSelectorClasses customPopupClasses selector popup selectedValues selectedValue selectedSecondaryValues selectedSecondaryValue stringSelectedValue

    Methods

    connectedCallback getPropertiesValue destroy initialize configure setupChangedCallbacks setupUIElements setupUILayout setupUIListeners disconnectedCallback adoptedCallback

    Constructors

    Properties

    config: TurboDropdownConfig = ...

    Static configuration object.

    customSelectorTag: keyof HTMLElementTagNameMap
    entries: HTMLCollection | NodeList | EntryType[]
    values: ValueType[]
    select: TurboSelect<ValueType, SecondaryValueType, EntryType> = ...
    selected: boolean

    Whether the element is selected or not.

    initialized: boolean
    view: ViewType

    The view (if any) of the element. Only when initializing MVC.

    model: ModelType

    The model (if any) of the element. Only when initializing MVC.

    data: DataType

    The main data block (if any) attached to the element, taken from its model (if any). Only when initializing MVC.

    dataId: string

    The ID of the main data block (if any) of the element, taken from its model (if any). Only when initializing MVC.

    dataIndex: number

    The numerical index of the main data block (if any) of the element, taken from its model (if any). Only when initializing MVC.

    dataSize: number

    The size (number) of the main data block (if any) of the element, taken from its model (if any). Only when initializing MVC.

    unsetDefaultClasses: boolean
    mvc: Mvc<
        TurboDropdown<
            ValueType,
            SecondaryValueType,
            EntryType,
            ViewType,
            DataType,
            ModelType,
            EmitterType,
        >,
        ViewType,
        DataType,
        ModelType,
        EmitterType,
    > = ...

    The MVC handler of the element. If initialized, turns the element into an MVC structure.

    onAttach: Delegate<() => void> = ...

    Delegate fired when the element is attached to DOM.

    onDetach: Delegate<() => void> = ...

    Delegate fired when the element is detached from the DOM.

    onAdopt: Delegate<() => void> = ...

    Delegate fired when the element is adopted by a new parent in the DOM.

    Accessors

    • set customSelectorClasses(value: string | string[]): void

      Parameters

      • value: string | string[]

      Returns void

    • set customPopupClasses(value: string | string[]): void

      Parameters

      • value: string | string[]

      Returns void

    • get selector(): HTMLElement

      Returns HTMLElement

    • set selector(value: string | HTMLElement): void

      The dropdown's selector element.

      Parameters

      Returns void

    • set popup(value: HTMLElement): void

      The dropdown's popup element.

      Parameters

      Returns void

    • get selectedValues(): ValueType[]

      Returns ValueType[]

    • get selectedValue(): ValueType

      Returns ValueType

    • get stringSelectedValue(): string

      Returns string

    Methods

    • Protected

      getPropertiesValue

      Type Parameters

      • Type

      Parameters

      • propertiesValue: Type

        The actual value; could be null.

      • OptionalconfigFieldName: string

        The field name of the associated value in the static config. Will be returned if the actual value is null.

      • OptionaldefaultValue: Type

        The default fallback value. Will be returned if both the actual and config values are null.

      Returns Type

      Returns the value with some fallback mechanisms on the static config field and a default value.

    • Returns void

    • initialize

      Returns void

      Initializes the element.

    • Parameters

      Returns void

      Update the class's static configurations. Will only overwrite the set properties.

    • Protected

      setupChangedCallbacks

      Returns void

      Setup method intended to initialize change listeners and callbacks.

    • Protected

      setupUIElements

      Returns void

      Setup method intended to initialize all direct sub-elements attached to this element, and store them in fields.

    • Protected

      setupUILayout

      Returns void

      Setup method to create the layout structure of the element by adding all created sub-elements to this element's child tree.

    • Protected

      setupUIListeners

      Returns void

      Setup method to initialize and define all input/DOM event listeners of the element.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods