Search Lightning component (Obsolete)

This is for:

Developer System Administrator
Obsolete

This feature is no longer available as of the April 2020 release of Coveo for Salesforce version 4.2.

The Search Lightning component allows you to insert a search component in your Experience Cloud site.

It takes care of wrapping and including the correct scripts and different resources needed to do so.

Note

For a tutorial on how to implement a custom Lightning component, see Integrate Coveo Lightning Aura components in a custom component for your Experience Cloud site.

Usage

Reference it in your Lightning component as you would for any other Aura component, using the namespace prefix of the Coveo package.

<aura:component implements='forceCommunity:availableForAllPageTypes'>
  <CoveoV2:Search />
</aura:component>

Resources included with this component

This component includes the Coveo JavaScript Search Framework, the jQuery(latest 3.x.x version) and Underscore.js (latest 1.x.x version) libraries, and the Coveo for Salesforce specific assets.

Aura events

This component inherits from the Base Lightning component, and shares all of its aura events (see Aura events).

Options

This component inherits from the Base Lightning component and supports all its options (see Options).

However, the default value changes for the following option:

name

This option is set to communityCoveo by default when used with this component.

If this Visualforce component doesn’t exist, you will be prompted to create it when inserting the Lightning component in your community.

You can reference another Visualforce search component by changing this option:

<CoveoV2:Search name="<MY_CUSTOM_SEARCH_PAGE>"/>

Where you replace <MY_CUSTOM_SEARCH_PAGE> by the name of the Visualforce search component you want to use.