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>
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). Components 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 needs in order to be identified.
For example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
Specifies the field from which the background image will be pulled.
If Backdrop.options.imageUrl is specified, it will override this option.
Specifies a direct URL from which the background image will be sourced.
Has priority over Backdrop.options.imageField.
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)"
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
Creates a new Backdrop component.
The HTMLElement on which the component will be instantiated.
The options for the Backdrop component.
The bindings that the component requires to function normally. If not set, it will be automatically resolved (with a slower execution time).