CommunitySearch Lightning Component

Salesforce Ecommerce Service & Support Workplace Developer System Administrator Product Documentation

The CommunitySearch Lightning component lets you insert a search component in your Lightning community.

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

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.

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

The name of the Visualforce component that should act as your search interface for your CommunitySearch component.

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.