Support Menu

Coveo component CardActionBar

Coveo CardActionBar Component (CoveoCardActionBar)

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 coveo-result-frame.

Example

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

Index

Component Options

hidden

hidden: boolean

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 IQueryResult.

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

openOnMouseOver

openOnMouseOver: boolean

If CardActionBar.options.hidden is true, specifies whether to open the CardActionBar when the cursor hovers over it.

Default value is true.

Markup configuration example(s) :
data-open-on-mouse-over='true'
data-open-on-mouse-over='false'

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

hide

  • hide(): void

show

  • show(): void

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 differents component. Mainly used by ResultLink.

componentStateModel

componentStateModel: ComponentStateModel

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.

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.

usageAnalytics

usageAnalytics: IAnalyticsClient

A reference to the Analytics.client.

Static ID

ID: string

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

Constructors

constructor

  • Creates a new CardActionBar component.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component.

    • Optional options: ICardActionBarOptions

      The options for the CardActionBar 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 parent result.

    Returns CardActionBar