The ResultsPreferences component allows the end user to select preferences related to the search results. These preferences are then saved in the local storage of the end user.
See also the ResultsFiltersPreferences component.
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.
Saves the current state of the ResultsPreferences component in the local storage.
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
Specifies whether to make the option to open results in a new window available.
Default value is
Specifies whether to make the option to open results in Microsoft Outlook available.
Default value is
Specifies whether to make the option to allow end users to turn query syntax on or off available.
If query syntax is enabled, the Coveo Platform tries to interpret special query syntax (e.g.,
@objecttype=message) when the end user types a query in the
Coveo Query Syntax Reference). Enabling query
syntax also causes the
Querybox to highlight any query syntax.
Selecting On for the Enable query syntax setting enables query syntax, whereas selecting Off disables
it. Selecting Automatic uses the
option value (which is
false by default).
Default value is
Creates a new ResultsPreference component.
The HTMLElement on which to instantiate the component.
The options for the ResultsPreferences component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).