SearchBox

A searchbox component

Installation

import { SearchBox } from 'uxp/components';

Signature

const SearchBox: React.ForwardRefExoticComponent<React.RefAttributes<ISearchBoxInstanceProps> & ISearchBoxProps>

Properties

Name	Type	Mandatory	Default Value	Example Value
value	string	Yes	-	-
onChange	(newValue: string) => void	Yes	-	-
className	string	No	-	-
collapsed	boolean	No	-	-
position	IPosition	No	-	-
placeholder	string	No	-	-
autoFocus	boolean	No	-	-
spacingMode	SpacingMode	No	-	-

Ref Handlers

Available methods through ref:

Method	Type	Description
focusInput	() => void	-
getInputElement	() => React.MutableRefObject	-

Related Types

• ISearchBoxProps

• IPosition

• SpacingMode

• ISearchBoxInstanceProps