Class GradumSelect<ValueType, SecondaryValueType, EntryType>

GradumSelect

Description

Base class for creating a selection menu

Type Parameters

ValueType = string
SecondaryValueType = string
EntryType extends object = HTMLElement

Hierarchy (View Summary)

GradumBaseElement
- GradumSelect

Index

Constructors

constructor

Properties

properties defaultProperties getValue getSecondaryValue createEntry forceSelection selectedEntriesClasses entriesClasses initialized defaultFeedforwardProperties

Constructors

constructor

new GradumSelect<
    ValueType = string,
    SecondaryValueType = string,
    EntryType extends object = HTMLElement,
>(): GradumSelect<ValueType, SecondaryValueType, EntryType>
Type Parameters
- ValueType = string
- SecondaryValueType = string
- EntryType extends object = HTMLElement
Returns GradumSelect<ValueType, SecondaryValueType, EntryType>

Description
Create a selection.
Overrides GradumBaseElement.constructor
- Defined in src/gradumComponents/basics/select/select.ts:292

Properties

`Readonly`properties

properties: GradumSelectProperties<ValueType, SecondaryValueType, EntryType>

Description

The properties this element was created with.

`Static`defaultProperties

defaultProperties: GradumSelectProperties = ...

Static

Description

Default properties assigned to a new selection: selected entries get the selected class, and disabled entries are hidden.

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[]

`Readonly`initialized

initialized: boolean

Description

Whether the element was initialized already or not.

defaultFeedforwardProperties

defaultFeedforwardProperties: GradumElementProperties

Description

The properties passed on to children created through feedforward, letting a parent seed its descendants with shared defaults.

Accessors

onSelect

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

Description
Fired whenever an entry is selected or deselected, with the new state, the entry, and its index. Assigning a function subscribes it rather than replacing the existing subscribers.
- Defined in src/gradumComponents/basics/select/select.ts:82
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/gradumComponents/basics/select/select.ts:86

onEnabled

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

Description
Fired whenever an entry is enabled or disabled. Assigning a function subscribes it rather than replacing the existing subscribers.
- Defined in src/gradumComponents/basics/select/select.ts:95
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/gradumComponents/basics/select/select.ts:99

onEntryAdded

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

Description
Fired whenever an entry is added. Assigning a function subscribes it rather than replacing the existing subscribers.
- Defined in src/gradumComponents/basics/select/select.ts:108
set onEntryAdded(value: (entry: EntryType, index: number) => void): void
Parameters
- value: (entry: EntryType, index: number) => void
Returns void
- Defined in src/gradumComponents/basics/select/select.ts:112

onEntryRemoved

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

Description
Fired whenever an entry is removed. Assigning a function subscribes it rather than replacing the existing subscribers.
- Defined in src/gradumComponents/basics/select/select.ts:121
set onEntryRemoved(value: (entry: EntryType) => void): void
Parameters
- value: (entry: EntryType) => void
Returns void
- Defined in src/gradumComponents/basics/select/select.ts:125

onEntryClicked

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

Description
Fired whenever an entry is clicked, whether or not the click changes the selection. Assigning a function subscribes it rather than replacing the existing subscribers.
- Defined in src/gradumComponents/basics/select/select.ts:134
set onEntryClicked(value: (entry: EntryType, e: Event) => void): void
Parameters
- value: (entry: EntryType, e: Event) => void
Returns void
- Defined in src/gradumComponents/basics/select/select.ts:138

entries

get entries(): EntryType[]
Returns EntryType[]

Description
This selection's entries, in order. Assigning a new list replaces them all.
- Defined in src/gradumComponents/basics/select/select.ts:145
set entries(value: NodeList | HTMLCollection | EntryType[]): void
Parameters
- value: NodeList | HTMLCollection | EntryType[]
Returns void
- Defined in src/gradumComponents/basics/select/select.ts:149

values

get values(): ValueType[]
Returns ValueType[]

