SearchInput

Props

API reference for SearchInput. For usage examples, see the React tab.

SearchInput

Name	Type	Default
children	`ChildrenOrFunction<SearchFieldRenderProps>`
The children of the component. A function may be provided to alter the children based on component state.
description	`string`
inputMode	`"decimal" \| "email" \| "none" \| "numeric" \| "search" \| "tel" \| "text" \| "url"`
Hints at the type of data that might be entered by the user while editing the element or its contents. See MDN (opens in new tab).
isDisabled	`boolean`
Whether the input is disabled.
isInvalid	`boolean`
Whether the input value is invalid.
isReadOnly	`boolean`
Whether the input can be selected but not changed by the user.
isRequired	`boolean`
Whether user input is required on the input before form submission.
label	`string`
size	`"lg" \| "md" \| "sm"`	`md`
Controls height, padding, typography, and search chrome of the field.
compactDeprecated	`boolean`
Use `size` instead. This prop is a no-op.

Name	Type	Default
aria-activedescendant	`string`
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-autocomplete	`"both" \| "inline" \| "list" \| "none"`
Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
aria-controls	`string`
Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-describedby	`string`
Identifies the element (or elements) that describes the object.
aria-details	`string`
Identifies the element (or elements) that provide a detailed, extended description for the object.
aria-errormessage	`string`
Identifies the element that provides an error message for the object.
aria-haspopup	`"dialog" \| "false" \| "grid" \| "listbox" \| "menu" \| "tree" \| "true" \| boolean`
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-label	`string`
Defines a string value that labels the current element.
aria-labelledby	`string`
Identifies the element (or elements) that labels the current element.
id	`string`
The element's unique identifier. See MDN (opens in new tab).

Name	Type	Default
autoCorrect	`string`
An attribute that takes as its value a space-separated string that describes what, if any, type of autocomplete functionality the input should provide. See MDN (opens in new tab).
autoFocus	`boolean`
Whether the element should receive focus on render.
dir	`string`
enterKeyHint	`"done" \| "enter" \| "go" \| "next" \| "previous" \| "search" \| "send"`
An enumerated attribute that defines what action label or icon to preset for the enter key on virtual keyboards. See MDN (opens in new tab).
excludeFromTabOrder	`boolean`
Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available.
hidden	`boolean`
inert	`boolean`
lang	`string`
ref	`Ref<HTMLInputElement>`
Requires React 19
render	`DOMRenderFunction<"div", SearchFieldRenderProps>`
Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). Only a single root DOM element can be rendered (no fragments). You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.
slot	`string \| null`
A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.
spellCheck	`string`
An enumerated attribute that defines whether the element may be checked for spelling errors. See MDN (opens in new tab).
suppressHydrationWarning	`boolean`
A React-only flag that suppresses the warning React normally logs when an element's server-rendered content doesn't match the client render during hydration. See React docs (opens in new tab).
translate	`"no" \| "yes"`

