The Text component embeds itself in a result template to output a simple text value.
This component is a result template component (see Result Templates).
Specifies the color of the text (set as the
color CSS property).
Specifies the bottom margin of the text (set as the
margin-bottom CSS property).
Specifies the left margin of the text (set as the
margin-left CSS property).
Specifies the right margin of the text (set as the
margin-right CSS property).
Specifies the top margin of the text (set as the
margin-top CSS property).
Specifies the bottom padding of the text (set as the
padding-bottom CSS property).
Specifies the left padding of the text (set as the
padding-left CSS property).
Specifies the right padding of the text (set as the
padding-right CSS property).
Specifies the top padding of the text (set as the
padding-top CSS property).
Specifies the size of the text (set as the
font-size CSS property).
Specifies the style of the text (set as the
font-style CSS property).
Specifies the alignment of the text (set as the
text-align CSS property).
Specifies the localized string value that the component should render.
Specifies the weight of the text (set as the
font-weight CSS property).
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 differents component. Mainly used by ResultLink.
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.
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.
A reference to the Analytics.client.
The static ID that each component need to be identified.
For example, SearchButton -> static ID : SearchButton -> className : CoveoSearchButton
Creates a new Text component.
The HTMLElement on which to instantiate the component.
The options for the Text component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).