Description
The values of this selection's entries. Assigning a new list rebuilds the entries to match.
- Defined in src/gradumComponents/basics/select/select.ts:178
set values(values: ValueType[]): void
Parameters
- values: ValueType[]
Returns void
- Defined in src/gradumComponents/basics/select/select.ts:182

selectedEntries

get selectedEntries(): EntryType[]
Returns EntryType[]
- Defined in src/gradumComponents/basics/select/select.ts:192
set selectedEntries(value: EntryType[]): void
Parameters
- value: EntryType[]
Returns void
- Defined in src/gradumComponents/basics/select/select.ts:196

parent

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

inputName

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

Returns string
- Defined in src/gradumComponents/basics/select/select.ts:225
set inputName(value: string): void
Parameters
- value: string
Returns void
- Defined in src/gradumComponents/basics/select/select.ts:229

inputField

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

multiSelection

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

enabledEntries

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

enabledValues

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

enabledSecondaryValues

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

selectedEntry

get selectedEntry(): EntryType
Returns EntryType

Description
The dropdown's currently selected entries
- Defined in src/gradumComponents/basics/select/select.ts:493

selectedIndex

get selectedIndex(): number
Returns number
- Defined in src/gradumComponents/basics/select/select.ts:497
set selectedIndex(value: number): void
Parameters
- value: number
Returns void
- Defined in src/gradumComponents/basics/select/select.ts:501

selectedIndices

get selectedIndices(): number[]
Returns number[]
- Defined in src/gradumComponents/basics/select/select.ts:505

selectedValues

get selectedValues(): ValueType[]
Returns ValueType[]

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

selectedValue

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

selectedSecondaryValues

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

selectedSecondaryValue

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

stringSelectedValue

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

Methods

`Static`create

create<
    This extends { prototype: GradumBaseElement },
    ValueType = string,
    SecondaryValueType = string,
    EntryType extends object = HTMLElement,
>(
    this: This,
    properties?: This["prototype"]["properties"] & GradumSelectProperties<
        ValueType,
        SecondaryValueType,
        EntryType,
    >,
): This["prototype"] & GradumSelect<
    ValueType,
    SecondaryValueType,
    EntryType,
>
Function
create
Type Parameters
- This extends { prototype: GradumBaseElement }
  The class create was called on. The constraint matches the base signature; the return type still narrows to this class.
- ValueType = string
  Inferred from properties.getValue.
- SecondaryValueType = string
  Inferred from properties.getSecondaryValue.
- EntryType extends object = HTMLElement
  Inferred from the entries the accessors receive.
Parameters
- this: This
- Optionalproperties: This["prototype"]["properties"] & GradumSelectProperties<
      ValueType,
      SecondaryValueType,
      EntryType,
  >
  Properties to set on the new selection.
Returns This["prototype"] & GradumSelect<ValueType, SecondaryValueType, EntryType>
The created selection, typed as the class this was called on.

Static

Description
Instantiate a selection, reading its value and entry types back off the properties — so the types come from getValue/getSecondaryValue rather than needing a cast. Narrows GradumBaseElement.create, which cannot see generics declared on a subclass.
Overrides GradumBaseElement.create
- Defined in src/gradumComponents/basics/select/select.ts:46

`Protected` `Static`customCreate

customCreate(properties: GradumSelectProperties): object
Protected Function
customCreate
Parameters
- properties: GradumSelectProperties
  The selection's configuration.
Returns object
The created selection.

Static

Description
Build a selection, deferring the initial entries and selected values until the element exists so they are not lost during construction.
Overrides GradumBaseElement.customCreate
- Defined in src/gradumComponents/basics/select/select.ts:281

`Protected`getEntryData

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

`Protected`clearEntryData

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

addEntry

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

removeEntry

removeEntry(value: ValueType | EntryType): this
Parameters
- value: ValueType | EntryType
Returns this
- Defined in src/gradumComponents/basics/select/select.ts:335

