useSearchFieldState

Provides state management for a search field.

install	`yarn add react-stately`
version	3.21.0
usage	`import {useSearchFieldState} from 'react-stately'`

View repository

GitHub

View package

NPM

API#

useSearchFieldState(
  (props: SearchFieldProps
)): SearchFieldState

Interface#

Properties

Name	Type	Description
`value`	`string`	The current value of the search field.

Methods

Method	Description
`setValue( (value: string )): void`	Sets the value of the search field.

Example#

See the docs for useSearchField in react-aria for an example of useSearchField.

Name	Type	Description
`onSubmit`	`( (value: string )) => void`	Handler that is called when the SearchField is submitted.
`onClear`	`() => void`	Handler that is called when the clear button is pressed.
`isDisabled`	`boolean`	Whether the input is disabled.
`isReadOnly`	`boolean`	Whether the input can be selected but not changed by the user.
`validationState`	`ValidationState`	Whether the input should display its "valid" or "invalid" visual styling.
`isRequired`	`boolean`	Whether user input is required on the input before form submission. Often paired with the `necessityIndicator` prop to add a visual indicator to the input.
`description`	`ReactNode`	A description for the field. Provides a hint such as specific requirements for what to choose.
`errorMessage`	`ReactNode`	An error message for the field.
`autoFocus`	`boolean`	Whether the element should receive focus on render.
`onFocus`	`( (e: FocusEvent<Target> )) => void`	Handler that is called when the element receives focus.
`onBlur`	`( (e: FocusEvent<Target> )) => void`	Handler that is called when the element loses focus.
`onFocusChange`	`( (isFocused: boolean )) => void`	Handler that is called when the element's focus status changes.
`onKeyDown`	`( (e: KeyboardEvent )) => void`	Handler that is called when a key is pressed.
`onKeyUp`	`( (e: KeyboardEvent )) => void`	Handler that is called when a key is released.
`placeholder`	`string`	Temporary text that occupies the text input when it is empty.
`value`	`string`	The current value (controlled).
`defaultValue`	`string`	The default value (uncontrolled).
`onChange`	`( (value: T )) => void`	Handler that is called when the value changes.
`label`	`ReactNode`	The content to display as the label.