CommunitySearch Lightning component

This is for:

Developer System Administrator

In this article

Usage
Resources included with this component
Aura event
Options

The CommunitySearch Lightning component lets you 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 Integrating the Coveo components in a custom Lightning component.

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:CommunitySearch/>
</aura:component>

Resources included with this component

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

Note

Since Lightning Locker is automatically enabled on this component, the underscore result templates aren’t supported. You must use HTML templates instead.

Aura event

This component doesn’t offer any Aura events.

Options

The component offers the following options:

name

As of the Coveo for Salesforce v5 release

The name of the Page Content record that contains the HTML code of your search interface.
Prior Coveo for Salesforce versions

The name of the Visualforce component that contains the HTML code of your search interface.

Default value is communitySearchCoveo.

searchHub

The name of the search hub to enforce when authenticating a query with this search token, which can also be used in query pipeline condition statements.

Default value is the same value as name.

debug

Whether to use the non-minified versions of the different resources.

Default value is false.