getEntryFromSecondaryValue

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

isSelected

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

`Protected`getEntry

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

select

select(value: ValueType | EntryType, selected?: boolean): this
Function
select
Parameters
- value: ValueType | EntryType
  The entry to select, or the value identifying it.
- Optionalselected: boolean = true
  Whether to select the entry, or deselect it.
Returns this
Itself, allowing for method chaining.

Description
Select or deselect an entry. In single-selection mode selecting one entry deselects whichever was selected before.
- Defined in src/gradumComponents/basics/select/select.ts:385

selectByIndex

selectByIndex(
index: number,
preprocess?: (index: number, entriesCount: number, zero?: number) => number,
): this
Function
selectByIndex
Parameters
- index: number
  The index of the entry to select.
- Optionalpreprocess: (index: number, entriesCount: number, zero?: number) => number = trim
  Applied to the index before use. Defaults to trim, which clamps it into range; pass mod to wrap around instead.
Returns this
Itself, allowing for method chaining.

Description
Select the entry at the given index.
- Defined in src/gradumComponents/basics/select/select.ts:428

getIndex

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

deselectAll

deselectAll(): void
Returns void
- Defined in src/gradumComponents/basics/select/select.ts:438

reset

reset(): void
Returns void
- Defined in src/gradumComponents/basics/select/select.ts:446

find

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

findBySecondaryValue

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

findAll

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

findAllBySecondaryValue

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

enable

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

clear

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

refreshInputField

refreshInputField(): void
Returns void
- Defined in src/gradumComponents/basics/select/select.ts:555

destroy

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

Returns GradumSelect<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 GradumBaseElement.destroy
- Defined in src/gradumComponents/basics/select/select.ts:559

`Protected`enableObserver

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

`Protected`initializeSelection

initializeSelection(): void
Returns void
- Defined in src/gradumComponents/basics/select/select.ts:570

`Protected`setupParentObserver

setupParentObserver(): void
Returns void
- Defined in src/gradumComponents/basics/select/select.ts:577

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 GradumBaseElement.initialize
- Defined in src/gradumElement/setup/default/default.types.ts:32

feedforward

feedforward(properties?: FeedforwardProperties): this
Function
feedforward
Parameters
- Optionalproperties: FeedforwardProperties
  Properties to feed forward. Defaults to defaultFeedforwardProperties.
Returns this
Itself, allowing for method chaining.

Description
Push this element's feedforward properties down to its children, so newly added descendants pick up the same defaults.
Inherited from GradumBaseElement.feedforward
- Defined in src/gradumElement/setup/default/default.types.ts:55

clone

clone(options?: CloneElementOptions): this
Function
clone
Parameters
- Optionaloptions: CloneElementOptions
  What to carry over to the copy.
Returns this
The cloned element.

Description
Create a copy of this element. By default the copy carries the same properties and children but none of the bound listeners.
Inherited from GradumBaseElement.clone
- Defined in src/gradumElement/setup/default/default.types.ts:64

Class GradumSelect<ValueType, SecondaryValueType, EntryType>

Description

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns GradumSelect<ValueType, SecondaryValueType, EntryType>

Description

Properties

Readonlyproperties

Description

StaticdefaultProperties

Static

Description

getValue

getSecondaryValue

createEntry

forceSelection

selectedEntriesClasses

entriesClasses

Readonlyinitialized

Description

defaultFeedforwardProperties

Description

Accessors

onSelect

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

Description

Parameters

Returns void

onEnabled

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

Description

Parameters

Returns void

onEntryAdded

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

Description

Parameters

Returns void

onEntryRemoved

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

Description

Parameters

Returns void

onEntryClicked

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

Description

Parameters

Returns void

entries

Returns EntryType[]

Description

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

`Readonly`properties

`Static`defaultProperties

`Readonly`initialized

`Static`create

`Protected` `Static`customCreate

`Protected`getEntryData

`Protected`clearEntryData

`Protected`getEntry