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.
A numeric field whose value should be used to display the total number of ratings label for the result item.
If unspecified, no number of ratings label is displayed. If the numberOfRatingsField's value is 0 or less, a (No Ratings) label is displayed.
data-number-of-ratings-field='@foo'
Specifies the rating to be displayed as stars. If the rating is on a different scale than 0-5, a ratingScale value must be provided.
data-rating-field='@foo'
The scale to apply to the ratingField's value. Must be smaller than or equal to the highest possible ratingField's value.
Example: If the ratingScale is 100 and the current ratingField's value is 75, the component will render 3 stars (i.e., 75 * (5 / 100), rounded down).
data-rating-scale='10'
Creates a new StarRating component.
The HTMLElement on which to instantiate the component.
The options for the StarRating component.
The bindings that the component requires to function normally.
The
StarRatingcomponent renders a five-star rating widget for use in commerce result templates.January 2020 Release (v2.7968)
This component is intended to be used in result templates