Name	Type	Default
onAnimationEnd	`AnimationEventHandler<HTMLDivElement>`
onAnimationEndCapture	`AnimationEventHandler<HTMLDivElement>`
onAnimationIteration	`AnimationEventHandler<HTMLDivElement>`
onAnimationIterationCapture	`AnimationEventHandler<HTMLDivElement>`
onAnimationStart	`AnimationEventHandler<HTMLDivElement>`
onAnimationStartCapture	`AnimationEventHandler<HTMLDivElement>`
onAuxClick	`MouseEventHandler<HTMLDivElement>`
onAuxClickCapture	`MouseEventHandler<HTMLDivElement>`
onBeforeInput	`FormEventHandler<HTMLInputElement>`
Handler that is called when the input value is about to be modified. See MDN (opens in new tab).
onBlur	`((e: FocusEvent<HTMLInputElement, Element>) => void)`
Handler that is called when the element loses focus.
onChange	`((value: string) => void)`
Handler that is called when the value changes.
onClear	`(() => void)`
Handler that is called when the clear button is pressed.
onClick	`MouseEventHandler<HTMLDivElement>`
onClickCapture	`MouseEventHandler<HTMLDivElement>`
onCompositionEnd	`CompositionEventHandler<HTMLInputElement>`
Handler that is called when a text composition system completes or cancels the current text composition session. See MDN (opens in new tab).
onCompositionStart	`CompositionEventHandler<HTMLInputElement>`
Handler that is called when a text composition system starts a new text composition session. See MDN (opens in new tab).
onCompositionUpdate	`CompositionEventHandler<HTMLInputElement>`
Handler that is called when a new character is received in the current text composition session. See MDN (opens in new tab).
onContextMenu	`MouseEventHandler<HTMLDivElement>`
onContextMenuCapture	`MouseEventHandler<HTMLDivElement>`
onCopy	`ClipboardEventHandler<HTMLInputElement>`
Handler that is called when the user copies text. See MDN (opens in new tab).
onCut	`ClipboardEventHandler<HTMLInputElement>`
Handler that is called when the user cuts text. See MDN (opens in new tab).
onDoubleClick	`MouseEventHandler<HTMLDivElement>`
onDoubleClickCapture	`MouseEventHandler<HTMLDivElement>`
onFocus	`((e: FocusEvent<HTMLInputElement, Element>) => void)`
Handler that is called when the element receives focus.
onFocusChange	`((isFocused: boolean) => void)`
Handler that is called when the element's focus status changes.
onGotPointerCapture	`PointerEventHandler<HTMLDivElement>`
onGotPointerCaptureCapture	`PointerEventHandler<HTMLDivElement>`
onInput	`FormEventHandler<HTMLInputElement>`
Handler that is called when the input value is modified. See MDN (opens in new tab).
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.
onLostPointerCapture	`PointerEventHandler<HTMLDivElement>`
onLostPointerCaptureCapture	`PointerEventHandler<HTMLDivElement>`
onMouseDown	`MouseEventHandler<HTMLDivElement>`
onMouseDownCapture	`MouseEventHandler<HTMLDivElement>`
onMouseEnter	`MouseEventHandler<HTMLDivElement>`
onMouseLeave	`MouseEventHandler<HTMLDivElement>`
onMouseMove	`MouseEventHandler<HTMLDivElement>`
onMouseMoveCapture	`MouseEventHandler<HTMLDivElement>`
onMouseOut	`MouseEventHandler<HTMLDivElement>`
onMouseOutCapture	`MouseEventHandler<HTMLDivElement>`
onMouseOver	`MouseEventHandler<HTMLDivElement>`
onMouseOverCapture	`MouseEventHandler<HTMLDivElement>`
onMouseUp	`MouseEventHandler<HTMLDivElement>`
onMouseUpCapture	`MouseEventHandler<HTMLDivElement>`
onPaste	`ClipboardEventHandler<HTMLInputElement>`
Handler that is called when the user pastes text. See MDN (opens in new tab).
onPointerCancel	`PointerEventHandler<HTMLDivElement>`
onPointerCancelCapture	`PointerEventHandler<HTMLDivElement>`
onPointerDown	`PointerEventHandler<HTMLDivElement>`
onPointerDownCapture	`PointerEventHandler<HTMLDivElement>`
onPointerEnter	`PointerEventHandler<HTMLDivElement>`
onPointerLeave	`PointerEventHandler<HTMLDivElement>`
onPointerMove	`PointerEventHandler<HTMLDivElement>`
onPointerMoveCapture	`PointerEventHandler<HTMLDivElement>`
onPointerOut	`PointerEventHandler<HTMLDivElement>`
onPointerOutCapture	`PointerEventHandler<HTMLDivElement>`
onPointerOver	`PointerEventHandler<HTMLDivElement>`
onPointerOverCapture	`PointerEventHandler<HTMLDivElement>`
onPointerUp	`PointerEventHandler<HTMLDivElement>`
onPointerUpCapture	`PointerEventHandler<HTMLDivElement>`
onScroll	`UIEventHandler<HTMLDivElement>`
onScrollCapture	`UIEventHandler<HTMLDivElement>`
onSelect	`ReactEventHandler<HTMLInputElement>`
Handler that is called when text in the input is selected. See MDN (opens in new tab).
onSubmit	`((value: string) => void)`
Handler that is called when the SearchField is submitted.
onTouchCancel	`TouchEventHandler<HTMLDivElement>`
onTouchCancelCapture	`TouchEventHandler<HTMLDivElement>`
onTouchEnd	`TouchEventHandler<HTMLDivElement>`
onTouchEndCapture	`TouchEventHandler<HTMLDivElement>`
onTouchMove	`TouchEventHandler<HTMLDivElement>`
onTouchMoveCapture	`TouchEventHandler<HTMLDivElement>`
onTouchStart	`TouchEventHandler<HTMLDivElement>`
onTouchStartCapture	`TouchEventHandler<HTMLDivElement>`
onTransitionCancel	`TransitionEventHandler<HTMLDivElement>`
onTransitionCancelCapture	`TransitionEventHandler<HTMLDivElement>`
onTransitionEnd	`TransitionEventHandler<HTMLDivElement>`
onTransitionEndCapture	`TransitionEventHandler<HTMLDivElement>`
onTransitionRun	`TransitionEventHandler<HTMLDivElement>`
onTransitionRunCapture	`TransitionEventHandler<HTMLDivElement>`
onTransitionStart	`TransitionEventHandler<HTMLDivElement>`
onTransitionStartCapture	`TransitionEventHandler<HTMLDivElement>`
onWheel	`WheelEventHandler<HTMLDivElement>`
onWheelCapture	`WheelEventHandler<HTMLDivElement>`

