Coveo CardOverlay Component (CoveoCardOverlay)

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.

Index

Methods

Properties

Accessors

Component Options

Constructors

Methods

closeOverlay

  • closeOverlay(): void

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

openOverlay

  • openOverlay(): void

toggleOverlay

  • toggleOverlay(swtch?: boolean): void

  • Toggles the CardOverlay visibility.

    Parameters

    • Optional swtch: boolean

      Specifying a value for this parameter forces the component visibility to take the corresponding value (true for visible; false for hidden).

    Returns 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

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

icon

icon: string

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

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

title

title: string

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.

Required

Specifying a value for this option is required for the component to work

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

Constructors

constructor

  • Creates a new CardOverlay component.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component.

    • Optional options: ICardOverlayOptions

      The options for the CardOverlay 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).

    Returns CardOverlay