Class TurboSelect<ValueType, SecondaryValueType, EntryType>

TurboSelect

Description

Base class for creating a selection menu

Type Parameters

ValueType = string
SecondaryValueType = string
EntryType extends object = HTMLElement

Hierarchy (View Summary)

TurboBaseElement
- TurboSelect

Constructors

constructor

new TurboSelect<
    ValueType = string,
    SecondaryValueType = string,
    EntryType extends object = HTMLElement,
>(
    properties?: TurboSelectProperties<
        ValueType,
        SecondaryValueType,
        EntryType,
    >,
): TurboSelect<ValueType, SecondaryValueType, EntryType>
Type Parameters
- ValueType = string
- SecondaryValueType = string
- EntryType extends object = HTMLElement
Parameters
- properties: TurboSelectProperties<ValueType, SecondaryValueType, EntryType> = {}
  Properties for configuring the dropdown.
Returns TurboSelect<ValueType, SecondaryValueType, EntryType>
Description
Dropdown constructor
Overrides TurboBaseElement.constructor
- Defined in src/turboComponents/basics/select/select.ts:173

Properties

`Static` `Readonly`config

config: TurboSelectConfig = ...

Description

Static configuration object.

`Readonly`onSelectDelegate

onSelectDelegate: Delegate<
(b: boolean, entry: EntryType, index: number) => void,
> = ...

`Readonly`onEnabledDelegate

onEnabledDelegate: Delegate<
(b: boolean, entry: EntryType, index: number) => void,
> = ...

getValue

getValue: (entry: EntryType) => ValueType

getSecondaryValue

getSecondaryValue: (entry: EntryType) => SecondaryValueType

createEntry

createEntry: (value: ValueType) => EntryType

onEntryAdded

onEntryAdded: (entry: EntryType, index: number) => void

onEntryRemoved

onEntryRemoved: (entry: EntryType) => void

forceSelection

forceSelection: boolean

selectedEntryClasses

selectedEntryClasses: string | string[]

selected

selected: boolean

Description

Whether the element is selected or not.

`Readonly`initialized

initialized: boolean

Description

Whether the element was initialized already or not.

Accessors

entries

get entries(): EntryType[]
The dropdown's entries.

Returns EntryType[]
- Defined in src/turboComponents/basics/select/select.ts:41
set entries(value: HTMLCollection | NodeList | EntryType[]): void
Parameters
- value: HTMLCollection | NodeList | EntryType[]
Returns void
- Defined in src/turboComponents/basics/select/select.ts:45

values

get values(): ValueType[]
Returns ValueType[]
Description
The dropdown's values. Setting it will update the dropdown accordingly.
- Defined in src/turboComponents/basics/select/select.ts:71
set values(values: ValueType[]): void
Parameters
- values: ValueType[]
Returns void
- Defined in src/turboComponents/basics/select/select.ts:75

selectedEntries

get selectedEntries(): EntryType[]
Returns EntryType[]
- Defined in src/turboComponents/basics/select/select.ts:85
set selectedEntries(value: EntryType[]): void
Parameters
- value: EntryType[]
Returns void
- Defined in src/turboComponents/basics/select/select.ts:89

parent

set parent(value: Element): void
Parameters
- value: Element
Returns void
- Defined in src/turboComponents/basics/select/select.ts:95

inputName

get inputName(): string
The dropdown's underlying hidden input. Might be undefined.

Returns string
- Defined in src/turboComponents/basics/select/select.ts:132
set inputName(value: string): void
Parameters
- value: string
Returns void
- Defined in src/turboComponents/basics/select/select.ts:136

inputField

get inputField(): HTMLInputElement
Returns HTMLInputElement
- Defined in src/turboComponents/basics/select/select.ts:145

multiSelection

