The CardOverlay component displays a button that the user can click to toggle the visibility of an overlay on top of an IQueryResult. While this component typically populates a CardActionBar component, it is actually possible to place a CardOverlay component anywhere in any result.
The primary purpose of the CardOverlay component is to display additional information about a result in a format that fits well within a card result layout (see Result Layouts).
When initialized, this component creates a
<div class="coveo-card-overlay"> element as the last child of its parent
IQueryResult, and displays a button which toggles the visibility of the overlay.
Specifies the icon to use for the overlay icon and for the button icon.
The name of the icon to use should be specified in dashed case. ie: facet-expand
Specifies the string to use for the overlay title and for the button text.
Setting a value for this option is required for this component to work.
Closes the CardOverlay.
Also triggers the CardOverlayEvents.closeCardOverlay event.
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.
Opens the CardOverlay.
Also triggers the CardOverlayEvents.openCardOverlay event.
Toggles the CardOverlay visibility.
Specifying a value for this parameter forces the component visibility to take the corresponding value
true for visible;
false for hidden).
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 CardOverlay component.
The HTMLElement on which to instantiate the component.
The options for the CardOverlay component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).