ComboboxSearchRawProps

Properties

app

Django app label for the model to search.

Type: string

Source: client/lib/use/useComboboxSearch.js:48

extraParams

Extra query parameters merged into every API request.

Type: object

Source: client/lib/use/useComboboxSearch.js:56

getExtraParams

Function returning additional parameters from dependency values.

Type: Function

Source: client/lib/use/useComboboxSearch.js:57

groupBy

Field name to group options by. Requires grouped: true.

Type: string

Source: client/lib/use/useComboboxSearch.js:59

grouped

Whether to group options by a field.

Type: boolean

Source: client/lib/use/useComboboxSearch.js:58

model

Django model name.

Type: string

Source: client/lib/use/useComboboxSearch.js:49

modelExpandFields

Fields to expand in the fetch.

Type: string[]

Source: client/lib/use/useComboboxSearch.js:51

modelFields

Additional fields to fetch alongside the label and PK.

Type: string[]

Source: client/lib/use/useComboboxSearch.js:50

modelOrdering

Default ordering for the list.

Type: string[]

Source: client/lib/use/useComboboxSearch.js:52

optionLabel

Field name to display as the option label in the search list.

Type: string

Source: client/lib/use/useComboboxSearch.js:53

placeholder

Placeholder text.

Type: string

Source: client/lib/use/useComboboxSearch.js:55

selectedOptionLabel

Field name for the closed-state display label.

Type: string

Source: client/lib/use/useComboboxSearch.js:54

Source

client/lib/use/useComboboxSearch.js:47