docs(quantic): new information added to better document result templa…

…tes components dealing with fields (#3494) * js doc of result templates components improved * Update packages/quantic/force-app/main/default/lwc/quanticResultText/quanticResultText.js
coveo · Dec 19, 2023 · 61dc3cd · 61dc3cd
1 parent 1b5dd02
commit 61dc3cd
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 0 deletions.
diff --git a/packages/quantic/force-app/main/default/lwc/quanticResultDate/quanticResultDate.js b/packages/quantic/force-app/main/default/lwc/quanticResultDate/quanticResultDate.js
@@ -6,6 +6,7 @@ import {LightningElement, api} from 'lwc';
 
 /**
  * The `QuanticResultDate` component displays a given result date field value.
+ * Make sure the field specified in this component is also included in the field array for the relevant template. See the this example: [Quantic usage](https://docs.coveo.com/en/quantic/latest/usage/#javascript).
  * @category Result Template
  * @example
  * <template if:true={result.raw.date}>

diff --git a/packages/quantic/force-app/main/default/lwc/quanticResultField/quanticResultField.js b/packages/quantic/force-app/main/default/lwc/quanticResultField/quanticResultField.js
@@ -14,6 +14,7 @@ import stringTemplate from './stringTemplate.html';
 
 /**
  * The `QuanticResultField` component properly displays a given result field according to its type.
+ * Make sure the field specified in this component is also included in the field array for the relevant template. See the this example: [Quantic usage](https://docs.coveo.com/en/quantic/latest/usage/#javascript).
  * @category Result Template
  * @example
  * <template if:true={result.raw.source}>

diff --git a/...p/main/default/lwc/quanticResultHighlightedTextField/quanticResultHighlightedTextField.js b/...p/main/default/lwc/quanticResultHighlightedTextField/quanticResultHighlightedTextField.js
@@ -11,6 +11,7 @@ import {LightningElement, api} from 'lwc';
 
 /**
  * The `QuanticResultHighlightedTextField` component displays a given result field value and supports text highlighting for the following fields: `title`, `excerpt`, `printable URI`, `first sentences` and `summary`.
+ * Make sure the field specified in this component is also included in the field array for the relevant template. See the this example: [Quantic usage](https://docs.coveo.com/en/quantic/latest/usage/#javascript).
  * @category Result Template
  * @example
  * <c-quantic-result-highlighted-text-field engine-id={engineId} result={result} field="title"></c-quantic-result-highlighted-text-field>

diff --git a/...tic/force-app/main/default/lwc/quanticResultMultiValueText/quanticResultMultiValueText.js b/...tic/force-app/main/default/lwc/quanticResultMultiValueText/quanticResultMultiValueText.js
@@ -7,6 +7,7 @@ import {LightningElement, api} from 'lwc';
 
 /**
  * The `QuanticResultMultiValueText` component displays a given result multi-value field value.
+ * Make sure the field specified in this component is also included in the field array for the relevant template. See the this example: [Quantic usage](https://docs.coveo.com/en/quantic/latest/usage/#javascript).
  * @category Result Template
  * @example
  * <template if:true={result.raw.language}>

diff --git a/packages/quantic/force-app/main/default/lwc/quanticResultNumber/quanticResultNumber.js b/packages/quantic/force-app/main/default/lwc/quanticResultNumber/quanticResultNumber.js
@@ -6,6 +6,7 @@ import {LightningElement, api} from 'lwc';
 
 /**
  * The `QuanticResultNumber` component displays a given result number field value.
+ * Make sure the field specified in this component is also included in the field array for the relevant template. See the this example: [Quantic usage](https://docs.coveo.com/en/quantic/latest/usage/#javascript).
  * @category Result Template
  * @example
  * <template if:true={result.raw.ytlikecount}>

diff --git a/packages/quantic/force-app/main/default/lwc/quanticResultText/quanticResultText.js b/packages/quantic/force-app/main/default/lwc/quanticResultText/quanticResultText.js
@@ -5,6 +5,7 @@ import {LightningElement, api} from 'lwc';
 
 /**
  * The `QuanticResultText` component displays a given result field value.
+ * Make sure the field specified in this component is also included in the field array for the relevant template. See the this example: [Quantic usage](https://docs.coveo.com/en/quantic/latest/usage/#javascript).
  * @category Result Template
  * @example
  * <template if:true={result.raw.source}>