Coveo PromotedResultsBadge Component (CoveoPromotedResultsBadge)

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.

Available since

July 2018 Release (v2.4382.10)

Additional documentation

Adding Promoted Results Badges

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). Components 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 needs in order to be identified.
For example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton

Accessors

usageAnalytics

Component Options

captionForFeatured

captionForFeatured: string

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.

Only effective when

showBadgeForFeaturedResults is set to true

Markup configuration example(s) :
data-caption-for-featured='Recommended by ACME'

captionForRecommended

captionForRecommended: string

The caption to show on the badge for results promoted by Coveo ML ART.

Default value is the localized string for Recommended.

Only effective when

showBadgeForRecommendedResults is set to true

Markup configuration example(s) :
data-caption-for-recommended='Recommended by Coveo ML'

colorForFeaturedResults

colorForFeaturedResults: string

The badge color for results promoted by a featured results query pipeline rule.

Can be specified using:

  • a hexadecimal value
  • an RGB value
  • a CSS color name

Default value is controlled through the default stylesheet of the framework.

Only effective when

showBadgeForFeaturedResults is set to true

Markup configuration example(s) :
data-color-for-featured-results='#f58020'
data-color-for-featured-results='rgb(125 10 36)'
data-color-for-featured-results='red'

colorForRecommendedResults

colorForRecommendedResults: string

The badge color for results promoted by Coveo ML ART.

Can be specified using:

  • a hexadecimal value
  • an RGB value
  • a CSS color name

Default value is controlled through the default stylesheet of the framework.

Only effective when

showBadgeForRecommendedResults is set to true

Markup configuration example(s) :
data-color-for-recommended-results='#f58020'
data-color-for-recommended-results='rgb(125 10 36)'
data-color-for-recommended-results='red'

showBadgeForFeaturedResults

showBadgeForFeaturedResults: boolean

Whether to show a badge when a result was promoted by a featured results query pipeline rule.

Default

true

Markup configuration example(s) :
data-show-badge-for-featured-results='true'
data-show-badge-for-featured-results='false'

showBadgeForRecommendedResults

showBadgeForRecommendedResults: boolean

Whether to show a badge when a result was promoted by Coveo ML ART.

Default

false

Markup configuration example(s) :
data-show-badge-for-recommended-results='true'
data-show-badge-for-recommended-results='false'

Constructors

constructor