Name	Type	Default
autoComplete	`string`
Describes the type of autocomplete functionality the input should provide if any. See MDN (opens in new tab).
defaultValue	`string`
The default value (uncontrolled).
errorMessage	`string \| ((validation: ValidationResult) => string)`
form	`string`
The `<form>` element to associate the input with. The value of this attribute must be the id of a `<form>` in the same document. See MDN (opens in new tab).
maxLength	`number`
The maximum number of characters supported by the input. See MDN (opens in new tab).
minLength	`number`
The minimum number of characters required by the input. See MDN (opens in new tab).
name	`string`
The name of the input element, used when submitting an HTML form. See MDN (opens in new tab).
pattern	`string`
Regex pattern that the value of the input must match to be valid. See MDN (opens in new tab).
placeholder	`string`
type	`"email" \| "password" \| "search" \| "tel" \| "text" \| "url" \| (string & {})`	`'search'`
The type of input to render. See MDN (opens in new tab).
validate	`((value: string) => true \| ValidationError \| null)`
A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if `validationBehavior="native"`. For realtime validation, use the `isInvalid` prop instead.
validationBehavior	`"aria" \| "native"`	`'native'`
Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.
value	`string`
The current value (controlled).

Name	Type	Default
className	`ClassNameOrFunction<SearchFieldRenderProps>`	`'react-aria-SearchField'`
The CSS className (opens in new tab) for the element. A function may be provided to compute the class based on component state.
style	`StyleOrFunction<SearchFieldRenderProps>`
The inline style (opens in new tab) for the element. A function may be provided to compute the style based on component state.

SearchField

Name	Type	Default
children	`ChildrenOrFunction<SearchFieldRenderProps>`
The children of the component. A function may be provided to alter the children based on component state.
inputMode	`"decimal" \| "email" \| "none" \| "numeric" \| "search" \| "tel" \| "text" \| "url"`
Hints at the type of data that might be entered by the user while editing the element or its contents. See MDN (opens in new tab).
isDisabled	`boolean`
Whether the input is disabled.
isInvalid	`boolean`
Whether the input value is invalid.
isReadOnly	`boolean`
Whether the input can be selected but not changed by the user.
isRequired	`boolean`
Whether user input is required on the input before form submission.

Name	Type	Default
aria-activedescendant	`string`
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-autocomplete	`"both" \| "inline" \| "list" \| "none"`
Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
aria-controls	`string`
Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-describedby	`string`
Identifies the element (or elements) that describes the object.
aria-details	`string`
Identifies the element (or elements) that provide a detailed, extended description for the object.
aria-errormessage	`string`
Identifies the element that provides an error message for the object.
aria-haspopup	`"dialog" \| "false" \| "grid" \| "listbox" \| "menu" \| "tree" \| "true" \| boolean`
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-label	`string`
Defines a string value that labels the current element.
aria-labelledby	`string`
Identifies the element (or elements) that labels the current element.
id	`string`
The element's unique identifier. See MDN (opens in new tab).

Name	Type	Default
autoCorrect	`string`
An attribute that takes as its value a space-separated string that describes what, if any, type of autocomplete functionality the input should provide. See MDN (opens in new tab).
autoFocus	`boolean`
Whether the element should receive focus on render.
dir	`string`
enterKeyHint	`"done" \| "enter" \| "go" \| "next" \| "previous" \| "search" \| "send"`
An enumerated attribute that defines what action label or icon to preset for the enter key on virtual keyboards. See MDN (opens in new tab).
excludeFromTabOrder	`boolean`
Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available.
hidden	`boolean`
inert	`boolean`
lang	`string`
render	`DOMRenderFunction<"div", SearchFieldRenderProps>`
Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). Only a single root DOM element can be rendered (no fragments). You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.
slot	`string \| null`
A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.
spellCheck	`string`
An enumerated attribute that defines whether the element may be checked for spelling errors. See MDN (opens in new tab).
suppressHydrationWarning	`boolean`
A React-only flag that suppresses the warning React normally logs when an element's server-rendered content doesn't match the client render during hydration. See React docs (opens in new tab).
translate	`"no" \| "yes"`

