Interface: SearchInputStore<T>

Defined in: widgets/utility/searchInput.tsx:103

Represents the state store for an abstract search input component.

See

useSearchInputStore

Type Parameters

Type Parameter	Default type
T	string

Properties

Property	Modifier	Type	Description
events	readonly	Events<SearchInputStoreEvents<T>>	Events for the search store.

Accessors

mode

Get Signature

get mode(): "explicit" | "debounce" | "immediate"

Defined in: widgets/utility/searchInput.tsx:114

Current submit mode for the input value changes in the store:

• debounce: submit after debounce timeout;
• immediate: submit immediately after input;
• explicit: submit only on explicit submit action.

Returns

"explicit" | "debounce" | "immediate"

---

value

Get Signature

get value(): T

Defined in: widgets/utility/searchInput.tsx:118

Current search query value.

Returns

T

Methods

change()

change(params): void

Defined in: widgets/utility/searchInput.tsx:122

Changes the search query value with specified intent (action).

Parameters

Parameter	Type	Description
params	{ action: "input" | "clear" | "submit"; value: T; }	‐
params.action	"input" | "clear" | "submit"	Change intent (action): input: potentially transient change to the query value, likely to be superseded by another; submit: explicit request to perform the search immediately; clear: explicit or implicit request to clear the search query e.g. via specific button or if a new value is not allowed to be submitted.
params.value	T	New search query value.

Returns

void