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). Components 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 different components. Mainly used by ResultLink.
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers 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.
The static ID that each component needs in order to be identified.
For example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
Specifies the facet field from which to provide suggestions.
Specifying a value for this option is required for the FieldSuggestions component to work.
data-field='@foo'
Specifies the title of the result suggestions group in the Omnibox component.
If not provided, the component will simply not output any title.
Default value is null.
data-header-title='foo'
Specifies the number of suggestions to render in the Omnibox.
Default value is 5. Minimum value is 1.
data-number-of-suggestions='10'
Specifies the z-index position at which the suggestions render themselves in the Omnibox.
When there are multiple suggestion providers, components with higher omniboxZIndex values render themselves
first.
Default value is 51. Minimum value is 0.
data-omnibox-z-index='10'
Specifies the event handler function to execute when the end user selects a suggested value in 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.
Note:
You cannot set this option directly in the component markup as an HTML attribute. You must either set it in the
initcall of your search interface (see Passing Component Options in the init Call), or before theinitcall, using theoptionstop-level function (see Passing Component Options Before the init Call).
Example:
var myOnSelectFunction = function(selectedValue, populateOmniboxEventArgs) {
// Close the suggestion list when the user clicks a suggestion.
populateOmniboxEventArgs.closeOmnibox();
// Search for matching title results in the default endpoint.
Coveo.SearchEndpoint.endpoints["default"].search({
q: "@title==" + selectedValue
}).done(function(results) {
// If more than one result is found, select a result that matches the selected title.
var foundResult = Coveo._.find(results.results, function(result) {
return selectedValue == result.raw.title;
});
// Open the found result in the current window, or log an error.
if (foundResult) {
window.location = foundResult.clickUri;
}
else {
new Coveo.Logger.warn("Selected suggested result '" + selectedValue + "' not found.");
}
});
};
// You can set the option in the 'init' call:
Coveo.init(document.querySelector("#search"), {
FieldSuggestions : {
onSelect : myOnSelectFunction
}
});
// Or before the 'init' call, using the 'options' top-level function:
// Coveo.options(document.querySelector("#search"), {
// FieldSuggestions : {
// onSelect : myOnSelectFunction
// }
// });
Specifies a query override to apply when retrieving suggestions. You can use any valid query expression (see Coveo Query Syntax Reference).
Default value is the empty string, and the component applies no query override.
data-query-override='foo'
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).
The
FieldSuggestionscomponent 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 the title of an item.The query suggestions provided by this component appear in the
Omniboxcomponent.Note: Consider providing Coveo ML query suggestions rather than field suggestions, as the former yields better performance and relevance.