turbodombuilder - v0.9.66
    Preparing search index...

    Class TurboIconSwitch<State, ViewType, DataType, ModelType, EmitterType>

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    customLoaders defaultProperties onLoaded type directory properties selected initialized defaultFeedforwardProperties view model emitter data dataId dataIndex dataSize operators handlers interactors tools enforcers unsetDefaultClasses shadowDOM defaultSelectedClasses defaultClasses onAttach onDetach onAdopt tagName

    Accessors

    path icon iconColor switchReifect defaultState appendStateToIconName

    Methods

    loadSvg loadImg updateColor generateIcon initialize destroy feedforward clone create customCreate setupChangedCallbacks setupUIElements setupUILayout setupUIListeners connectedCallback disconnectedCallback adoptedCallback

    Constructors

    Properties

    customLoaders: Record<string, (path: string) => Element | Promise<Element>> = {}
    defaultProperties: Partial<TurboIconProperties> = ...

    Default properties assigned to a new instance.

    onLoaded: (element: Element) => void
    type: string

    The type of the icon.

    directory: string

    The user-provided (or statically configured) directory to the icon's file.

    properties: TurboIconSwitchProperties<any>
    selected: boolean

    Whether the element is selected or not.

    initialized: boolean

    Whether the element was initialized already or not.

    defaultFeedforwardProperties: TurboElementProperties
    view: ViewType

    The view (if any) of the element.

    model: ModelType

    The model (if any) of the element.

    emitter: TurboEmitter

    The emitter (if any) of the element.

    data: DataType

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

    dataId: string

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

    dataIndex: number

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

    dataSize: number

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

    operators: TurboOperator<
        object,
        TurboView<
            any,
            any,
            TurboEmitter<TurboModel<any, any, any, any, any>, KeyType>,
        >,
        TurboModel<any, any, any, any, any>,
        TurboEmitter<TurboModel<any, any, any, any, any>, KeyType>,
    >[]

    The operators (if any) attached to the element's MVC structure.

    handlers: TurboHandler<TurboModel<any, any, any, any, any>>[]

    The handlers (if any) attached to the element's model. Returns an empty array if no model is set.

    interactors: TurboInteractor<
        object,
        TurboView<
            any,
            any,
            TurboEmitter<TurboModel<any, any, any, any, any>, KeyType>,
        >,
        TurboModel<any, any, any, any, any>,
        TurboEmitter<TurboModel<any, any, any, any, any>, KeyType>,
    >[]

    The interactors (if any) attached to the element's MVC structure.

    tools: TurboTool<
        object,
        TurboView<
            any,
            any,
            TurboEmitter<TurboModel<any, any, any, any, any>, KeyType>,
        >,
        TurboModel<any, any, any, any, any>,
        TurboEmitter<TurboModel<any, any, any, any, any>, KeyType>,
    >[]

    The tools (if any) attached to the element's MVC structure.

    enforcers: TurboEnforcer<
        object,
        TurboView<
            any,
            any,
            TurboEmitter<TurboModel<any, any, any, any, any>, KeyType>,
        >,
        TurboModel<any, any, any, any, any>,
        TurboEmitter<TurboModel<any, any, any, any, any>, KeyType>,
    >[]

    The enforcers (if any) attached to the element's MVC structure.

    unsetDefaultClasses: boolean

    Whether to set the default CSS classes defined in the static config on the element or not. Setting it will accordingly add/remove the CSS classes from the element.

    shadowDOM: boolean
    defaultSelectedClasses: string | string[]
    defaultClasses: string | string[]
    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.

    tagName: string

    Accessors

    • get path(): string

      Returns string

      The path to the icon's source file.

    • set icon(value: string): void

      Parameters

      • value: string

      Returns void

      The name (or path) of the icon. Might include the file extension (to override the icon's type). Setting it will update the icon accordingly.

    • get iconColor(): Color

      Returns Color

      The assigned color to the icon (if any)

    • set iconColor(value: string | Color): void

      Parameters

      Returns void

    • set defaultState(value: State): void

      Parameters

      Returns void

    • set appendStateToIconName(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    Methods

    • Parameters

      Returns void

    • Returns void

    • Function

      initialize

      Returns void

      Initializes the element. It sets up the UI by calling the methods setupUIElements, setupUILayout, setupUIListeners, and setupChangedCallbacks (in this order, if they are defined). This function is called automatically in .setProperties() and when instantiating an element via element(). It is called only once per element (as it checks with the reflected initialized flag).

    • Function

      destroy

      Returns this

      Itself, allowing for method chaining.

      Destroys the node by removing it from the document and removing all its bound listeners.

    • Parameters

      • properties: object

      Returns object

    • Protected Function

      setupChangedCallbacks

      Returns void

      Setup method intended to initialize change listeners and callbacks. Called on initialize().

    • Protected Function

      setupUIElements

      Returns void

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

    • Protected Function

      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. Called on initialize().

    • Protected Function

      setupUIListeners

      Returns void

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

    • Function

      connectedCallback

      Returns void

      function called when the element is attached to the DOM.

    • Function

      disconnectedCallback

      Returns void

      function called when the element is detached from the DOM.

    • Function

      adoptedCallback

      Returns void

      function called when the element is adopted by a new parent in the DOM.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods