Return the debug info about this component.
Disable the component. Normally this means that the component will not execute handlers for the framework events (query events, for example). Components are enabled by default on creation.
Enable the component. Normally this means that the component will execute handlers for the framework events (query events, for example). Components are enabled by default on creation.
Return the bindings, or environment, for the current component.
Get the bound component to the given HTMLElement. Throws an assert if the HTMLElement has no component bound, unless using the noThrow argument.
If there is multiple component bound to the current HTMLElement, you must specify the component class.
HTMLElement for which to get the bound component.
Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.
Boolean option to tell the method to not throw on error.
Allows the component to bind events and execute them only when it is 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 will not 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.
The static ID that each component needs in order to be identified.
For example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
Specifies the field that determines whether a certain result is a child of another top result.
Note:
In the index, the values of the corresponding field must:
- Contain alphanumerical characters only.
- Contain no more than 60 characters.
Default value is @foldingchild.
data-child='@foo'
This option is deprecated. Instead, use the Folding.options.parent option.
data-child-field='@foo'
Specifies whether to add a callback function on the top result, allowing to make an additional query to load all of its child results (e.g., to load all conversations of a given thread).
Concretely, the ResultFolding component uses this for its Show More link.
See also the expandExpression and
maximumExpandedResults options.
Default value is true.
data-enable-expand='true' data-enable-expand='false'
If the enableExpand option is true, specifies a custom constant
expression to send when querying the expanded results.
Default value is undefined.
data-expand-expression='foo'
Specifies the name of the field on which to do the folding.
Specifying a value for this option is required for this component to work.
Note:
In an Elasticsearch index, the corresponding field must be configured as a Facet field (see Add or Edit Fields). This limitation does not apply to Coveo indexes.
Default value is @foldingcollection.
data-field='@foo'
Specifies the function that manages the folding of all results.
Default value is:
Coveo.Folding.defaultGetMoreResults = function(results) {
// The results are flat, just do the folding.
return Coveo.Folding.foldWithParent(results);
}
Specifies the function that manages the individual folding of each result.
Default value is:
var results = result.childResults || [];
// Add the top result at the top of the list.
results.unshift(result);
// Empty childResults just to clean it.
result.childResults = [];
// Fold those results.
results = Coveo.Folding.foldWithParent(results);
// The first result is the top one.
var topResult = results.shift();
// All other results are childResults.
topResult.childResults = results;
return topResult;
You can pre-process all the result with this option in the init call of your search interface:
Coveo.init(document.querySelector('#search'), {
Folding: {
getResult: function(result) {
result = Coveo.Folding.defaultGetResult(result);
// Your code here
}
}
})
If the enableExpand option is true, specifies the maximum number of
results to load when expanding.
Default value is 100. Minimum value is 1.
data-maximum-expanded-results='10'
Specifies the field that determines whether a certain result is a top result containing other child results.
Note:
In the index, the values of the corresponding field must:
- Contain alphanumerical characters only.
- Contain no more than 60 characters.
Default value is @foldingparent.
data-parent='@foo'
This option is deprecated. Instead, use the Folding.options.child option.
data-parent-field='@foo'
Specifies the maximum number of child results to fold.
Example:
For an email thread with a total of 20 messages, using the default value of
2means that the component loads up to a maximum of 2 child messages under the original message, unless the end user expands the entire conversation using the Show More link (see theenableExpandoption).
Default value is 2. Minimum value is 0.
data-range='10'
Specifies the sort criteria to apply to the top result and its child results (e.g., date ascending,
@myfield descending, etc.). See sortCriteria.
This option works from the results returned by the index. This means that if only the three most relevant folded results are returned by the index and you choose to rearrange the folded results by date, then the three most relevant results will be rearranged by date, meaning that the first folded result is not necessarily the oldest or newest item.
However, since clicking on the Show More button triggers a new query, you would receive new results based on the sort criteria of this option.
Example
If you are folding email results by conversation and you specify
date descendingas therearrangevalue of theFoldingcomponent, the component re-arranges email conversations so that the newest email is always the top result. Specifyingdate ascendinginstead always makes the original email the top result, as it is also necessarily the oldest.
By default, the component displays the results in the order that the index returns them.
Creates a new FoldingForThread component
The HTMLElement on which to instantiate the component.
The options for the FoldingForThread component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).
The
FoldingForThreadcomponent inherits from theFoldingcomponent. It offers the same configuration options.Folding conversations and threads requires different processing. When you need to fold all child items (including their attachments) on the same level under a common ancestor item, use this component rather than the
Foldingcomponent.This component works well with Chatter and Lithium.
Note:
See Folding Results.