@serenity-is/corelib / ComboboxOptions

Interface: ComboboxOptions<TSource>

Type parameters

Name	Type
TSource	any

Table of contents

Properties

• allowClear
• arbitraryValues
• createSearchChoice
• element
• formatResult
• formatSelection
• minimumResultsForSearch
• multiple
• pageSize
• placeholder
• providerOptions
• search
• typeDelay

Properties

allowClear

• Optional allowClear: boolean

Defined in

src/ui/editors/combobox.ts:30

---

arbitraryValues

• Optional arbitraryValues: boolean

Allow arbitrary values for items

Defined in

src/ui/editors/combobox.ts:34

---

createSearchChoice

• Optional createSearchChoice: (s: string) => ComboboxItem<TSource>

Type declaration

▸ (s): ComboboxItem<TSource>

Parameters

Name	Type
s	string

Returns

ComboboxItem<TSource>

Defined in

src/ui/editors/combobox.ts:31

---

element

• Optional element: HTMLInputElement | HTMLSelectElement | Element[]

Defined in

src/ui/editors/combobox.ts:32

---

formatResult

• Optional formatResult: (p1: ComboboxItem<TSource>) => ComboboxFormatResult

Type declaration

▸ (p1): ComboboxFormatResult

Parameters

Name	Type
p1	ComboboxItem<TSource>

Returns

ComboboxFormatResult

Defined in

src/ui/editors/combobox.ts:36

---

formatSelection

• Optional formatSelection: (p1: ComboboxItem<TSource>) => ComboboxFormatResult

Type declaration

▸ (p1): ComboboxFormatResult

Parameters

Name	Type
p1	ComboboxItem<TSource>

Returns

ComboboxFormatResult

Defined in

src/ui/editors/combobox.ts:35

---

minimumResultsForSearch

• Optional minimumResultsForSearch: number

Defined in

src/ui/editors/combobox.ts:37

---

multiple

• Optional multiple: boolean

Defined in

src/ui/editors/combobox.ts:38

---

pageSize

• Optional pageSize: number

Page size to use while loading or displaying results

Defined in

src/ui/editors/combobox.ts:40

---

placeholder

• Optional placeholder: string

Defined in

src/ui/editors/combobox.ts:41

---

providerOptions

• Optional providerOptions: (type: "select2", opt: ComboboxOptions<any>) => any

Callback to get options specific to the combobox provider type

Type declaration

▸ (type, opt): any

Parameters

Name	Type
type	"select2"
opt	ComboboxOptions<any>

Returns

any

Defined in

src/ui/editors/combobox.ts:43

---

search

• Optional search: (query: ComboboxSearchQuery) => ComboboxSearchResult<ComboboxItem<TSource>> | PromiseLike<ComboboxSearchResult<ComboboxItem<TSource>>>

Type declaration

▸ (query): ComboboxSearchResult<ComboboxItem<TSource>> | PromiseLike<ComboboxSearchResult<ComboboxItem<TSource>>>

Parameters

Name	Type
query	ComboboxSearchQuery

Returns

ComboboxSearchResult<ComboboxItem<TSource>> | PromiseLike<ComboboxSearchResult<ComboboxItem<TSource>>>

Defined in

src/ui/editors/combobox.ts:44

---

typeDelay

• Optional typeDelay: number

Type delay for searching, default is 200

Defined in

src/ui/editors/combobox.ts:46