Coveo PromotedResultsBadge Component (CoveoPromotedResultsBadge)

The PromotedResultsBadge component adds a badge to promoted results in your interface.

To be considered promoted, a result needs to either:

You can add this component anywhere in your search interface. The component will then add a badge to your results after they have been rendered.

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

captionForFeatured

captionForFeatured: string

Specifies the caption that should be used for "Featured Results".

Default value is the localized string for Featured.

Only effective when

showBadgeForFeaturedResults is set to true

Markup configuration example(s) :
data-caption-for-featured='foo'

captionForRecommended

captionForRecommended: string

Specifies the caption that should be used for "Recommended Results".

Default value is the localized string for Recommended.

Only effective when

showBadgeForRecommendedResults is set to true

Markup configuration example(s) :
data-caption-for-recommended='foo'

colorForFeaturedResults

colorForFeaturedResults: string

Specifies the color that should be used for "Featured Results".

This can be specified using:

  • a hexadecimal value (e.g., #f58020)
  • an RGB value (e.g., rgb(125,10,36))
  • a CSS color name (e.g., red)

Default value is undefined, and 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='foo'

colorForRecommendedResults

colorForRecommendedResults: string

Specifies the color that should be used for "Recommended Results".

This can be specified using:

  • a hexadecimal value (e.g., #f58020)
  • an RGB value (e.g., rgb(125,10,36))
  • a CSS color name (e.g., red)

Default value is undefined, and 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='foo'

showBadgeForFeaturedResults

showBadgeForFeaturedResults: boolean

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

Default

true

Additional documentation

Adding and Managing Query Pipeline Featured Results

Default value is 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 a Coveo ML ART model.

Default

false

Additional documentation

(Automatic Relevance Tuning (ART) Feature)[https://docs.coveo.com/en/1671/#automatic-relevance-tuning-art-feature]

Default value is false.

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

Constructors

constructor