@serenity-is/corelib / Combobox

Class: Combobox<TItem>

Type parameters

Name	Type
TItem	any

Table of contents

Constructors

• constructor

Properties

• defaults

Accessors

• container
• isMultiple
• type

Methods

• abortInitSelection
• abortPendingQuery
• closeDropdown
• dispose
• getSelectedItem
• getSelectedItems
• getValue
• getValues
• openDropdown
• setValue
• setValues
• getInstance

Constructors

constructor

• new Combobox<TItem>(opt): Combobox<TItem>

Type parameters

Name	Type
TItem	any

Parameters

Name	Type
opt	ComboboxOptions<any>

Returns

Combobox<TItem>

Defined in

src/ui/editors/combobox.ts:57

Properties

defaults

▪ Static defaults: ComboboxOptions<any>

Defined in

src/ui/editors/combobox.ts:52

Accessors

container

• get container(): HTMLElement

Returns

HTMLElement

Defined in

src/ui/editors/combobox.ts:247

---

isMultiple

• get isMultiple(): boolean

Returns

boolean

Defined in

src/ui/editors/combobox.ts:263

---

type

• get type(): "select2"

Returns

"select2"

Defined in

src/ui/editors/combobox.ts:253

Methods

abortInitSelection

▸ abortInitSelection(): void

Returns

void

Defined in

src/ui/editors/combobox.ts:230

---

abortPendingQuery

▸ abortPendingQuery(): void

Returns

void

Defined in

src/ui/editors/combobox.ts:217

---

closeDropdown

▸ closeDropdown(): void

Returns

void

Defined in

src/ui/editors/combobox.ts:377

---

dispose

▸ dispose(): void

Returns

void

Defined in

src/ui/editors/combobox.ts:238

---

getSelectedItem

▸ getSelectedItem(): ComboboxItem<any>

Returns

ComboboxItem<any>

Defined in

src/ui/editors/combobox.ts:274

---

getSelectedItems

▸ getSelectedItems(): ComboboxItem<any>[]

Returns

ComboboxItem<any>[]

Defined in

src/ui/editors/combobox.ts:284

---

getValue

▸ getValue(): string

Returns

string

Defined in

src/ui/editors/combobox.ts:300

---

getValues

▸ getValues(): string[]

Returns

string[]

Defined in

src/ui/editors/combobox.ts:316

---

openDropdown

▸ openDropdown(): void

Returns

void

Defined in

src/ui/editors/combobox.ts:381

---

setValue

▸ setValue(value, triggerChange?): void

Parameters

Name	Type	Default value
value	string	undefined
triggerChange	boolean	false

Returns

void

Defined in

src/ui/editors/combobox.ts:336

---

setValues

▸ setValues(value, triggerChange?): void

Parameters

Name	Type	Default value
value	string[]	undefined
triggerChange	boolean	false

Returns

void

Defined in

src/ui/editors/combobox.ts:368

---

getInstance

▸ getInstance(el): Combobox<any>

Parameters

Name	Type
el	Element | ArrayLike<Element>

Returns

Combobox<any>

Defined in

src/ui/editors/combobox.ts:385