Coveo ImageFieldValue Component (CoveoImageFieldValue)

A typical use case of this component is to display product images in the context of commerce.

Available since

September 2019 Release (v2.7023)

Result template component

This component is intended to be used in result templates

Index

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 different components. Mainly used by ResultLink.

componentStateModel

componentStateModel: ComponentStateModel

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.

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.

Static ID

ID: string

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

Accessors

usageAnalytics

Component Options

field

Required. The name of a field whose value is the URL of the image to display.

Note: The component uses the value of this field to set the src attribute of the img HTML tag it generates.

Required

Specifying a value for this option is required for the component to work

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

height

height: number

The height of the image (in pixels).

Note: The component uses this value to set the height attribute of the img HTML tag it generates.

Markup configuration example(s) :
data-height='10'

srcTemplate

srcTemplate: string

A Template literals) from which to generate the img tag's src attribute value.

This option overrides the field option value.

The template literal can reference any number of fields from the parent result. It can also reference global scope properties.

Examples:

  • The following markup generates an src value such as http://uri.com?id=itemTitle:
<a class='CoveoImageFieldValue' data-src-template='${clickUri}?id=${raw.title}'></a>
  • The following markup generates an src value such as localhost/fooBar:
<a class='CoveoImageFieldValue' data-src-template='${window.location.hostname}/{Foo.Bar}'></a>

Default value is undefined.

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

width

width: number

The width of the image (in pixels).

Note: The component uses this value to set the width attribute of the img HTML tag it generates.

Markup configuration example(s) :
data-width='10'

Constructors

constructor

  • Creates a new ImageFieldValue.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component.

    • options: IImageFieldValue

      The options for the ImageFieldValue 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 ImageFieldValue