Coveo StarRating Component (CoveoStarRating)

The StarRating component renders a five-star rating widget for use in commerce result templates.

Available since

January 2020 Release (v2.7968)

Result template component

This component is intended to be used in result templates

Index

Methods

debugInfo

  • debugInfo(): any

disable

  • disable(): void
  • 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.

    Returns void

enable

  • enable(): void
  • 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.

    Returns void

getBindings

Static get

  • get(element: HTMLElement, componentClass?: any, noThrow?: boolean): BaseComponent
  • 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.

    Parameters

    • element: HTMLElement

      HTMLElement for which to get the bound component.

    • Optional componentClass: any

      Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.

    • Optional noThrow: boolean

      Boolean option to tell the method to not throw on error.

    Returns BaseComponent

Properties

bind

Allows the component to bind events and execute them only when it is enabled.

type

{Coveo.ComponentEvents}

componentOptionsModel

componentOptionsModel: ComponentOptionsModel

Contains the state of options for different components. Mainly used by ResultLink.

componentStateModel

componentStateModel: ComponentStateModel

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.

disabled

disabled: boolean

A disabled component will not participate in the query, or listen to ComponentEvents.

type

{boolean}

logger

logger: Logger

Allows component to log in the dev console.

queryController

queryController: QueryController

Contains the singleton that allows to trigger queries.

queryStateModel

queryStateModel: QueryStateModel

Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.

root

root: HTMLElement

A reference to the root HTMLElement (the SearchInterface).

searchInterface

searchInterface: SearchInterface

A reference to the root of every component, the SearchInterface.

Static ID

ID: string

The static ID that each component need to be identified.
For example, SearchButton -> static ID : SearchButton -> className : CoveoSearchButton

Accessors

usageAnalytics

Component Options

numberOfRatingsField

numberOfRatingsField: IFieldOption

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.

Markup configuration example(s) :
data-number-of-ratings-field='@foo'

ratingField

ratingField: IFieldOption

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.

Required

Specifying a value for this option is required for the component to work

Markup configuration example(s) :
data-rating-field='@foo'

ratingScale

ratingScale: number

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).

Minimum

1

Maximum

100000

Default

5

Markup configuration example(s) :
data-rating-scale='10'

Constructors

constructor