SearchBox control (preview)
[This article is pre-release documentation and is subject to change.]
A control used to create a search experience.
A search box (
SearchBox) provides an input field for searching within a site or app to find specific items.
This code component provides a wrapper around the Fluent UI SearchBox control for use in canvas & custom pages.
- This is a preview feature.
- Preview features aren’t meant for production use and may have restricted functionality. These features are available before an official release so that customers can get early access and provide feedback.
||Text that is input by the user. Refer to this as the input for search functions.|
||Name of the Fluent UI icon (see Fluent UI Icons).|
||Whether or not the SearchBox is underlined.|
||Whether or not to animate the SearchBox icon on focus.|
||Placeholder for the search box.|
||The Theme object (not Json formatted). See theming for guidance on how to configure.|
||Screen reader aria-label.|
||An event to send to the control. E.g.
Configure search behavior
Add this control to your app where a search interface is needed, usually coupled with a gallery,
DetailsList, or any control that can display a dataset.
Create a search experience by using the Search() or Filter() expressions that use the value of the
SearchText property in the
Search( Accounts, SearchBox.SearchText, "name" )
This code component can only be used in canvas apps and custom pages.
Submit and view feedback for