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 caption to show on the badge for results promoted by a featured results query pipeline rule.
Default value is the localized string for Featured.
data-caption-for-featured='Recommended by ACME'
The caption to show on the badge for results promoted by Coveo ML ART.
Default value is the localized string for Recommended.
data-caption-for-recommended='Recommended by Coveo ML'
The badge color for results promoted by a featured results query pipeline rule.
Can be specified using:
Default value is controlled through the default stylesheet of the framework.
data-color-for-featured-results='#f58020' data-color-for-featured-results='rgb(125 10 36)' data-color-for-featured-results='red'
The badge color for results promoted by Coveo ML ART.
Can be specified using:
Default value is controlled through the default stylesheet of the framework.
data-color-for-recommended-results='#f58020' data-color-for-recommended-results='rgb(125 10 36)' data-color-for-recommended-results='red'
Whether to show a badge when a result was promoted by a featured results query pipeline rule.
data-show-badge-for-featured-results='true' data-show-badge-for-featured-results='false'
Whether to show a badge when a result was promoted by Coveo ML ART.
data-show-badge-for-recommended-results='true' data-show-badge-for-recommended-results='false'
Create a new Component. Resolve all IComponentBindings if not provided.
Create a new Logger for this component.
Attach the component to the SearchInterface.
The HTMLElement on which to create the component. Used to bind data on the element.
The unique identifier for this component. See: IComponentDefinition.ID. Used to generate the unique Coveo CSS class associated with every component.
The environment for every component. Optional, but omitting to provide one will impact performance.
Depending on its configuration, this component will render badges on query result items whose ranking scores were increased by featured results query pipeline rules and/or Coveo ML ART.
This component can be put anywhere in the markup configuration of a search interface. However, it is meant to be initialized only once, and should thus never be included in a result template.
July 2018 Release (v2.4382.10)
Adding Promoted Results Badges