@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
arbitraryValues
• Optional
arbitraryValues: boolean
Allow arbitrary values for items
Defined in
createSearchChoice
• Optional
createSearchChoice: (s
: string
) => ComboboxItem
<TSource
>
Type declaration
▸ (s
): ComboboxItem
<TSource
>
Parameters
Name | Type |
---|---|
s |
string |
Returns
ComboboxItem
<TSource
>
Defined in
element
• Optional
element: HTMLInputElement
| HTMLSelectElement
| Element
[]
Defined in
formatResult
• Optional
formatResult: (p1
: ComboboxItem
<TSource
>) => ComboboxFormatResult
Type declaration
▸ (p1
): ComboboxFormatResult
Parameters
Name | Type |
---|---|
p1 |
ComboboxItem <TSource > |
Returns
Defined in
formatSelection
• Optional
formatSelection: (p1
: ComboboxItem
<TSource
>) => ComboboxFormatResult
Type declaration
▸ (p1
): ComboboxFormatResult
Parameters
Name | Type |
---|---|
p1 |
ComboboxItem <TSource > |
Returns
Defined in
minimumResultsForSearch
• Optional
minimumResultsForSearch: number
Defined in
multiple
• Optional
multiple: boolean
Defined in
pageSize
• Optional
pageSize: number
Page size to use while loading or displaying results
Defined in
placeholder
• Optional
placeholder: string
Defined in
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
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
typeDelay
• Optional
typeDelay: number
Type delay for searching, default is 200