API Reference › core-react› SearchBox › SearchBoxProps

SearchBoxProps Interface

Deprecated  in 4.12.0. Props of deprecated component SearchBox.

Properties for SearchBox component

Extends

Properties

Name Type Description
initialValue string | undefined Value to set SearchBox to initially  
onClear () => void | undefined Listens for onClick event for Clear (x) icon  
onEnterPressed () => void | undefined Listens for keypress  
onEscPressed () => void | undefined Listens for keypress  
onValueChanged (value: string) => void Triggered when the content of SearchBox is changed  
placeholder string | undefined Placeholder value to show in gray before anything is entered in  
valueChangedDelay number | undefined Frequency to poll for changes in value, in milliseconds  

Inherited properties

Name Type Inherited from Description
className string | undefined CommonProps Custom CSS class name
itemId string | undefined CommonProps Optional unique identifier for item.
style React.CSSProperties | undefined CommonProps Custom CSS style properties

Defined in

Last Updated: 14 November, 2024