Support Menu

Coveo component Badge

Coveo Badge Component (CoveoBadge)

The Badge component outputs a field value with customizable colors and an icon preceding it.

This component is a result template component (see Result Templates). It extends the FieldValue component. Therefore all FieldValue options are also available for a Badge component.

Index

Component Options

colors

colors: IBadgeColors

Specifies the colors for the Badge component.

You must specify the colors in a JSON format similar to what follows:

{
  "values":{
    "foo":{
      "icon":"blue",
      "text":"#222"
    },
    "bar":{
      "icon":"green",
      "text":"lightgreen"
    }
  },
  "icon":"red",
  "text":"#9ab52b"
}

This format allows you to customize both the icon and text colors for each field value as well as the default values.

Colors can be specified in HTML or hexadecimal format.

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

getColor

  • getColor(value?: string): IBadgeColor
  • Gets the icon and text color of a field value.

    Parameters

    • Default value value: string = ""

      The field value whose colors to return.

    Returns IBadgeColor

    An object with the icon and text keys.

getValue

  • getValue(): any

renderOneValue

  • renderOneValue(value: string): HTMLElement
  • Renders one string value with the appropriate colors and icon.

    Parameters

    • value: string

      The field value to render.

    Returns HTMLElement

    An HTML <span> tag containing the rendered value.

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

Static parseColors

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 differents component. Mainly used by ResultLink.

componentStateModel

componentStateModel: ComponentStateModel

Contains the state of different component (enabled vs disabled). Allows to get/set values. Trigger 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.

usageAnalytics

usageAnalytics: IAnalyticsClient

A reference to the Analytics.client.

Static ID

ID: string

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

Constructors

constructor

  • Creates a new Badge component.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component.

    • options: IBadgeOptions

      The options for the Badge component.

    • Optional bindings: IComponentBindings

      The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).

    • Optional result: IQueryResult

      The result to associate the component with.

    Returns Badge

Implements