QuanticRecommendationList

This is for:

Developer System Administrator

The QuanticRecommendationList component displays recommendations by applying one or more result templates in different layouts.

Example

<c-quantic-recommendation-list engine-id={engineId} recommendation={recommendationId} fields-to-include="objecttype,filetype" number-of-recommendations="3" recommendations-per-row="10" heading-level="1"></c-quantic-recommendation-list>

Properties

Property Attribute Description Type Default

engineId (required)

engine-id

The ID of the engine instance the component registers to.

string

recommendation

recommendation

The recommendation identifier used by the Coveo platform to retrieve recommended documents.

string

{'recommendation'}

numberOfRecommendations

number-of-recommendations

The total number of recommendations to fetch.

number

{10}

fieldsToInclude

fields-to-include

A list of fields to include in the query results, separated by commas.

string

'date,author,source,language,filetype,parents,sfknowledgearticleid,sfid,sfkbid,sfkavid'

label

label

The label of the component. This label is displayed in the component header.

string

'Top documents for you'

headingLevel

heading-level

The Heading level to use for the heading label, accepted values are integers from 1 to 6.

number

{3}

variant (required)

variant

The variant of the component. Accepted variants are grid and carousel.

'grid', 'carousel'

recommendationsPerRow

recommendations-per-row

The number of recommendations to display, per row. Each recommendation in the row will be displayed as 1/recommendationsPerRow of the container width.

number

{3}

Custom Events

The component fires the following custom event:

  • registerrecommendationtemplates

XML Configuration File Elements

The following XML configuration file elements apply (see XML Configuration File Elements).

Metadata Value

apiVersion

57.0

isExposed

false