Skip to end of metadata
Go to start of metadata

This topic describes the properties that are available on the search component.

PropertyDescriptionDefault valueAdditional details
Results Scope
Filter expression rules Allows the use of the Rule Set Editor to define a filtering expression for the search component.  See Adding Filtering or Boosting Expressions.
Boost expression rules Allows the use of the Rule Set Editor to define boosting rules and assign different weight to them. It influences the results ranking. See Adding Filtering or Boosting Expressions.
Enable automatic boosting Allows the user to enable automatic boosting according to its current pattern .Disabled

This parameter is only available when the DMS is enabled.

See Using Automatic Boosting.

Filter results on the current context languageWhether or not to return the version of an item in the results list that matches the current language. For example, if the current language is English, then only the English version of items will be in the results list.Enabled 
Searchbox Suggestions
Query suggestions (not available on mobile layouts)Specifies whether or not omnibox query suggestions are displayed when a user types new text inside the query box.Selected 

Coveo Machine Learning (Coveo ML) Advanced Query Suggestions

Specifies whether or not Coveo ML suggests queries to the user.

EnabledSee Getting Started with Coveo Machine Learning.

Analytics Top Query Suggestions

Specifies whether or not top queries are suggested.Enabled 
Omnibox timeout (ms)Specifies the delay (in milliseconds) before the Omnibox cancels any deferred request that was pushed when providing suggestions for the omnibox.2000See Providing Suggestions for the Omnibox.
Search as you typeSpecifies whether or not a new query is automatically triggered when a user types new text inside the query box.Not selected 
Search as you type delay (ms)When search as you type is activated, specifies the delay in milliseconds before a new query is triggered when the user types new text inside the query box.500 
No search box suggestionsTurns off all query suggestions.Not selected 
Query Behavior
Enable partial match Specifies whether or not a query containing a large number of keywords is automatically converted to a partial match expression in order to match items containing only a subset of the keywords.Disabled 
Partial match number of keywordsWhen partial match is enabled, specifies the minimum number of keywords that must be present in the query to activate the partial match.5 
Partial match thresholdWhen partial match is enabled, specifies either an absolute or percentage value indicating the minimum number of keywords an item must contain in order to match the query.50%. 
Enable wildcardsSpecifies whether or not Coveo expands keywords containing wildcard characters (*) to the possible matching keywords to broaden the query.  See Using Wildcards in Queries
Enable question marksSpecifies whether or not Coveo expands keywords containing question mark characters (?) to the possible matching keywords to broaden the query. See  Using Wildcards in Queries
Enable lowercase operatorsSpecifies whether or not operators such as or, and, and true are treated as operators for the query when they are typed in lowercase.  
Paging
Pager locationThe location where the pager component is displayed in the search interface.

Bottom

  • Bottom: Bottom of the page.
  • Top: Top of the page.
  • Both: Top and bottom of the page.
  • None: No pager component is displayed.

The pager component is hidden when the Enable Infinite Scrolling option is enabled.

Number of results per pageThe number of search results displayed per page.

10

 

This value is ignored when the Enable Infinite Scrolling option is enabled.

This value is ignored when the Display Results Per Page option is enabled.

Enable navigation buttonWhether to display buttons to be able to browse between consecutive search result pages.Enabled 
Number of pages displayed in the pagerThe maximum number of page links that are displayed in the pager component.10 
Maximum number of pages displayed in the pagerThe maximum number of pages that are included in the pager.100 
Query Helpers
Enable search tipsWhether to display search tips when no results are returned.  
Only display search tips

Specifies to hide the information about the currently displayed range of results and only display the search tips instead.

  
Enable query auto-correctionWhether or not to correct automatically typos in a query.  
Infinite Scrolling
Enable infinite scrollingWhether or not to progressively load search results as you scroll through them.

