@serenity-is/corelib / QuickSearchInputOptions

Interface: QuickSearchInputOptions

Defined in: src/ui/datagrid/quicksearchinput.tsx:32

Options for the QuickSearchInput widget.

Properties

beforeSearch()?

optional beforeSearch: (args) => void

Defined in: src/ui/datagrid/quicksearchinput.tsx:44

Callback invoked before the search is executed.

Parameters

args

QuickSearchArgs

Returns

void

---

fields?

optional fields: QuickSearchField[]

Defined in: src/ui/datagrid/quicksearchinput.tsx:38

Optional list of fields the user can search within.

---

filteredParentClass?

optional filteredParentClass: string

Defined in: src/ui/datagrid/quicksearchinput.tsx:40

CSS class added to the parent element when the search filters results.

---

loadingParentClass?

optional loadingParentClass: string

Defined in: src/ui/datagrid/quicksearchinput.tsx:36

CSS class added to the parent element while a search is in progress.

---

onSearch()?

optional onSearch: (field, query, done) => void

Defined in: src/ui/datagrid/quicksearchinput.tsx:42

Parameters

field

string

query

string

done

(found?) => void

Returns

void

Deprecated

Prefer search

---

search()?

optional search: (args) => void

Defined in: src/ui/datagrid/quicksearchinput.tsx:46

Callback that performs the actual search.

Parameters

args

QuickSearchArgs

Returns

void

---

typeDelay?

optional typeDelay: number

Defined in: src/ui/datagrid/quicksearchinput.tsx:34

Delay in milliseconds before the search is triggered after typing stops.