Coveo ResultActionsMenu Component (CoveoResultActionsMenu)

The ResultActionsMenu component adds a floating result action menu, meant to be used inside result templates (see Result Templates). It is designed to contain other components that can execute actions related to the result, typically the Quickview and AttachToCase components, available in the Coveo for Salesforce and Coveo for Dynamics integrations.

<script type="text/html" class="result-template" [...]
  <div class="coveo-result-frame">
    <div class="CoveoResultActionsMenu">
      <div class="CoveoQuickview"></div>
    </div>
  [...]
</script>
Available since

July 2018 Release (v2.4382.10)

Index

Methods

Properties

Accessors

Component Options

Constructors

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

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

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.

menuItems

menuItems: HTMLElement[]

A list containing menu items for this menu.

parentResult

parentResult: HTMLElement

The rendered result that contains this menu.

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

openOnMouseOver

openOnMouseOver: boolean

Specifies whether the menu should open when the user hovers over the result.

When set to false, the menu opens only when clicking on the result.

Default value is true.

Default

true

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

Constructors

constructor

  • Creates a new ResultActionsMenu component.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component.

    • options: IResultActionsMenuOptions

      The options for the ResultActionsMenu component.

    • Optional bindings: IResultsComponentBindings

      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 result to associate the component with.

    Returns ResultActionsMenu