@serenity-is/corelib / ComboboxOptions

Interface: ComboboxOptions<TSource>

Defined in: src/ui/editors/combobox.ts:62

Options for the Combobox.

Type Parameters

TSource

TSource = any

The source item type.

Properties

allowClear?

optional allowClear: boolean

Defined in: src/ui/editors/combobox.ts:64

Whether the selection can be cleared.

---

arbitraryValues?

optional arbitraryValues: boolean

Defined in: src/ui/editors/combobox.ts:70

Allow arbitrary values for items.

---

createSearchChoice()?

optional createSearchChoice: (s) => ComboboxItem<TSource>

Defined in: src/ui/editors/combobox.ts:66

Callback that creates a search choice for arbitrary values.

Parameters

s

string

Returns

ComboboxItem<TSource>

---

element?

optional element: HTMLInputElement | HTMLSelectElement | Element[]

Defined in: src/ui/editors/combobox.ts:68

The element to attach the combobox to.

---

formatResult()?

optional formatResult: (p1) => ComboboxFormatResult

Defined in: src/ui/editors/combobox.ts:74

Formatter for result items.

Parameters

p1

ComboboxItem<TSource>

Returns

ComboboxFormatResult

---

formatSelection()?

optional formatSelection: (p1) => ComboboxFormatResult

Defined in: src/ui/editors/combobox.ts:72

Formatter for the selected item.

Parameters

p1

ComboboxItem<TSource>

Returns

ComboboxFormatResult

---

minimumResultsForSearch?

optional minimumResultsForSearch: number

Defined in: src/ui/editors/combobox.ts:76

Minimum results required to show the search box.

---

multiple?

optional multiple: boolean

Defined in: src/ui/editors/combobox.ts:78

Whether multiple items can be selected.

---

pageSize?

optional pageSize: number

Defined in: src/ui/editors/combobox.ts:80

Page size to use while loading or displaying results.

---

placeholder?

optional placeholder: string

Defined in: src/ui/editors/combobox.ts:82

Placeholder text.

---

providerOptions()?

optional providerOptions: (type, opt) => any

Defined in: src/ui/editors/combobox.ts:84

Callback to get options specific to the combobox provider type.

Parameters

type

"select2"

opt

ComboboxOptions

Returns

any

---

search()?

optional search: (query) => ComboboxSearchResult<ComboboxItem<TSource>> | PromiseLike<ComboboxSearchResult<ComboboxItem<TSource>>>

Defined in: src/ui/editors/combobox.ts:86

Callback that performs the search.

Parameters

query

ComboboxSearchQuery

Returns

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

---

typeDelay?

optional typeDelay: number

Defined in: src/ui/editors/combobox.ts:88

Type delay for searching, default is 200.