FullSearch Lightning Component

Salesforce Ecommerce Service & Support Workplace Developer System Administrator Product Documentation

Coveo for Salesforce 3 (May 2018)

The FullSearch component allows your users access to a full length Coveo-powered search page inside the Lightning experience.

Whereas the CommunitySearch component is meant to be used inside a community, the FullSearch component is meant to be used inside the Lightning Service Console.

FullSearch

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="force:hasRecordId,force:hasSObjectName,flexipage:availableForRecordHome,lightning:isUrlAddressable" access="global">
  <CoveoV2:FullSearch pageReference="{!v.pageReference}" />
</aura:component>

For versions prior to 3.16, you should enter the following lines:

<aura:component implements="force:hasRecordId,force:hasSObjectName,flexipage:availableForRecordHome" access="global">
  <CoveoV2:FullSearch recordId="{!v.recordId}"
                      sObjectName="{!v.sObjectName}"
                      recordFields="Case_Subject,Case_Description"/>
</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 offers the following event:

ErrorEvent

This error is fired when an error occurs with the component.

Options

This component offers the following options:

name

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

Default value is coveoFullSearch.

searchHub

The name of the searchHub to be sent to Coveo Usage Analytics (Coveo UA).

This option should have the same value as name.

recordFields

A comma-separated list of the fields to use as the default query for the component.

openResultsInSubTab

Whether the results should open in a subtab when clicking on them.

Default value is false.

debug

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

Default value is false.