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

Index

Constructors

constructor

Properties

properties defaultProperties getValue getSecondaryValue createEntry forceSelection selectedEntriesClasses entriesClasses selected initialized defaultFeedforwardProperties

Constructors

constructor

new TurboSelect<
    ValueType = string,
    SecondaryValueType = string,
    EntryType extends object = HTMLElement,
>(): TurboSelect<ValueType, SecondaryValueType, EntryType>
Type Parameters
- ValueType = string
- SecondaryValueType = string
- EntryType extends object = HTMLElement
Returns TurboSelect<ValueType, SecondaryValueType, EntryType>
Description
Dropdown constructor
Overrides TurboBaseElement.constructor
- Defined in src/turboComponents/basics/select/select.ts:228

Properties

`Readonly`properties

properties: TurboSelectProperties<ValueType, SecondaryValueType, EntryType>

`Static`defaultProperties

defaultProperties: TurboSelectProperties = ...

Description

Default properties assigned to a new instance.

getValue

getValue: (entry: EntryType) => ValueType

getSecondaryValue

getSecondaryValue: (entry: EntryType) => SecondaryValueType

createEntry

createEntry: (value: ValueType) => EntryType

forceSelection

forceSelection: boolean

selectedEntriesClasses

selectedEntriesClasses: string | string[]

entriesClasses

entriesClasses: 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.

defaultFeedforwardProperties

defaultFeedforwardProperties: TurboElementProperties

Accessors

onSelect

get onSelect(): Delegate<(b: boolean, entry: EntryType, index: number) => void>
Returns Delegate<(b: boolean, entry: EntryType, index: number) => void>
- Defined in src/turboComponents/basics/select/select.ts:46
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:50

onEnabled

get onEnabled(): Delegate<(b: boolean, entry: EntryType, index: number) => void>
Returns Delegate<(b: boolean, entry: EntryType, index: number) => void>
- Defined in src/turboComponents/basics/select/select.ts:55
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:59

onEntryAdded

get onEntryAdded(): Delegate<(entry: EntryType, index: number) => void>
Returns Delegate<(entry: EntryType, index: number) => void>
- Defined in src/turboComponents/basics/select/select.ts:64
set onEntryAdded(value: (entry: EntryType, index: number) => void): void
Parameters
- value: (entry: EntryType, index: number) => void
Returns void
- Defined in src/turboComponents/basics/select/select.ts:68

onEntryRemoved

get onEntryRemoved(): Delegate<(entry: EntryType) => void>
Returns Delegate<(entry: EntryType) => void>
- Defined in src/turboComponents/basics/select/select.ts:73
set onEntryRemoved(value: (entry: EntryType) => void): void
Parameters
- value: (entry: EntryType) => void
Returns void
- Defined in src/turboComponents/basics/select/select.ts:77

onEntryClicked

get onEntryClicked(): Delegate<(entry: EntryType, e: Event) => void>
Returns Delegate<(entry: EntryType, e: Event) => void>
- Defined in src/turboComponents/basics/select/select.ts:82
set onEntryClicked(value: (entry: EntryType, e: Event) => void): void
Parameters
- value: (entry: EntryType, e: Event) => void
Returns void
- Defined in src/turboComponents/basics/select/select.ts:86

entries

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

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

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:126
set values(values: ValueType[]): void
Parameters
- values: ValueType[]
Returns void
- Defined in src/turboComponents/basics/select/select.ts:130

selectedEntries

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

parent

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

inputName

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

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

inputField

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

multiSelection

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

enabledEntries

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

enabledValues

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

enabledSecondaryValues

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

selectedEntry

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

selectedValues

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

selectedValue

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

selectedSecondaryValues

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

selectedSecondaryValue

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

stringSelectedValue

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

Methods

`Protected` `Static`customCreate

customCreate(properties: TurboSelectProperties): object
Parameters
- properties: TurboSelectProperties
Returns object
Overrides TurboBaseElement.customCreate
- Defined in src/turboComponents/basics/select/select.ts:217

`Protected`getEntryData

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

`Protected`clearEntryData

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

addEntry

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

getEntryFromSecondaryValue

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

isSelected

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

`Protected`getEntry

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

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:299

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:341

getIndex

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

deselectAll

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

reset

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

find

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

findBySecondaryValue

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

findAll

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

findAllBySecondaryValue

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

enable

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

clear

clear(disableObserver?: boolean): void
Parameters
- disableObserver: boolean = true
Returns void
- Defined in src/turboComponents/basics/select/select.ts:444

refreshInputField

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

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:460

`Protected`enableObserver

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

`Protected`initializeSelection

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

`Protected`setupParentObserver

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

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:29

feedforward

feedforward(properties?: FeedforwardProperties): this
Parameters
- Optionalproperties: FeedforwardProperties
Returns this
Inherited from TurboBaseElement.feedforward
- Defined in src/turboElement/setup/default/default.types.ts:40

clone

clone(options?: CloneElementOptions): this
Parameters
- Optionaloptions: CloneElementOptions
Returns this
Inherited from TurboBaseElement.clone
- Defined in src/turboElement/setup/default/default.types.ts:42

`Static`create

create<Type extends new (...args: any[]) => TurboBaseElement>(
this: Type,
properties?: InstanceType<Type>["properties"],
): InstanceType<Type>
Type Parameters
- Type extends new (...args: any[]) => TurboBaseElement
Parameters
- this: Type
- properties: InstanceType<Type>["properties"] = {}
Returns InstanceType<Type>
Inherited from TurboBaseElement.create
- Defined in src/turboElement/turboBaseElement/turboBaseElement.ts:23

Class TurboSelect<ValueType, SecondaryValueType, EntryType>

Description

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns TurboSelect<ValueType, SecondaryValueType, EntryType>

Description

Properties

Readonlyproperties

StaticdefaultProperties

Description

getValue

getSecondaryValue

createEntry

forceSelection

selectedEntriesClasses

entriesClasses

selected

Description

Readonlyinitialized

Description

defaultFeedforwardProperties

Accessors

onSelect

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

Parameters

Returns void

onEnabled

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

Parameters

Returns void

onEntryAdded

Returns Delegate<(entry: EntryType, index: number) => void>

Parameters

Returns void

onEntryRemoved

Returns Delegate<(entry: EntryType) => void>

Parameters

Returns void

onEntryClicked

Returns Delegate<(entry: EntryType, e: Event) => void>

Parameters

Returns void

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

enabledEntries

Returns EntryType[]

enabledValues

Returns ValueType[]

enabledSecondaryValues

`Readonly`properties

`Static`defaultProperties

`Readonly`initialized

`Protected` `Static`customCreate

`Protected`getEntryData

`Protected`clearEntryData

`Protected`getEntry