Name	Type	Default
onAnimationEnd	`AnimationEventHandler<HTMLDivElement>`
onAnimationEndCapture	`AnimationEventHandler<HTMLDivElement>`
onAnimationIteration	`AnimationEventHandler<HTMLDivElement>`
onAnimationIterationCapture	`AnimationEventHandler<HTMLDivElement>`
onAnimationStart	`AnimationEventHandler<HTMLDivElement>`
onAnimationStartCapture	`AnimationEventHandler<HTMLDivElement>`
onAuxClick	`MouseEventHandler<HTMLDivElement>`
onAuxClickCapture	`MouseEventHandler<HTMLDivElement>`
onBeforeInput	`FormEventHandler<HTMLInputElement>`
Handler that is called when the input value is about to be modified. See MDN (opens in new tab).
onBlur	`((e: FocusEvent<HTMLInputElement, Element>) => void)`
Handler that is called when the element loses focus.
onChange	`((value: string) => void)`
Handler that is called when the value changes.
onClear	`(() => void)`
Handler that is called when the clear button is pressed.
onClick	`MouseEventHandler<HTMLDivElement>`
onClickCapture	`MouseEventHandler<HTMLDivElement>`
onCompositionEnd	`CompositionEventHandler<HTMLInputElement>`
Handler that is called when a text composition system completes or cancels the current text composition session. See MDN (opens in new tab).
onCompositionStart	`CompositionEventHandler<HTMLInputElement>`
Handler that is called when a text composition system starts a new text composition session. See MDN (opens in new tab).
onCompositionUpdate	`CompositionEventHandler<HTMLInputElement>`
Handler that is called when a new character is received in the current text composition session. See MDN (opens in new tab).
onContextMenu	`MouseEventHandler<HTMLDivElement>`
onContextMenuCapture	`MouseEventHandler<HTMLDivElement>`
onCopy	`ClipboardEventHandler<HTMLInputElement>`
Handler that is called when the user copies text. See MDN (opens in new tab).
onCut	`ClipboardEventHandler<HTMLInputElement>`
Handler that is called when the user cuts text. See MDN (opens in new tab).
onDoubleClick	`MouseEventHandler<HTMLDivElement>`
onDoubleClickCapture	`MouseEventHandler<HTMLDivElement>`
onFocus	`((e: FocusEvent<HTMLInputElement, Element>) => void)`
Handler that is called when the element receives focus.
onFocusChange	`((isFocused: boolean) => void)`
Handler that is called when the element's focus status changes.
onGotPointerCapture	`PointerEventHandler<HTMLDivElement>`
onGotPointerCaptureCapture	`PointerEventHandler<HTMLDivElement>`
onInput	`FormEventHandler<HTMLInputElement>`
Handler that is called when the input value is modified. See MDN (opens in new tab).
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.
onLostPointerCapture	`PointerEventHandler<HTMLDivElement>`
onLostPointerCaptureCapture	`PointerEventHandler<HTMLDivElement>`
onMouseDown	`MouseEventHandler<HTMLDivElement>`
onMouseDownCapture	`MouseEventHandler<HTMLDivElement>`
onMouseEnter	`MouseEventHandler<HTMLDivElement>`
onMouseLeave	`MouseEventHandler<HTMLDivElement>`
onMouseMove	`MouseEventHandler<HTMLDivElement>`
onMouseMoveCapture	`MouseEventHandler<HTMLDivElement>`
onMouseOut	`MouseEventHandler<HTMLDivElement>`
onMouseOutCapture	`MouseEventHandler<HTMLDivElement>`
onMouseOver	`MouseEventHandler<HTMLDivElement>`
onMouseOverCapture	`MouseEventHandler<HTMLDivElement>`
onMouseUp	`MouseEventHandler<HTMLDivElement>`
onMouseUpCapture	`MouseEventHandler<HTMLDivElement>`
onPaste	`ClipboardEventHandler<HTMLInputElement>`
Handler that is called when the user pastes text. See MDN (opens in new tab).
onPointerCancel	`PointerEventHandler<HTMLDivElement>`
onPointerCancelCapture	`PointerEventHandler<HTMLDivElement>`
onPointerDown	`PointerEventHandler<HTMLDivElement>`
onPointerDownCapture	`PointerEventHandler<HTMLDivElement>`
onPointerEnter	`PointerEventHandler<HTMLDivElement>`
onPointerLeave	`PointerEventHandler<HTMLDivElement>`
onPointerMove	`PointerEventHandler<HTMLDivElement>`
onPointerMoveCapture	`PointerEventHandler<HTMLDivElement>`
onPointerOut	`PointerEventHandler<HTMLDivElement>`
onPointerOutCapture	`PointerEventHandler<HTMLDivElement>`
onPointerOver	`PointerEventHandler<HTMLDivElement>`
onPointerOverCapture	`PointerEventHandler<HTMLDivElement>`
onPointerUp	`PointerEventHandler<HTMLDivElement>`
onPointerUpCapture	`PointerEventHandler<HTMLDivElement>`
onScroll	`UIEventHandler<HTMLDivElement>`
onScrollCapture	`UIEventHandler<HTMLDivElement>`
onSelect	`ReactEventHandler<HTMLInputElement>`
Handler that is called when text in the input is selected. See MDN (opens in new tab).
onSubmit	`((value: string) => void)`
Handler that is called when the SearchField is submitted.
onTouchCancel	`TouchEventHandler<HTMLDivElement>`
onTouchCancelCapture	`TouchEventHandler<HTMLDivElement>`
onTouchEnd	`TouchEventHandler<HTMLDivElement>`
onTouchEndCapture	`TouchEventHandler<HTMLDivElement>`
onTouchMove	`TouchEventHandler<HTMLDivElement>`
onTouchMoveCapture	`TouchEventHandler<HTMLDivElement>`
onTouchStart	`TouchEventHandler<HTMLDivElement>`
onTouchStartCapture	`TouchEventHandler<HTMLDivElement>`
onTransitionCancel	`TransitionEventHandler<HTMLDivElement>`
onTransitionCancelCapture	`TransitionEventHandler<HTMLDivElement>`
onTransitionEnd	`TransitionEventHandler<HTMLDivElement>`
onTransitionEndCapture	`TransitionEventHandler<HTMLDivElement>`
onTransitionRun	`TransitionEventHandler<HTMLDivElement>`
onTransitionRunCapture	`TransitionEventHandler<HTMLDivElement>`
onTransitionStart	`TransitionEventHandler<HTMLDivElement>`
onTransitionStartCapture	`TransitionEventHandler<HTMLDivElement>`
onWheel	`WheelEventHandler<HTMLDivElement>`
onWheelCapture	`WheelEventHandler<HTMLDivElement>`