set multiSelection(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/turboComponents/basics/select/select.ts:149

onSelect

set onSelect(value: (b: boolean, entry: EntryType, index: number) => void): void
Parameters
- value: (b: boolean, entry: EntryType, index: number) => void
Returns void
- Defined in src/turboComponents/basics/select/select.ts:155

onEnabled

set onEnabled(
value: (b: boolean, entry: EntryType, index: number) => void,
): void
Parameters
- value: (b: boolean, entry: EntryType, index: number) => void
Returns void
- Defined in src/turboComponents/basics/select/select.ts:159

enabledEntries

get enabledEntries(): EntryType[]
Returns EntryType[]
- Defined in src/turboComponents/basics/select/select.ts:316

enabledValues

get enabledValues(): ValueType[]
Returns ValueType[]
- Defined in src/turboComponents/basics/select/select.ts:320

enabledSecondaryValues

get enabledSecondaryValues(): SecondaryValueType[]
Returns SecondaryValueType[]
- Defined in src/turboComponents/basics/select/select.ts:324

selectedEntry

get selectedEntry(): EntryType
Returns EntryType
Description
The dropdown's currently selected entries
- Defined in src/turboComponents/basics/select/select.ts:358

selectedValues

get selectedValues(): ValueType[]
Returns ValueType[]
Description
The dropdown's currently selected values
- Defined in src/turboComponents/basics/select/select.ts:365

selectedValue

get selectedValue(): ValueType
Returns ValueType
- Defined in src/turboComponents/basics/select/select.ts:369

selectedSecondaryValues

get selectedSecondaryValues(): SecondaryValueType[]
Returns SecondaryValueType[]
- Defined in src/turboComponents/basics/select/select.ts:375

selectedSecondaryValue

get selectedSecondaryValue(): SecondaryValueType
Returns SecondaryValueType
- Defined in src/turboComponents/basics/select/select.ts:379

stringSelectedValue

get stringSelectedValue(): string
Returns string
- Defined in src/turboComponents/basics/select/select.ts:385

Methods

`Protected`getEntryData

getEntryData(entry: EntryType): EntryData
Parameters
- entry: EntryType
Returns EntryData
- Defined in src/turboComponents/basics/select/select.ts:195

`Protected`clearEntryData

clearEntryData(entry: EntryType): void
Parameters
- entry: EntryType
Returns void
- Defined in src/turboComponents/basics/select/select.ts:205

addEntry

addEntry(entry: EntryType, index?: number): void
Parameters
- entry: EntryType
- index: number = ...
Returns void
- Defined in src/turboComponents/basics/select/select.ts:211

getEntryFromSecondaryValue

getEntryFromSecondaryValue(value: SecondaryValueType): EntryType
Parameters
- value: SecondaryValueType
Returns EntryType
- Defined in src/turboComponents/basics/select/select.ts:225

isSelected

isSelected(entry: EntryType): boolean
Parameters
- entry: EntryType
Returns boolean
- Defined in src/turboComponents/basics/select/select.ts:229

`Protected`getEntry

getEntry(value: ValueType | EntryType): EntryType
Parameters
- value: ValueType | EntryType
Returns EntryType
- Defined in src/turboComponents/basics/select/select.ts:233

select

select(value: ValueType | EntryType, selected?: boolean): this
Parameters
- value: ValueType | EntryType
  The DropdownEntry (or its string value) to select.
- selected: boolean = true
Returns this
- This Dropdown for chaining.
Description
Select an entry.
- Defined in src/turboComponents/basics/select/select.ts:252

selectByIndex

selectByIndex(
index: number,
preprocess?: (index: number, entriesCount: number, zero?: number) => number,
): this
Parameters
- index: number
  The index of the entry to select
- Optionalpreprocess: (index: number, entriesCount: number, zero?: number) => number = trim
  Callback to execute on the index to preprocess it. Defaults to trim().
Returns this
- This Dropdown for chaining.
Description
Select an entry.
- Defined in src/turboComponents/basics/select/select.ts:293

getIndex

getIndex(entry: EntryType): number
Parameters
- entry: EntryType
Returns number
- Defined in src/turboComponents/basics/select/select.ts:299

deselectAll

deselectAll(): void
Returns void
- Defined in src/turboComponents/basics/select/select.ts:303

reset

reset(): void
Returns void
- Defined in src/turboComponents/basics/select/select.ts:311

find

find(value: ValueType): EntryType
Parameters
- value: ValueType
Returns EntryType
- Defined in src/turboComponents/basics/select/select.ts:328

findBySecondaryValue

findBySecondaryValue(value: SecondaryValueType): EntryType
Parameters
- value: SecondaryValueType
Returns EntryType
- Defined in src/turboComponents/basics/select/select.ts:332

findAll

findAll(...values: ValueType[]): EntryType[]
Parameters
- ...values: ValueType[]
Returns EntryType[]
- Defined in src/turboComponents/basics/select/select.ts:336

findAllBySecondaryValue

findAllBySecondaryValue(...values: SecondaryValueType[]): EntryType[]
Parameters
- ...values: SecondaryValueType[]
Returns EntryType[]
- Defined in src/turboComponents/basics/select/select.ts:340

enable

enable(b: boolean, ...entries: (ValueType | EntryType)[]): void
Parameters
- b: boolean
- ...entries: (ValueType | EntryType)[]
Returns void
- Defined in src/turboComponents/basics/select/select.ts:344

clear

clear(): void
Returns void
- Defined in src/turboComponents/basics/select/select.ts:389

refreshInputField

refreshInputField(): void
Returns void
- Defined in src/turboComponents/basics/select/select.ts:402

destroy

destroy(): TurboSelect<ValueType, SecondaryValueType, EntryType>
Function
destroy

Returns TurboSelect<ValueType, SecondaryValueType, EntryType>
Itself, allowing for method chaining.

Description
Destroys the node by removing it from the document and removing all its bound listeners.
Overrides TurboBaseElement.destroy
- Defined in src/turboComponents/basics/select/select.ts:406

`Protected`enableObserver

enableObserver(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/turboComponents/basics/select/select.ts:412

`Protected`initializeSelection

initializeSelection(): void
Returns void
- Defined in src/turboComponents/basics/select/select.ts:417

`Protected`setupParentObserver

setupParentObserver(): void
Returns void
- Defined in src/turboComponents/basics/select/select.ts:424

`Protected`getPropertiesValue

getPropertiesValue<Type>(
    propertiesValue: Type,
    configFieldName?: string,
    defaultValue?: Type,
): Type
Protected Function
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 TurboBaseElement.getPropertiesValue
- Defined in src/turboElement/setup/default/default.types.ts:20

initialize

initialize(): void
Function
initialize

Returns void
Description
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).
Inherited from TurboBaseElement.initialize
- Defined in src/turboElement/setup/default/default.types.ts:36

`Static`configure

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

Class TurboSelect<ValueType, SecondaryValueType, EntryType>

Description

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TurboSelect<ValueType, SecondaryValueType, EntryType>

Description

Properties

Static Readonlyconfig

Description

ReadonlyonSelectDelegate

ReadonlyonEnabledDelegate

getValue

getSecondaryValue

createEntry

onEntryAdded

onEntryRemoved

forceSelection

selectedEntryClasses

selected

Description

Readonlyinitialized

Description

Accessors

entries

Returns EntryType[]

Parameters

Returns void

values

Returns ValueType[]

Description

Parameters

Returns void

selectedEntries

Returns EntryType[]

Parameters

Returns void

parent

Parameters

Returns void

inputName

Returns string

Parameters

Returns void

inputField

Returns HTMLInputElement

multiSelection

Parameters

Returns void

onSelect

Parameters

Returns void

onEnabled

Parameters

Returns void

enabledEntries

Returns EntryType[]

enabledValues

Returns ValueType[]

enabledSecondaryValues

Returns SecondaryValueType[]

selectedEntry

Returns EntryType

Description

selectedValues

Returns ValueType[]

Description

selectedValue

Returns ValueType

selectedSecondaryValues

Returns SecondaryValueType[]

selectedSecondaryValue

`Static` `Readonly`config

`Readonly`onSelectDelegate

`Readonly`onEnabledDelegate

`Readonly`initialized

`Protected`getEntryData

`Protected`clearEntryData

`Protected`getEntry

`Protected`enableObserver

`Protected`initializeSelection

`Protected`setupParentObserver

`Protected`getPropertiesValue