FilterMenuSearchInput API

API reference docs for theFilterMenuSearchInputcomponent. For examples and details on the usage of this component, visit the component demo page.

Props​

The FilterMenuSearchInput component internally uses SearchInput component. It inherits most of the SearchInput props and adds few more functionalities.

Prop

Type

Description

Default

aria-activedescendant?

string

identifies the currently active element when using ARIA widgets.

_

aria-autocomplete?

'inline' | 'list' | 'both' | 'none'

Indicates whether input completion suggestions are provided, and their type.

_

aria-controls?

string

Identifies the element(s) that the input controls.

_

aria-expanded?

boolean

Indicates whether the popover is currently expanded or collapsed.

_

aria-haspopup?

'dialog' | 'grid' | 'listbox' | 'menu' | 'tree' | 'boolean'

Indicates the availability of a popup related to the input.

_

autoComplete?

string

Specifies whether autocomplete is enabled for the input.

_

autoCorrect?

'on' | 'off'

Specifies whether auto-correction is enabled for the input.

_

autoFocus?

boolean

Automatically focuses the input element when it is rendered.

_

defaultValue?

string

Specifies the initial value of the input for uncontrolled input.

_

focusContainerRef?

React.Ref<HTMLDivElement>

Reference to the wrapper FocusContainer element.

_

inputMode?

'none' | 'text' | 'tel' | 'url' | 'email' | 'numeric' | 'decimal' | 'search'

Hints to browsers about what kind of virtual keyboard to display.

_

name?

string

Name of the input, used for form submissions.

_

onBlur?

function

Function to be invoked when the input loses focus.

_

onChange?

function

Function to be invoked when a new item is selected.

_

onFocus?

function

Function to be invoked when the input is focused.

_

onKeyDown?

function

Function to be invoked when a key is pressed while the input is focused.

_

onPaste?

function

Function to be invoked when content is pasted into the input.

_

pattern?

string

Regular expression pattern the input's value must match for validation.

_

placeholder?

string

Placeholder text displayed when the input is empty.

_

role?

string

ARIA role for the input.

_

spellCheck?

boolean

Specifies whether the input value should be checked for spelling errors.

_

type?

'email' | 'password' | 'search' | 'tel' | 'text' | 'url'

Type of the input element.

_

value?

string

Specifies the current value for controlled inputs.

_