Name	Type	Default
autoComplete	`string`
Describes the type of autocomplete functionality the input should provide if any. See MDN (opens in new tab).
defaultValue	`string`
The default value (uncontrolled).
form	`string`
The `<form>` element to associate the input with. The value of this attribute must be the id of a `<form>` in the same document. See MDN (opens in new tab).
maxLength	`number`
The maximum number of characters supported by the input. See MDN (opens in new tab).
minLength	`number`
The minimum number of characters required by the input. See MDN (opens in new tab).
name	`string`
The name of the input element, used when submitting an HTML form. See MDN (opens in new tab).
pattern	`string`
Regex pattern that the value of the input must match to be valid. See MDN (opens in new tab).
type	`"email" \| "password" \| "search" \| "tel" \| "text" \| "url" \| (string & {})`	`'search'`
The type of input to render. See MDN (opens in new tab).
validate	`((value: string) => true \| ValidationError \| null)`
A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if `validationBehavior="native"`. For realtime validation, use the `isInvalid` prop instead.
validationBehavior	`"aria" \| "native"`	`'native'`
Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.
value	`string`
The current value (controlled).

Name	Type	Default
className	`ClassNameOrFunction<SearchFieldRenderProps>`	`'react-aria-SearchField'`
The CSS className (opens in new tab) for the element. A function may be provided to compute the class based on component state.
style	`StyleOrFunction<SearchFieldRenderProps>`
The inline style (opens in new tab) for the element. A function may be provided to compute the style based on component state.

SearchInput

Props

SearchInput

Accessibility (10)(10 props)

Advanced (14)(14 props)

Events (81)(81 props)

Forms (13)(13 props)

Styling (2)(2 props)

SearchField

Accessibility (10)(10 props)

Advanced (13)(13 props)

Events (81)(81 props)

Forms (11)(11 props)

Styling (2)(2 props)