The ResultTagging component lists the current tag field values of its associated result and renders a control that allows the end user to add values to a tag field.
This component is a result template component (see Result Templates).
The ResultTagging component is not supported with Coveo Cloud V2. To implement the ResultTagging component in Coveo Cloud V1, contact Coveo Support.
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). Component 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.
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.
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 need to be identified.
For example, SearchButton -> static ID : SearchButton -> className : CoveoSearchButton
Specifies how much time (in milliseconds) it takes for the list of suggested items to disappear when it loses focus.
Default value is
2000. Minimum value is
Specifies the tag field that the component will use.
Specifying a value for this options is necessary for this component to work.
Specifies the number of items to show in the list of suggested items.
Default value is
5. Minimum value is
Creates a new ResultTagging component.
The HTMLElement on which to instantiate the component.
The options for the ResultTagging 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.