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.
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.
The delimiting character used for the multi-value field referenced by the field option.
data-category-field-delimiting-character=';' data-category-field-delimiting-character='#'
Whether to display an estimate of the number of results for each scoped query suggestions.
Notes:
true has no effect when the templateHelper options is set.data-display-estimate-number-of-results='true' data-display-estimate-number-of-results='false'
An advanced query expression to add when requesting facet value suggestions.
Set this option to ensure that the suggestions are properly scoped when using the component with a standalone search box. For instance, if a certain tab is automatically selected in the search interface the standalone search box is redirecting its queries to, you should set this option to that tab's expression.
data-expression='@objecttype==Message'
The field on whose values the scoped query suggestions should be based.
data-field='@productcategory'
Whether the field option references a multi-value field.
Setting this option to true if appropriate will allow the corresponding CategoryFacet or DynamicHierarchicalFacet component (if present) to properly handle the filter format.
See also the categoryFieldDelimitingCharacter option.
data-is-category-field='true' data-is-category-field='false'
The maximum number of suggestions to render in the Omnibox.
data-number-of-suggestions='10'
The template helper function to execute when rendering each scoped query suggestion.
If specified, the function must have the following signature: (row: IFacetValueSuggestionRow, omnibox: Omnibox) => string
If not specified, a default function will be used.
Note: You cannot set this option directly in the component markup as an HTML attribute. You must either set it:
init call of your search interface (see Passing Component Options in the init Callinit call, using the options top-level function (see Passing Component Options Before the init Call).Example:
Coveo.init(document.getElementById('search'), {
FacetValueSuggestions: {
templateHelper: (row, omnibox) => { return `Searching for <strong>${row.keyword}</strong> in category <em>${row.value}</em>`; }
}
})
Whether to get scoped query suggestions from the current Coveo ML query suggestions.
Notes:
true, the enableQuerySuggestAddon option of the Omnibox component must be set to true as well.true, an additional POST HTTP request is sent to https://platform.cloud.coveo.com/rest/search/v2/querySuggest.data-use-query-suggestions='true' data-use-query-suggestions='false'
Whether to get scoped query suggestions from the current user query entered in the search box.
Default: true if useQuerySuggestions is false; false otherwise
data-use-value-from-searchbox='true' data-use-value-from-searchbox='false'
Creates a new FacetValueSuggestions component.
The HTMLElement on which to instantiate the component.
The options for the FacetValueSuggestions component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).
This component provides
Omniboxquery suggestions scoped to distinct categories based on the values of a specificfieldwhose Facet option is enabled.May 2018 Release (v2.4094.8)
Providing Facet Value Suggestions