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.
The list of notifications returned by the Search API for the current query (via notify triggers).
The Triggers component automatically renders this list visually.
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.
Creates a new Triggers component.
The HTMLElement on which to instantiate the component.
The options for the Triggers component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).
The window on which to execute the triggers.
The Triggers component enables the use of triggers (
notify,execute,query,redirect) generated by the Coveo Search API (see Trigger) in the query pipeline (see Managing the Query Pipeline).To enable the triggers functionality in your JavaScript Search Framework interface, incorporate a div with the
coveoTriggersclass. For example:<div class="coveoTriggers"></div>.Note: adding the Triggers component gives query pipeline administrators the power to influence users' search experience. Bad actors will be able to perform XSS attacks, or redirect users to dangerous sites. Make sure only individuals you trust have query pipeline edit privileges.