Support Menu

Coveo component Text

The Text component embeds itself in a result template to output a simple text value.

The only purpose of this component is to make it possible to easily add different text values to result templates when using the Coveo JavaScript Search Interface Editor (see JavaScript Search Interface Editor).

If you are not designing a search interface using the Coveo JavaScript Search Interface Editor, using this component is unnecessary.

This component is a result template component (see Result Templates).

Index

Component Options

color

color: string

Specifies the color of the text (set as the color CSS property).

Markup configuration example(s) :
data-color='foo'

marginBottom

marginBottom: string

Specifies the bottom margin of the text (set as the margin-bottom CSS property).

Markup configuration example(s) :
data-margin-bottom='foo'

marginLeft

marginLeft: string

Specifies the left margin of the text (set as the margin-left CSS property).

Markup configuration example(s) :
data-margin-left='foo'

marginRight

marginRight: string

Specifies the right margin of the text (set as the margin-right CSS property).

Markup configuration example(s) :
data-margin-right='foo'

marginTop

marginTop: string

Specifies the top margin of the text (set as the margin-top CSS property).

Markup configuration example(s) :
data-margin-top='foo'

paddingBottom

paddingBottom: string

Specifies the bottom padding of the text (set as the padding-bottom CSS property).

Markup configuration example(s) :
data-padding-bottom='foo'

paddingLeft

paddingLeft: string

Specifies the left padding of the text (set as the padding-left CSS property).

Markup configuration example(s) :
data-padding-left='foo'

paddingRight

paddingRight: string

Specifies the right padding of the text (set as the padding-right CSS property).

Markup configuration example(s) :
data-padding-right='foo'

paddingTop

paddingTop: string

Specifies the top padding of the text (set as the padding-top CSS property).

Markup configuration example(s) :
data-padding-top='foo'

size

size: string

Specifies the size of the text (set as the font-size CSS property).

Markup configuration example(s) :
data-size='foo'

style

style: string

Specifies the style of the text (set as the font-style CSS property).

Markup configuration example(s) :
data-style='foo'

textAlign

textAlign: string

Specifies the alignment of the text (set as the text-align CSS property).

Markup configuration example(s) :
data-text-align='foo'

value

value: string

Specifies the localized string value that the component should render.

Markup configuration example(s) :
data-value='foo'

weight

weight: string

Specifies the weight of the text (set as the font-weight CSS property).

Markup configuration example(s) :
data-weight='foo'

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 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 Text component.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component.

    • Optional options: ITextOptions

      The options for the Text 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).

    Returns Text