Skip to main content

Interface: UseSearchInputStoreOptions<T>

Options for useSearchInputStore hook.

See​

useSearchInputStore

Type Parameters​

Type Parameter

T

Properties​

PropertyTypeDescription

allowSubmit?

(value: T) => boolean

Validates whether the search value can be submitted, e.g. the search term is at least some characters long.

initialValue

T

Initial value for the search state.

submitTimeout?

number | "explicit" | "immediate"

Submit timeout after input to submit the value for the search:

  • (number): debounce time in milliseconds;
  • immediate: submit immediately after input;
  • explicit: submit only on explicit action.

Default

"immediate"