Class TurboDrawer<ViewType, DataType, ModelType, EMitterType>

TurboElement

Description

Base TurboElement class, extending the base HTML element with a few powerful tools and functions.

Type Parameters

ViewType extends TurboView = TurboView<any, any>
The element's view type, if initializing MVC.
DataType extends object = object
The element's data type, if initializing MVC.
ModelType extends TurboModel = TurboModel
The element's model type, if initializing MVC.
EMitterType extends TurboEmitter = TurboEmitter
The element's emitter type, if initializing MVC.

Hierarchy (View Summary)

TurboElement<ViewType, DataType, ModelType, EMitterType>
- TurboDrawer

Constructors

constructor

new TurboDrawer<
    ViewType extends
        TurboView<
            object,
            TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
            TurboEmitter<
                TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
            >,
        > = TurboView<
        any,
        any,
        TurboEmitter<
            TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
        >,
    >,
    DataType extends object = object,
    ModelType extends
        TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>> = TurboModel<
        any,
        any,
        any,
        "array"
        | "map",
        MvcDataBlock<any, any>,
    >,
    EMitterType extends
        TurboEmitter<
            TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
        > = TurboEmitter<
        TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
    >,
>(): TurboDrawer
Type Parameters
- ViewType extends TurboView<
      object,
      TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
      TurboEmitter<
          TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
      >,
  > = TurboView<
      any,
      any,
      TurboEmitter<
          TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
      >,
  >
- DataType extends object = object
- ModelType extends TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>> = TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>
- EMitterType extends TurboEmitter<TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>> = TurboEmitter<TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>>
Returns TurboDrawer
Inherited from TurboElement.constructor
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10156

Properties

`Protected`resizeObserver

resizeObserver: ResizeObserver

transition

transition: Reifect

selected

selected: boolean

Description

Whether the element is selected or not.

`Readonly`initialized

initialized: boolean

view

view: ViewType

Description

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

model

model: ModelType

Description

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

data

data: DataType

Description

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

dataId

dataId: string

Description

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

dataIndex

dataIndex: number

Description

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

`Readonly`dataSize

dataSize: number

Description

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

unsetDefaultClasses

unsetDefaultClasses: boolean

`Static` `Readonly`config

config: TurboElementConfig = ...

Description

Static configuration object.

`Protected`mvc

mvc: Mvc<
    TurboDrawer<ViewType, DataType, ModelType, EMitterType>,
    ViewType,
    DataType,
    ModelType,
    EMitterType,
> = ...

Description

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

`Readonly`onAttach

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

Description

Delegate fired when the element is attached to DOM.

`Readonly`onDetach

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

Description

Delegate fired when the element is detached from the DOM.

`Readonly`onAdopt

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

Description

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

Accessors

thumb

get thumb(): HTMLElement
Returns HTMLElement
- Defined in src/turboComponents/containers/drawer/drawer.ts:45
set thumb(value: HTMLElement | TurboProperties): void
Parameters
- value: HTMLElement | TurboProperties
Returns void
- Defined in src/turboComponents/containers/drawer/drawer.ts:40

panel

get panel(): HTMLElement
Returns HTMLElement
- Defined in src/turboComponents/containers/drawer/drawer.ts:57
set panel(value: HTMLElement | TurboProperties): void
Parameters
- value: HTMLElement | TurboProperties
Returns void
- Defined in src/turboComponents/containers/drawer/drawer.ts:52

icon

get icon(): | Element
| TurboIconSwitch<
    Side,
    TurboView<
        any,
        any,
        TurboEmitter<
            TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
        >,
    >,
    object,
    TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
    TurboEmitter<
        TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
    >,
>
Returns
    | Element
    | TurboIconSwitch<
        Side,
        TurboView<
            any,
            any,
            TurboEmitter<
                TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
            >,
        >,
        object,
        TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
        TurboEmitter<
            TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
        >,
    >
- Defined in src/turboComponents/containers/drawer/drawer.ts:76
set icon(
    _value:
        | string
        | Element
        | TurboIconSwitchProperties<Side>
        | TurboIconSwitch<
            Side,
            TurboView<
                any,
                any,
                TurboEmitter<
                    TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
                >,
            >,
            object,
            TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
            TurboEmitter<
                TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
            >,
        >,
): void
Parameters
- _value:
      | string
      | Element
      | TurboIconSwitchProperties<Side>
      | TurboIconSwitch<
          Side,
          TurboView<
              any,
              any,
              TurboEmitter<
                  TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
              >,
          >,
          object,
          TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
          TurboEmitter<
              TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
          >,
      >
Returns void
- Defined in src/turboComponents/containers/drawer/drawer.ts:72

hideOverflow