Disabled

 
Infinite scroll page sizeThe number of additional search results to display when they are progressively loaded.10 
Layout
Display facetsWhether or not to display facet components for search results.Enabled 
Display the number of results per page pickerWhether or not to display the results per page picker.Enabled 
Display logoWhether or not to display the logo next to the search box.

Enabled

There is no logo in the mobile version.
Display the main search boxWhether or not to display the Search Box component.Enabled 
Display sorting componentsWhether or not to display Sort components for search results.Enabled 
Display a loading animation before the first query is executedWhether or not to display a loading animation while waiting for the first query to be executed successfully.Enabled 
Display query durationWhether or not to display the duration of a query.Enabled 
Display query summaryWhether or not to display the summary for the number of results found.Enabled 
Display breadcrumbsWhether or not to display breadcrumbs for search results.Enabled 
Display Did You MeanWhether or not to apply query corrections when applicable.

Enabled

When disabled, a query with a typo will not be automatically corrected.

Display the error reportWhether or not to display errors that occur during a query.Enabled 
Display the recommendations sectionWhether or not to displaythe recommendations section.Enabled 
Display the results listWhether or not to display search results.Enabled 
Display the tabs sectionWhether or not to display the tabs section.Enabled 
Searchbox Layout
Searchbox placeholder textSpecifies the text used as a placeholder in your search bar.  
Focus on searchbox after initializationSpecifies whether the searchbox gets the focus and is selected on initialization.Enabled 
Default Sort Options
Default sort typeSpecifies a criterion on which the component can sort the results.  
Default sort directionSpecifies the direction in which to sort. Can either be ascending or descending.
Default sort field Specifies a field and template on which the component can sort the results. Click on Edit Field to access the search bar, allowing you to select a specific field.
External Content
Names of External Content SourcesList of external content source names. You must add one source name per line.  
Analytics   
Enable Coveo Usage AnalyticsWhether the JavaScript Search events are tracked in Coveo Cloud Usage analytics.Enabled 
Coveo Usage Analytics custom metadataList of additional custom metadata you want to log in the Usage Analytics. See Adding Custom Metadata.
Enable Sitecore AnalyticsWhether the JavaScript Search events are tracked in Sitecore analytics.Disabled 
Analytics REST endpointThe relative URL of the REST endpoint that tracks analytics events./coveo/rest/v6/analytics. 
Advanced
Auto Trigger QueryWhether or not to automatically trigger a query when the search interface is loaded for the first time.Enabled 
Throw exception on validation error   
Excerpt lengthThe number of characters to display for the excerpt of each search result.200 
Enable historyWhether or not to keep an internal search state.

Enabled

 

This feature allows:

  • the use the Back and Forward buttons of the web browser as a way to go through the different search states (e.g. the Back button can be used to go back to a previous query)
  • the use the URL in the browser as a unique identifier of a query (e.g. the URL contains the query as well as facet and sort component selections)
Enable client-side loggingWhether or not to enable debugging traces in the user browser.Disabled 
Include bucket folders in search resultsWhether or not to include bucket folders in the search results.  
Include media folders in search resultsWhether or not to include media folders in the search results.  
Query pipeline nameSpecifies which query pipeline to use for queries.  
Rest uri endpointThe relative URL of the REST endpoint used to perform search queries./coveo/rest. 
Advanced Omnibox Options
Enable field suggestions after typing @ in a search boxSpecifies whether or not fields are suggested in the searchbox after entering "@".Disabled 
Enable field suggestions in searchboxSpecifies whether or not fields are suggested in the searchbox.Disabled 
Enable suggestions of query extensionsSpecifies whether or not the Omnibox suggests Query Extensions.DisabledSee Standard Query Extensions.
Id
Unique identifierSets a unique identifier to your search component.RandomThe default value is randomly computed using the $GenerateUniqueId token .
Parameters
Addtional parameters This field allows you to add custom parameters to the Coveo component. See Adding Custom Parameters with the Additional Parameters Field.