The CardActionBar component displays an action bar at the bottom of a card result (see Result Layouts). It is a simple container for buttons or complementary information.
You should place this component at the bottom of a card result (i.e., as the last child of the surrounding
<div class="coveo-result-frame"> [ ... content ... ] <div class="CoveoCardActionBar"> <some-button></some-button> <some-additional-info></some-additional-info> </div> </div>
A CardActionBar component is a two-state widget: it can either be shown or hidden. It is hidden by default.
Specifies whether to hide the CardActionBar by default, unless the user clicks its parent IQueryResult.
Default value is
true. This means that the component is hidden and a visual indicator is appended to its parent
If CardActionBar.options.hidden is
true, specifies whether to open the CardActionBar when the cursor
hovers over it.
Default value is
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.
Hides the CardActionBar.
Shows the CardActionBar.
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 CardActionBar component.
The HTMLElement on which to instantiate the component.
The options for the CardActionBar component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).
The parent result.