Search box Web Part¶
The 'Search box' Web Part allows users to enter free text search queries connected to a 'Search Results' Web Part.
Configuration¶
Search box settings¶
| Setting | Description | Default value |
|---|---|---|
| Placeholder text | The placeholder text to display in the search box. | "Enter your search terms..." |
| Query input transformation template | Query that will be sent to the page as URL fragment (#) |
Search box keyword entered by the user. |
| Send the query to a new page | Sends the search query text to a new page. From here you can select the page URL, the open behavior and send method (URL fragment '#' or a query string parameter). The input value can be transformed before sending it to another page. {inputQueryText} is replaced with the value from the search box and other tokens are also supported. |
False. |
| Reset query on clear | Sends new search query request when clear search query from search box. | False. |
Query suggestions¶
The query suggestions allows users to easily find relevant query keywords based on their entry:
| Setting | Description | Default value |
|---|---|---|
| Enable query suggestions | Enable or disable query suggestions. | False. |
| Configure available providers | Enable or disable the suggestions providers available for this Web Part. By default, only the "SharePoint Static search suggestions" is available (disabled by default).
|
|
| Number of suggestions to show per group | The number of suggestions to show per group. | 10. |
Connections¶
Optionally, you can set a default query text coming from an other dynamic data source on the page. For instance, connect the search box to a page environment variable like a query string parameter. The value retrieved from a connected data source will be displayed automatically at page load in the text box if present and broadcasted to any other Web Parts connected to the search box Web Part (ex: a 'Search Results' Web Part) resulting to a cascading effect.