Coveo for Salesforce (V3.33) JavaScript Search component reference
Coveo for Salesforce (V3.33) JavaScript Search component reference
Coveo for Salesforce comes with a set of JavaScript search user interface components. This article provides component API reference documentation that’s automatically generated from the source code.
Components
Components are the building blocks of the Coveo JavaScript Search Framework (see JavaScript Search Framework Components).
AttachToCase component
Component HTML element class: CoveoAttachToCase
The AttachToCase component is a Result Templates component that allows you to link a result to a Salesforce case.
|
Note
When wanting to attach Knowledge articles, ensure that the |
<div class="CoveoAttachToCase"></div>Options
| Option (type) | Description |
|---|---|
|
Specifies if the component should include the Attach/Detach text.
Default value is |
|
Specifies if the component should include the Attach/Detach tooltip.
Default value is |
|
Specifies if the component should be in read only mode.
When in read only mode, you can’t Attach or Detach results.
The default value is |
|
Specifies the current record type. |
|
Specifies if the component should include the Attach/Detach text.
Default value is |
|
Specifies if the component should include the Attach/Detach tooltip.
Default value is |
|
Specifies if the component should be in read only mode.
When in read only mode, you can’t Attach or Detach results.
The default value is |
|
Specifies the current record type. |
|
The possible options for AttachToCase. |
|
Specifies if the component should include the Attach/Detach text.
Default value is |
|
Specifies if the component should include the Attach/Detach tooltip.
Default value is |
|
Specifies if the component should be in read only mode.
When in read only mode, you can’t Attach or Detach results.
The default value is |
|
Specifies the current record type. |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
Box component
Component HTML element class: CoveoBox
The Box component represents the container that includes all the other box components.
It inherits from a SearchInterface Component and supports all its options.
<div class='CoveoBox'></div>Options
| Option (type) | Description |
|---|---|
|
Whether the component should automatically adapt to the screen size.
Default value is |
|
Specifies if you wish to save and reload the If set to If set to Default value is |
|
Specifies the length (in characters) of the result text (excerpt) to display.
Default value is |
|
Specifies the number of results you want per page.
Default value is |
|
Specifies if you wish to use the local storage to save the box state.
This means that the query state is only loaded on page load.
Default value is |
|
Specifies if the box should automatically include an |
Properties
| Property (type) | Description |
|---|---|
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Allows to get and set the different breakpoints for mobile and tablet devices. This is useful, amongst other, for Facet, Tab and ResultList. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Creates a new SearchInterface. Initialize various singletons for the interface (for example, usage analytics, query controller, state model, etc.). Binds events related to the query. |
|
The button to use when creating a ModalBox. |
|
Content of a ModalBox. |
|
The available buttons (Ok, Apply, Cancel, etc.). |
|
The function that can be called to close the modal box. Note that this is also called by validation button such as APPLY, YES, etc. Force close will close all open modalbox and skip the validation (if one was provided). |
|
The content itself. |
|
The modalBox container itself. |
|
The overlay added on the body, which can be clicked to close the modalbox. |
|
The wrapper of the content. |
|
Possible options when creating a ModalBox. |
|
Specify the content that you wish to put inside the modal box. |
|
The button you wish to create (Using BUTTON enum). |
|
Specify that you wish to add a prefix to the class name of the modal box container, to not clash with existing css in the page. |
|
Specify if you wish to open the modal box full screen.
Default is |
|
Specify if you wish to close the modal box when the overlay (black background) is clicked.
Default is |
|
The size for the modal box. |
|
Specify the title of the modal box. |
|
Specify that you wish the modal box to close when the user clicks the title.
Default is |
|
Specify a validation function, which receives the button that was pressed. If the validation function return true, the modal box closes, otherwise it stays open. |
BoxBody component
Component HTML element class: CoveoBoxBody
The BoxBody component takes care of appending a ResultList Component and ensuring the correct CSS styles are applied so that infinite scrolling works properly. By default, the ResultList component is initialized with the following option:
enableInfiniteScroll: true;When you wish to modify other options on the ResultList component, when initializing the framework, add the following code.
Remember to change #MyBox with the id of your CoveoBoxBody component, and 20 with the page size you wish to modify.
$('#MyBox').coveo('initBox', {
BoxBody : {
infiniteScrollPageSize : 20
}
})Use this component on your page this way:
<div class='CoveoBoxBody'></div>Options
| Option (type) | Description | ||
|---|---|---|---|
|
Specifies whether the Default value is
|
||
|
Specifies whether the component should automatically load more results when the user has reached the bottom of the result list.
Default value is |
||
|
When the |
||
|
Specifies a list of fields to include in the query results.
If you set the Otherwise, the Coveo Search API only returns the fields you specify for this option (if they’re available), unless you leave this option undefined, in which case the Coveo Search API returns all available fields. |
||
|
When the By default, the framework uses the first vertically scrollable parent element it finds, starting from the This implies that if the framework can’t find a scrollable parent, it uses the This heuristic isn’t perfect, for technical reasons. There are always some corner case CSS combination which the framework won’t be able to correctly detect as 'scrollable'. We highly recommend that you manually set this option if you wish something else than the |
||
|
If the Default value is Minimum value is |
||
|
Specifies the element inside which to insert the rendered result templates. Performing a new query clears the content of this element. You can change the container by specifying its selector (e.g., If you do not specify a value for this option, a |
||
|
Specifies the type of animation to display while waiting for a query to return. The possible values are:
See also the Default value is |
||
|
Specifies the element inside which to display the Default value is the value of the |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
BoxCreateArticle component
Component HTML element class: CoveoBoxCreateArticle
The BoxCreateArticle component allows the use of the Create Article button in the Coveo Insight Panel (see Adding a Create Article Button to the Insight Panel ).
Use this component inside the coveo-box-settings div.
<div class="coveo-box-settings">
<a class="CoveoBoxCreateArticle" target="_blank">
</a>
...
</div>Options
| Option (type) | Description |
|---|---|
|
Specifies the Knowledge Article types to offer as options when creating an article. By default, all the available Knowledge Article types are displayed. |
|
Specifies if the component should be hidden from the display.
Default value is |
|
Whether to open the created article in a primary tab or, when set to false, to open it in a sub tab.
Default value is |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
BoxCurrentSort component
Component HTML element class: CoveoBoxCurrentSort
The BoxCurrentSort component is only meant as a utility to set the title on its BoxPopup Component container. Whenever the current sort changes, for instance when a user clicks a new Sort Component , this component takes care of setting a new title on the BoxPopup Component. This component must be included inside a BoxPopup component.
<div class='CoveoBoxPopup'>
<div class='CoveoBoxCurrentSort'></div>
<div class="coveo-sort-section">
[[sorts]]
</div>
</div>Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
BoxCurrentTab component
Component HTML element class: CoveoBoxCurrentTab
The BoxCurrentTab component is only meant as a utility to set the title on its BoxPopup Component container. Whenever the current tab changes, for instance when a user clicks a new Tab Component , this component takes care of setting a new title on the BoxPopup Component. This component must be included inside a BoxPopup component.
<div class='CoveoBoxPopup'>
<div class='CoveoBoxCurrentTab'></div>
<div class="coveo-tab-section">
[[sorts]]
</div>
</div>Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
BoxEditLink component
Component HTML element class: CoveoBoxEditLink
The BoxEditLink component provides a clickable button that expands the current interface to another page that contains the Interface Editor.
<a class='CoveoBoxEditLink'></a>Options
| Option (type) | Description |
|---|---|
|
Specifies the icon that the component should use.
Default value is |
|
Specifies the text to display alongside the icon.
Default value is the localized string for |
|
Specifies the URI of the page that hosts the Interface Editor. This option is normally already set for you when you include the Box Visualforce Component. |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
BoxExpandLink component
Component HTML element class: CoveoBoxExpandLink
The BoxExpandLink component takes care of creating a clickable link that expands to a full search interface page. It also takes care of sending the current state of the Box component to the full search interface so that you get the same (or a similar) result set when the full search page loads.
<a class="CoveoBoxExpandLink" target="_blank"></a>Options
| Option (type) | Description |
|---|---|
|
Specifies the description to display when the full search page loads with a context filter.
Default value is the localized string for |
|
Specifies the CSS class of the icon to display on the expand button.
Default value is |
|
Specifies the |
|
Specifies the text content to add inside the icon HTML element.
Default value is the localized string for |
|
Specifies the title to display in the tab or subtab that opens inside the Salesforce console when the user clicks the component to expand the |
|
Specifies whether to open the full search page as a primary or as a subtab inside the Salesforce console.
Default value is Setting this option to |
|
Specifies the URI of the full search page to load when the user expands the |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
BoxHeader component
Component HTML element class: CoveoBoxHeader
The BoxHeader component takes care of instantiating a Searchbox component with preconfigured options and a placeholder (see Coveo Searchbox Component ).
Optionally, this component can also display a Remove context checkbox.
You should normally place this component at the top of your box.
<div class='CoveoBoxHeader'></div>Options
| Option (type) | Description |
|---|---|
|
When Example
When a user opens a case about a Default is |
|
When the |
|
Specifies whether to initialize a |
|
Whether to include the settings icon, which is usually to the right of the search box.
Default value is |
|
When |
|
When the |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Triggers query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
BoxPopup component
Component HTML element class: CoveoBoxPopup
The BoxPopup component is only a container inside of which you can drop any other content or component. Since the Box component is designed to be included in the Salesforce console sidebar with a limited amount of space, it might be useful to add section that can be hidden or shown when the user clicks them.
The HTML content inside the BoxPopup div is used to determine what’s shown or hidden when the panel is opened and closed.
<div class='CoveoBoxPopup'>
<div class='coveo-facet-column'>
<div class='CoveoFacet' data-field='@myfirstfacet'></div>
<div class='CoveoFacet' data-field='@mysecondfacet'></div>
<div class='CoveoFacet' data-field='@mythirdfacet'></div>
</div>
</div>Options
| Option (type) | Description | ||
|---|---|---|---|
|
Specifies if the popup should open with the fully available height of the page.
Default value is |
||
|
Specifies if the popup should open with the fully available width of the page.
Default value is |
||
|
Specifies whether the component should be hidden.
Default value is |
||
|
Specifies the CSS class used for your icon. |
||
|
Specifies the static title to display.
Default value is
|
||
|
Specifies if the popup should open with an animation. The animation is completely CSS based. To modify the animation itself, modify the CSS rules that apply to the relevant elements. Default value is |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Triggers query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
BoxQuerySome component
Component HTML element class: CoveoBoxQuerySome
The BoxQuerySome component is used to automatically include Salesforce fields to the query of an Insight Panel. By default, the fields are included in the advanced query (see Advanced expression). This component is included in the default Insight Panel to include the case subject.
<div class="CoveoBoxQuerySome"></div>Options
| Option (type) | Description |
|---|---|
|
A comma separated list of fields to automatically add to the query.
Default value is |
|
Specifies whether to include the currently viewed case in the search results.
Default value is |
|
Specifies whether to disable the added query from the |
|
Specifies whether to generate the query using the |
|
Specifies if stop words should be removed from the keywords.
Stop words are common words that the index can filter out when ranking the documents (for example, |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Triggers query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
BoxQuerySummary component
Component HTML element class: CoveoBoxQuerySummary
The BoxQuerySummary component inherits from the QuerySummary component (see Coveo QuerySummary Component ).
Its only added functionality is to display the range of currently displayed results when the result list is using infinite scrolling.
<div class='CoveoBoxQuerySummary'></div>Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
BoxResultAction component
Component HTML element class: CoveoBoxResultAction
The BoxResultAction component displays a small actionable button inside each result.
When clicked, this button displays other sub components in a menu, such as the BoxQuickview Component.
|
|
Note
For more information on how to implement your own custom actions inside this component, see Creating Custom Actions for an Insight Panel or a Custom Box. |
This component is intended to be included inside a BoxBody ResultList Component.
<div class='CoveoBoxResultAction'>
<!-- Include other components here, such as the BoxQuickview or BoxAttachToCase components -->
</div>Options
| Option (type) | Description |
|---|---|
|
Specifies that components contained inside the Default value is |
|
Specifies the delay, in milliseconds, before the menu disappears when the user’s mouse leaves the menu icon.
Minimum value is Default value is |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
Cancel component
Component HTML element class: CoveoCancel
The Cancel component adds a button to cancel the case creation.
<div class='CoveoCancel'></div>Options
| Option (type) | Description |
|---|---|
|
Specifies where to redirect the user once the case has been canceled. This option is empty by default. |
|
Specifies the text to display on the button.
The default value is |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
CaseCreation component
Component HTML element class: CoveoCaseCreation
The CaseCreation component creates a form that allows Salesforce users to submit a case. The form automatically searches for solutions while the user is filling form parameters. To work, this component needs to interact with other components that contain the necessary information to create the case.
|
A CaseCreation component must be present on the page for the form to work. |
<div class='CoveoCaseCreation'></div>Options
| Option (type) | Description | ||
|---|---|---|---|
|
Specifies whether to open the link that the component creates in a new window.
Default value is |
||
|
Specifies the delay (in milliseconds) before triggering a new query when the end user types new text inside a Default value is |
||
|
Specifies how to sort the results.
Default value is
|
||
|
Specifies to return only a certain type of results (see Standard query extensions). Default value is the empty string. |
||
|
Specifies whether the component should send case-related metadata when logging case creation events in the Coveo Usage Analytics service.
Default value is |
||
|
Specifies an absolute or relative (percentage) value indicating the number of best keywords that the query must match (see Standard query extensions). Keywords that occur less frequently in the index are considered better than those that are very common. Specifying a value for this option is only useful if the |
||
|
Specifies an absolute or relative (percentage) value indicating the minimum number of keywords that the query must match (see Standard query extensions).
Specifying a value for this options is only useful if the |
||
|
Specifies the maximum number of keywords to use (Standard query extensions). If the query contains a larger number of keywords, remaining keywords are simply ignored. Specifying a value for this options is only useful if the |
||
|
Specifies whether to use the Assignment Rules.
Default value is |
||
|
Specifies whether to generate the query using the |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
ChatterThumbnail component
Component HTML element class: CoveoChatterThumbnail
The ChatterThumbnail component is used in result templates to display the Chatter avatar of users. It is included by default in the User result template.
<span class="CoveoChatterThumbnail"></span>Options
| Option (type) | Description |
|---|---|
|
Specifies the height of the thumbnail.
Default value is |
|
Specifies the width of the thumbnail.
Default value is |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
CommunityStateManager component
Component HTML element class: CoveoCommunityStateManager
The CommunityStateManager component is used to connect your Lightning search component to the Coveo standalone search box.
This component is used in a Lightning search page, in the coveo-search-section, as such:
<div class="coveo-search-section">
<div class="CoveoCommunityStateManager"></div>
</div>Options
| Option (type) | Description |
|---|---|
|
Performs the same function as the |
|
Performs the same function as the |
|
Performs the same function as the |
|
Performs the same function as the |
|
Performs the same function as the |
|
Performs the same function as the |
|
Performs the same function as the |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
CreateArticle component
Component HTML element class: CoveoCreateArticle
The CreateArticle component allows you to create an Article from the current page using Salesforce.
<div class="CoveoCreateArticle"></div>You can also specify multiple type of Article to create using the articleTypes property.
Coveo.option(root, {
CreateArticle: {
articleTypes: [
{name: "Knowledge", apiName: "Knowledge__kav"},
{name: "Documentation", apiName: "Documentation__kav"}
]
}
})Options
| Option (type) | Description |
|---|---|
|
Specifies the Knowledge Article types to offer as options when creating an article. By default, all the available Knowledge Article types are displayed. |
|
Specifies if the component should be hidden from the display.
Default value is |
|
Whether to open the created article in a primary tab or, when set to |
|
Specifies the list of objects that the component can create.
Default is |
|
Whether to open the new page in a subtab.
Default is |
|
Specifies the title of the CreateArticle button.
Default is |
|
Whether to use the default article type.
Default is |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
FullSearch component
Component HTML element class: CoveoFullSearch
The FullSearch component allows your users access to a full length Coveo search page inside the Lightning experience.
<div class="CoveoFullSearch"></div>Options
| Option (type) | Description |
|---|---|
|
Specifies the name of the component to open when clicked Default is |
|
Whether to open the new page in a subtab.
Default is |
|
Specifies the title of the FullSearch button.
Default is |
|
Specifies the visibility of the component Default is |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
|
Constructor for ResponsiveFullSearch. |
Input component
Component HTML element class: CoveoInput
The input component is used by the Field and the Picklist components.
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
|
Creates a new |
ProductMedia component
Component HTML element class: CoveoProductMedia
The Product Media component is used to display a product media image in a result template.
<div class='CoveoProductMedia' data-media-type='Product Image' data-width='70px' data-height='70px'></div>Options
| Option (type) | Description |
|---|---|
|
The height of the image. The component uses this field value to set the Requires standard CSS syntax and units. |
|
The type of media resource to display. The component uses this field value to build and set the value of the |
|
The function used resolve the path to the static resource image. |
|
The width of the image. The component uses this field value to set the Requires standard CSS syntax and units. |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Creates a new |
ResultAction component
Component HTML element class: CoveoResultAction
The base class for all ResultAction components. Its main responsibility is handling the visual elements of the Result Action.
Options
| Option (type) | Description |
|---|---|
|
Specifies that components contained inside the |
|
Specifies the delay, in milliseconds, before the menu disappears when the user’s mouse leaves the menu icon.
Minimum value is |
|
See IResultActionOptions.icon Optional. You may instead provide the icon by appending it as a child element. |
|
See IResultActionOptions.tooltip Optional. If no tooltip is provided, the tooltip popup won’t appear. |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Construct a ResultAction component. |
SalesforceQuickview component
Component HTML element class: CoveoSalesforceQuickview
The SalesforceQuickview component inherits from the Quickview component, and thus provides all the same options (see Coveo Component Quickview ). It is made to support LockerService (see What is LockerService? ).
<div class='CoveoSalesforceQuickview'></div>Options
| Option (type) | Description |
|---|---|
|
Enable the Advanced Quickview if you want to use more advanced features of the Quickview, like the highlighting or if you have a custom Quickview. |
|
Fill this field with the URL of your custom Quickview page if you have one. |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
SalesforceThumbnail component
Component HTML element class: CoveoSalesforceThumbnail
The SalesforceThumbnail component is used in result templates to display a thumbnail preview for Salesforce content documents. It’s included by default in the Document result template.
|
|
Note
Objects without attachments may fail to render a preview. You should only use it for Salesforce Content documents. |
<span class="CoveoSalesforceThumbnail"></span>Options
| Option (type) | Description |
|---|---|
|
Specifies the height of the thumbnail.
Default is |
|
Specifies the width of the thumbnail.
Default value is |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
Submit component
Component HTML element class: CoveoSubmit
The Submit component adds a button to submit a case.
<div class="CoveoSubmit"></div>Options
| Option (type) | Description |
|---|---|
|
Specifies where to redirect the user once the case has been submitted. By default, this option redirects to the newly created case page. |
|
Specifies the text to display on the button.
Default value is |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
UserActions component
Component HTML element class: CoveoUserActions
The UserActions component allows your agents to see the actions performed by the end-user before or after the creation of a case within the Salesforce console. The component takes the information from the Coveo Usage Analytics events performed during the visit in which the case was created, as seen from the Visit Browser page of the Coveo Cloud Administration Console (see Reviewing User Visits With the Visit Browser).
You can configure which events the component displays.
The component typically appears in a tab of the Insight Panel, but can also be included as a standalone component in a Visualforce page (see Implementing the UserActions Component ).
In an Insight Panel, the component would look like this:
<div class="CoveoBoxPopup" data-title="User actions" data-full-width="true" data-full-height="true" data-icon="coveo-sprites-tab-people">
<div class="CoveoUserActions"></div>
</div>To add the UserActions component as a standalone component, you need to add the UserActions Visualforce Component in your Visualforce page (see UserActions Visualforce Component ).
You also need to create a custom handler to open/close the component, or you can simply use the showButton property.
<div class="CoveoUserActions" data-bind-on-box="false" data-show-button="true"></div>Options
| Option (type) | Description |
|---|---|
|
Specifies if the component should listen to the |
|
Specifies which events the These typically are the |
|
Specifies if the component should render a button to open/close itself.
Default value is |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
ViewedByCustomer component
Component HTML element class: CoveoViewedByCustomer
The ViewedByCustomer component allows your agents to see, within the Salesforce Lightning console, every result which the user clicked. It displays an icon and a label on each result, if already viewed by the customer who created the case (see Coveo Component ViewedByCustomer ).
<div class="CoveoViewedByCustomer"></div>Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
Unique Identifier used by the Search-UI. |
|
Create an instance of ViewedByCustomer. |
BoxAttachToCase component
Component HTML element class: CoveoBoxAttachToCase
The BoxAttachToCase component allows you to attach a result to the current Salesforce object. This component normally renders itself inside the BoxResultAction Component.
|
|
Note
Your Salesforce users must have |
Options
| Option (type) | Description |
|---|---|
|
Specifies if the component should include the Attach/Detach text.
Default value is |
|
Specifies if the component should include the Attach/Detach tooltip.
Default value is |
|
Specifies if the component should be in read only mode.
When in read only mode, you can’t Attach or Detach results.
The default value is |
|
Specified the current record type. |
|
The possible options for AttachToCase. |
|
Specifies if the component should include the Attach/Detach text.
Default value is |
|
Specifies if the component should include the Attach/Detach tooltip.
Default value is |
|
Specifies if the component should be in read only mode.
When in read only mode, you can’t Attach or Detach results.
The default value is |
|
Specified the current record type. |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
BoxFieldTable component
Component HTML element class: CoveoBoxFieldTable
The BoxFieldTable component is meant to be included inside a ResultList Component .
<div class='CoveoBoxFieldTable'></div>Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Creates a new FieldTable. |
BoxQuickview component
Component HTML element class: CoveoBoxQuickview
The BoxQuickview component inherits from the Quickview component, and thus provides all the same options(see Coveo Component Quickview ).
<div class='CoveoBoxQuickview'></div>Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Creates a new Quickview component. |
CaseDeflection component
Component HTML element class: CoveoCaseDeflection
The CaseDeflection component is used to allow administrators to increase case deflection by recommending items to your users as they enter a case. To learn how to implement it, see CaseDeflection Lightning Component.
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
Field component
Component HTML element class: CoveoField
The Field component adds a text input to a case creation form, where a user can enter text.
<div class="CoveoField"></div>Options
| Option (type) | Description | ||
|---|---|---|---|
|
Specifies the field used to save the input value when the user submits the form. |
||
|
Specifies whether to enable analytics on the component.
Default value is |
||
|
Specifies whether to include the entered keywords in the search for related cases.
The default value is
|
||
|
Specifies whether the input has to be filled before the form can be submitted.
Default value is |
||
|
Specifies the input height in number of lines.
Default value is |
||
|
Specifies the title to display above the input. |
||
|
Specifies a short hint displayed inside the input before the user enters a value. |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
FullSearchNode component
Component HTML element class: CoveoFullSearchNode
Interface Editor for FullSearchNode.
Properties
| Property (type) | Description |
|---|---|
|
Returns an array of the options which won’t be in the Interface Editor. |
MetadataStore component
Component HTML element class: CoveoMetadataStore
Metadata store used to store and analyze search interfaces.
Properties
| Property (type) | Description |
|---|---|
|
Attach an event listener that adds telemetry metadata to the first |
Picklist component
Component HTML element class: CoveoPicklist
This component adds a drop down list to a case creation form.
<div class="CoveoPicklist"></div>Options
| Option (type) | Description | ||
|---|---|---|---|
|
Specifies whether to add a QRE in the query using the The generated expression looks like this, where:
For more information on the |
||
|
Specifies the field used to save the drop down list value when the user submits the form. |
||
|
Specifies the default selected value in the drop down list. |
||
|
Specifies whether to enable analytics on the component.
Default value is |
||
|
Specifies whether to include the selected option keywords in the search for related cases.
The default value is
|
||
|
Specifies whether an option has to be selected before the form can be submitted.
Default value is |
||
|
Specifies how to affect the ranking score for items where the This option is used with This option is useful only when the |
||
|
Specifies the field to use in the QRE added to the search query.
This option is useful only when the |
||
|
Specifies the title to display above the dropdown list. |
||
|
Specifies what to display when the user’s mouse is over the |
||
|
Specifies the values to display in the dropdown list.
If this option is left empty, the values are automatically obtained using the |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Create a new Component. Resolve all IComponentBindings if not provided. Create a new Logger for this component. Attach the component to the SearchInterface. |
ProductMediaNode component
Component HTML element class: CoveoProductMediaNode
Interface Editor node for the ProductMedia component.
Properties
| Property (type) | Description |
|---|---|
|
The priority of the match. |
|
Get the properties that we don’t want to front in the Interface Editor. |
|
Build a ProductMediaNode instance after a node have been matched. |
ResponsiveCreateArticle component
Component HTML element class: CoveoResponsiveCreateArticle
ResponsiveCreateArticle is responsible to display a responsive button for the CreateArticle.
ResponsiveFullSearch component
Component HTML element class: CoveoResponsiveFullSearch
ResponsiveFullSearch is responsible to display a responsive button for the FullSearch.
Properties
| Property (type) | Description |
|---|---|
|
Constructor for ResponsiveFullSearch |
ResultActionsPostToFeed component
Component HTML element class: CoveoResultActionsPostToFeed
The ResultActionsPostToFeed component is a Result Template component designed to work with the ResultActionsMenu Result Template component. Its main purpose is to insert the current result in a Salesforce Chatter "Post".
<div class="CoveoResultActionsMenu">
<div class="CoveoResultActionsPostToFeed"></div>
</div>Options
| Option (type) | Description |
|---|---|
|
Specifies if the component should submit the post right away.
Default value is |
|
Specifies the template that will be inserted in the "body" of the post.
Default value is |
|
Specifies how the component should insert the text in the post.
Possible values are |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Construct a ResultQuickAction component. |
ResultActionsSendEmail component
Component HTML element class: CoveoResultActionsSendEmail
The ResultActionsSendEmail component is a Result Template component designed to work with the ResultActionsMenu Result Template component. Its main purpose is to insert the current result in a Salesforce "Email".
<div class="CoveoResultActionsMenu">
<div class="ResultActionsSendEmail"></div>
</div>Options
| Option (type) | Description |
|---|---|
|
Specifies the template that will be inserted in the "htmlBody" of the Email.
Default value is |
|
Specifies how the component should insert the text in the email.
Possible values are |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Construct a ResultQuickAction component. |
ResultActionsSendLiveAgent component
Component HTML element class: CoveoResultActionsSendLiveAgent
The ResultActionsSendLiveAgent component is a Result Template component designed to work with the ResultActionsMenu Result Template component. Its main purpose is to insert the current result in a Salesforce Live Agent chat window.
<div class="CoveoResultActionsMenu">
<div class="CoveoResultActionsSendLiveAgent"></div>
</div>Options
| Option (type) | Description |
|---|---|
|
Specifies the template that will be inserted in the "text" of the message.
Default value is |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Construct a ResultAction component. |
ResultQuickAction component
Component HTML element class: CoveoResultQuickAction
The ResultQuickAction component is a Result Template component designed to work with the ResultActionsMenu Result Template component. It can be customized to perform any Salesforce Quick Action.
<div class="CoveoResultActionsMenu">
<div class="CoveoResultQuickAction"></div>
</div>Options
| Option (type) | Description |
|---|---|
|
Specifies the name of the Quick Action bound to this result action. This field is required. |
|
Specifies if the component should perform the action right away.
Default value is |
|
The icon that will be displayed on the button. If text is provided, the button will contain that text. If the HTML of an image is provided, that image will be displayed in the button. |
|
Specify the name of the event that will be fired to allow modification of the arguments before sending the action. This field is optional. If left empty, no event will be fired. |
|
Specifies the fields that will be sent in the arguments of the quick action.
This argument must be provided as a JSON object.
Fields from the query result can be inserted by placing |
|
The tooltip that displays on hovering the component. |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Construct a ResultQuickAction component. |
ResultQuickActionNode component
Component HTML element class: CoveoResultQuickActionNode
Interface Editor node for the ResultQuickAction component.
Properties
| Property (type) | Description |
|---|---|
|
The priority of the match. |
|
Get the properties that we don’t want to front in the Interface Editor. |
|
Build a ResultQuickActionNode instance after a node has been matched. |
SalesforceAdvancedQuickview component
Component HTML element class: CoveoSalesforceAdvancedQuickview
A Locker-friendly Quickview component.
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Creates a new |
SalesforceQuickviewDocument component
Component HTML element class: CoveoSalesforceQuickviewDocument
Boilerplate for the customizable quickview. Use the given @member queryString and @member documentID to initialize the state before opening an actual QuickviewDocument.
SalesforceQuickviewQueryController component
Component HTML element class: CoveoSalesforceQuickviewQueryController
Small override of the QueryController component.
Override @method getLastQuery to return a minimalist IQuery using the @member queryString.
Properties
| Property (type) | Description |
|---|---|
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
SalesforceResultLink component
Component HTML element class: CoveoSalesforceResultLink
The SalesforceResultLink component is used to open result links as Salesforce tabs. It inherits from the ResultLink Component .
<a class='CoveoSalesforceResultLink'></a>Options
| Option (type) | Description |
|---|---|
|
Specifies that the result link should try to open as a primary console tab.
If it fails, it instead opens in a new browser tab.
Default is |
|
Specifies that the result link should try to open as a secondary console tab.
If it fails, it instead opens in a new browser tab.
Default is |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Creates a new ResultLink component. |
StandaloneSearchbox component
Component HTML element class: CoveoStandaloneSearchbox
The StandaloneSearchbox component is used to replace the default community searchbox. Its options are fronted in the Experience Builder (see Leverage the Coveo Standalone Searchbox).
To learn how to implement this component in your community, see Integrate a Coveo Community Search component.
Options
| Option (type) | Description |
|---|---|
|
Specifies whether field names should be suggested (see Omnibox - enableFieldAddon). |
|
Specifies whether to complete query extensions (see Omnibox - enableQueryExtensionAddon). |
|
Specifies whether to enable Coveo Machine Learning (see Omnibox - enableQuerySuggestAddon). |
|
Specifies the placeholder text to put in the searchbox when no query is typed. |
|
The name of the search page where the searchbox should redirect. Default value may change depending on your Coveo for Salesforce version. For more information, see Leverage the Coveo Standalone Searchbox. |
|
Specifies whether to trigger a query when the search box is cleared (see Querybox - triggerQueryOnClear). |
Properties
| Property (type) | Description |
|---|---|
|
Allows the component to bind events and execute them only when it’s enabled. |
|
Contains the state of options for different components. Mainly used by ResultLink. |
|
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events. |
|
A disabled component won’t participate in the query, or listen to ComponentEvents. |
|
Allows component to log in the dev console. |
|
Contains the singleton that allows to trigger queries. |
|
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events. |
|
A reference to the root HTMLElement (the SearchInterface). |
|
A reference to the root of every component, the SearchInterface. |
|
A reference to the Analytics.client. |
|
The static ID that each component need to be identified. For example, SearchButton → static ID : SearchButton → className : CoveoSearchButton |
|
Creates a new Omnibox component. Also enables necessary add-ons and binds events on various query events. |
StaticResourceCache component
Component HTML element class: CoveoStaticResourceCache
The StaticResourceCache object is a singleton instance for batching calls to resolve paths to Static Resources. The results are kept in memory to speed up subsequent requests.
Properties
| Property (type) | Description |
|---|---|
|
Sets the RemoteAction caller function to be used. Returns the set resolver function. |
ViewedByCustomerNode component
Component HTML element class: CoveoViewedByCustomerNode
Interface Editor node for the Viewed by Customer.
Properties
| Property (type) | Description |
|---|---|
|
The priority of the match. |
|
Build a ViewedByCustomerNode instance after a node have been matched. |
IQuickviewGetDocumentData component
Component HTML element class: CoveoIQuickviewGetDocumentData
Small extension of the IGetDocumentOptions interface to allow the use of requestData in it.
IResultActionOptions component
Component HTML element class: CoveoIResultActionOptions
The possible options for ResultAction component.
Properties
| Property (type) | Description |
|---|---|
|
The icon that the ResultAction will display. If text is provided, the button will contain that text. If the HTML of an SVG image is provided, that image will be displayed in the button. |
|
The tooltip that displays on hovering the ResultAction. |
IResultQuickActionOptions component
Component HTML element class: CoveoIResultQuickActionOptions
The possible options for ResultQuickAction component.
Properties
| Property (type) | Description |
|---|---|
|
Specifies the name of the Quick Action bound to this result action. |
|
Optional.
Set to |
|
The icon that the ResultAction will display. If text is provided, the button will contain that text. If the HTML of an SVG image is provided, that image will be displayed in the button. |
|
Optional. Specify the name of the event that clients will be able to hook to and modify the arguments before sending the action to Salesforce. |
|
Specifies the current record type. |
|
Specifies the fields that will be sent in the arguments of the quick action.
This argument must be provided as a JSON object.
Fields from the query result can be inserted by placing |
|
The tooltip that displays on hovering the ResultAction. |
|
The arguments provided to the |
|
The arguments that will be provided to the quick action API. |
|
The result that this quick action is associated with. |
IResultQuickActionsEventOnSendAction component
Component HTML element class: CoveoIResultQuickActionsEventOnSendAction
The arguments provided to the onSendAction event.
Properties
| Property (type) | Description |
|---|---|
|
The arguments that will be provided to the quick action API. |
|
The result that this quick action is associated with. |
|
The arguments that will be provided to the quick action API. |
|
The result that this quick action is associated with. |
IViewedByCustomerOptions component
Component HTML element class: CoveoIViewedByCustomerOptions
The options for the ViewedByCustomer component.
Properties
| Property (type) | Description |
|---|---|
|
The label that should be displayed when the component is displayed. |
|
If true, will display an icon when the component is displayed itself. |