Wagtail client-side components
Preparing search index...
components/ComboBox/ComboBox
ComboBoxProps
Interface ComboBoxProps<ComboBoxOption>
interface
ComboBoxProps
<
ComboBoxOption
>
{
getItemDescription
:
(
item
:
ComboBoxOption
)
=>
undefined
|
null
|
string
;
getItemLabel
:
(
type
:
undefined
|
string
,
item
:
ComboBoxOption
,
)
=>
undefined
|
null
|
string
;
getSearchFields
:
(
item
:
ComboBoxOption
)
=>
(
undefined
|
null
|
string
)
[]
;
inputValue
?:
string
;
items
:
ComboBoxCategory
<
ComboBoxOption
>
[]
;
label
?:
string
;
noResultsText
?:
string
;
onSelect
:
(
change
:
UseComboboxStateChange
<
ComboBoxOption
>
)
=>
void
;
placeholder
?:
string
;
}
Type Parameters
ComboBoxOption
Index
Properties
get
Item
Description
get
Item
Label
get
Search
Fields
input
Value?
items
label?
no
Results
Text?
on
Select
placeholder?
Properties
get
Item
Description
getItemDescription
:
(
item
:
ComboBoxOption
)
=>
undefined
|
null
|
string
get
Item
Label
getItemLabel
:
(
type
:
undefined
|
string
,
item
:
ComboBoxOption
,
)
=>
undefined
|
null
|
string
get
Search
Fields
getSearchFields
:
(
item
:
ComboBoxOption
)
=>
(
undefined
|
null
|
string
)
[]
Optional
input
Value
inputValue
?:
string
items
items
:
ComboBoxCategory
<
ComboBoxOption
>
[]
Optional
label
label
?:
string
Optional
no
Results
Text
noResultsText
?:
string
on
Select
onSelect
:
(
change
:
UseComboboxStateChange
<
ComboBoxOption
>
)
=>
void
Optional
placeholder
placeholder
?:
string
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
get
Item
Description
get
Item
Label
get
Search
Fields
input
Value
items
label
no
Results
Text
on
Select
placeholder
Wagtail client-side components
Loading...