set hideOverflow(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/turboComponents/containers/drawer/drawer.ts:78

attachSideToIconName

set attachSideToIconName(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/turboComponents/containers/drawer/drawer.ts:82

rotateIconBasedOnSide

set rotateIconBasedOnSide(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/turboComponents/containers/drawer/drawer.ts:87

side

set side(value: Side): void
Parameters
- value: Side
Returns void
- Defined in src/turboComponents/containers/drawer/drawer.ts:97

offset

get offset(): PartialRecord<Open, number>
Returns PartialRecord<Open, number>
- Defined in src/turboComponents/containers/drawer/drawer.ts:114
set offset(value: number | PartialRecord<Open, number>): void
Parameters
- value: number | PartialRecord<Open, number>
Returns void
- Defined in src/turboComponents/containers/drawer/drawer.ts:112

isVertical

get isVertical(): boolean
Returns boolean
- Defined in src/turboComponents/containers/drawer/drawer.ts:116

open

set open(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/turboComponents/containers/drawer/drawer.ts:120

Methods

initialize

initialize(): void
initialize

Returns void
Description
Initializes the element.
Overrides TurboElement.initialize
- Defined in src/turboComponents/containers/drawer/drawer.ts:160

`Protected`setupUIElements

setupUIElements(): void
Protected
setupUIElements

Returns void
Description
Setup method intended to initialize all direct sub-elements attached to this element, and store them in fields.
Overrides TurboElement.setupUIElements
- Defined in src/turboComponents/containers/drawer/drawer.ts:182

`Protected`setupUILayout

setupUILayout(): void
Protected
setupUILayout

Returns void
Description
Setup method to create the layout structure of the element by adding all created sub-elements to this element's child tree.
Overrides TurboElement.setupUILayout
- Defined in src/turboComponents/containers/drawer/drawer.ts:187

`Protected`setupUIListeners

setupUIListeners(): void
Protected
setupUIListeners

Returns void
Description
Setup method to initialize and define all input/DOM event listeners of the element.
Overrides TurboElement.setupUIListeners
- Defined in src/turboComponents/containers/drawer/drawer.ts:197

getOppositeSide

getOppositeSide(side?: Side): Side
Parameters
- side: Side = ...
Returns Side
- Defined in src/turboComponents/containers/drawer/drawer.ts:243

getAdjacentSide

getAdjacentSide(side?: Side): Side
Parameters
- side: Side = ...
Returns Side
- Defined in src/turboComponents/containers/drawer/drawer.ts:256

refresh

refresh(): void
Returns void
- Defined in src/turboComponents/containers/drawer/drawer.ts:269

`Protected`getPropertiesValue

getPropertiesValue<Type>(
    propertiesValue: Type,
    configFieldName?: string,
    defaultValue?: Type,
): Type
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
Description
Returns the value with some fallback mechanisms on the static config field and a default value.
Inherited from TurboElement.getPropertiesValue
- Defined in src/turboElement/setup/default/default.types.ts:19

destroy

destroy(): void
Returns void
Inherited from TurboElement.destroy
- Defined in src/turboElement/setup/default/default.types.ts:21

`Static`configure

configure(value: TurboElementConfig): void
Parameters
- value: TurboElementConfig
  The object containing the new configurations.
Returns void
Description
Update the class's static configurations. Will only overwrite the set properties.
Inherited from TurboElement.configure
- Defined in src/turboElement/turboElement.ts:59

`Protected`setupChangedCallbacks

setupChangedCallbacks(): void
Protected
setupChangedCallbacks

Returns void
Description
Setup method intended to initialize change listeners and callbacks.
Inherited from TurboElement.setupChangedCallbacks
- Defined in src/turboElement/turboElement.ts:70

connectedCallback

connectedCallback(): void
Returns void
Inherited from TurboElement.connectedCallback
- Defined in src/turboElement/turboElement.ts:99

disconnectedCallback

disconnectedCallback(): void
Returns void
Inherited from TurboElement.disconnectedCallback
- Defined in src/turboElement/turboElement.ts:103

adoptedCallback

adoptedCallback(): void
Returns void
Inherited from TurboElement.adoptedCallback
- Defined in src/turboElement/turboElement.ts:107

Class TurboDrawer<ViewType, DataType, ModelType, EMitterType>

Description

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns TurboDrawer

Properties

ProtectedresizeObserver

transition

selected

Description

Readonlyinitialized

view

Description

model

Description

data

Description

dataId

Description

dataIndex

Description

ReadonlydataSize

Description

unsetDefaultClasses

Static Readonlyconfig

Description

Protectedmvc

Description

ReadonlyonAttach

Description

ReadonlyonDetach

Description

ReadonlyonAdopt

Description

Accessors

thumb

Returns HTMLElement

Parameters

Returns void

panel

Returns HTMLElement

Parameters

Returns void

icon

Parameters

Returns void

hideOverflow

Parameters

Returns void

attachSideToIconName

Parameters

Returns void

rotateIconBasedOnSide

Parameters

Returns void

side

Parameters

Returns void

offset

Returns PartialRecord<Open, number>

Parameters

Returns void

isVertical

Returns boolean

open

Parameters

Returns void

Methods

initialize

Returns void

Description

ProtectedsetupUIElements

`Protected`resizeObserver

`Readonly`initialized

`Readonly`dataSize

`Static` `Readonly`config

`Protected`mvc

`Readonly`onAttach

`Readonly`onDetach

`Readonly`onAdopt

`Protected`setupUIElements

`Protected`setupUILayout

`Protected`setupUIListeners

`Protected`getPropertiesValue

`Static`configure

`Protected`setupChangedCallbacks