The FieldSuggestions component provides query suggestions based on a particular facet field. For example, you could use this component to provide auto-complete suggestions while the end user is typing a document title.
The query suggestions that this component provides appear in the Omnibox component.
Specifies the field from which to provide suggestions.
Specifying a value for this option is required for the FieldSuggestions component to work.
Default value is the localized string for
Specifies the number of suggestions to render in the Omnibox.
Default value is
5. Minimum value is
Specifies the z-index position at which the suggestions render themselves in the Omnibox.
Default value is
51. Minimum value is
Specifies the event handler function to execute when the end user selects a suggested value un the Omnibox. By default, the query box text is replaced by what the end user selected and a new query is executed. You can, however, replace this default behavior by providing a callback function to execute when the value is selected.
You can only set this option in the
init call of your search interface. You cannot set it directly in the
markup as an HTML attribute.
Specifies a query override to apply when retrieving suggestions. You can use any valid query expression (see Coveo Query Syntax Reference).
Default value is
'', which means that the component applies no query override by default.
Return the debug info about this component.
Disable the component. Normally this means that the component will not execute handlers for the framework events (query events, for example). Component are enabled by default on creation.
Enable the component. Normally this means that the component will execute handlers for the framework events (query events, for example). Components are enabled by default on creation.
Return the bindings, or environment, for the current component.
Selects a currently displayed query suggestion. This implies that at least one suggestion must have been returned at least once.
Either a number (0-based index position of the query suggestion to select) or a string that matches the suggestion to select.
Get the bound component to the given HTMLElement. Throws an assert if the HTMLElement has no component bound, unless using the noThrow argument.
If there is multiple component bound to the current HTMLElement, you must specify the component class.
HTMLElement for which to get the bound component.
Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.
Boolean option to tell the method to not throw on error.
Allows the component to bind events and execute them only when it is enabled.
Contains the state of options for differents component. Mainly used by ResultLink.
Contains the state of different component (enabled vs disabled). Allows to get/set values. Trigger component state event when modified. Each component can listen to those events.
A disabled component will not participate in the query, or listen to ComponentEvents.
Allows component to log in the dev console.
Contains the singleton that allows to trigger queries.
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
A reference to the root HTMLElement (the SearchInterface).
A reference to the root of every component, the SearchInterface.
A reference to the Analytics.client.
The static ID that each component need to be identified.
For example, SearchButton -> static ID : SearchButton -> className : CoveoSearchButton
Creates a new FieldSuggestions component.
The HTMLElement on which to instantiate the component.
The options for the FieldSuggestions component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).