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.
Gets the icon and text color of a field value.
The field value whose colors to return.
An object with the icon and text keys.
Gets the current FieldValue from the current IQueryResult.
The current FieldValue or null if value is and Object.
Renders one string value with the appropriate colors and icon.
The field value to render.
An HTML <span> tag containing the rendered value.
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.
Parses a Badge.options.colors option string into a workable JSON format.
The colors option string to parse. See Badge.options.colors.
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.
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.
Creates a new Badge component.
The HTMLElement on which to instantiate the component.
The options for the Badge component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).
The result to associate the component with.
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.