Coveo Backdrop Component (CoveoBackdrop)

The Backdrop component renders an image URL (either passed as a direct URL or contained in a result field) as a background image. It is useful for displaying information in front of a dynamic background image.

The Backdrop component will automatically initialize components embedded within itself:

  <div class="CoveoBackdrop" data-image-field="ytthumbnailurl">
    <div class="CoveoFieldValue" data-field="somefield"></div>
  </div>

Index

Methods

Properties

Accessors

Component Options

Constructors

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). Components 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

bind: ComponentEvents

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 needs in order to be identified.
For example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton

Accessors

usageAnalytics

Component Options

imageField

imageField: IFieldOption

Specifies the field from which the background image will be pulled.

If Backdrop.options.imageUrl is specified, it will override this option.

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

imageUrl

imageUrl: string

Specifies a direct URL from which the background image will be sourced.

Has priority over Backdrop.options.imageField.

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

overlayColor

overlayColor: string

Specifies the color that will be overlaid on top of the background image. This option needs to be declared as a CSS color. Be sure to use RGBA with an alpha value lower than 1 in order to be able to see the image behind the overlay color.

Example value : "rgba(101, 123, 76, 0.5)"

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

overlayGradient

overlayGradient: boolean

Specifies whether the overlay color should be instead be rendered as a top-to-bottom gradient from Backdrop.options.overlayColor to transparent.

Default value is false.

Only effective when

overlayColor is truthy

Default

false

Markup configuration example(s) :
data-overlay-gradient='true'
data-overlay-gradient='false'

Constructors

constructor

  • Creates a new Backdrop component.

    Parameters

    • element: HTMLElement

      The HTMLElement on which the component will be instantiated.

    • Optional options: IBackdropOptions

      The options for the Backdrop component.

    • Optional bindings: IComponentBindings

      The bindings that the component requires to function normally. If not set, it will be automatically resolved (with a slower execution time).

    • Optional result: IQueryResult

      The IQueryResult.

    • Optional _window: Window
    • Default value ModalBox: any = ModalBoxModule

    Returns Backdrop