Coveo ResultFolding Component (CoveoResultFolding)

The ResultFolding component renders folded result sets. It is usable inside a result template when there is an active Folding component in the page. This component takes care of rendering the parent result and its child results in a coherent manner.

This component is a result template component (see Result Templates).

See Folding Results.

Index

Methods

Properties

Accessors

Component Options

Constructors

Methods

debugInfo

  • debugInfo(): any

disable

  • disable(): void

  • 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.

    Returns void

enable

  • enable(): void

  • 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.

    Returns void

getBindings

showLessResults

  • showLessResults(): Promise<void>

showMoreResults

  • showMoreResults(): Promise<IQueryResult[]>

  • Show more results by fetching additional results from the index, which match the current folded conversation. This is the equivalent of clicking "Show all conversation".

    Returns Promise<IQueryResult[]>

Static get

  • get(element: HTMLElement, componentClass?: any, noThrow?: boolean): BaseComponent

  • 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.

    Parameters

    • element: HTMLElement

      HTMLElement for which to get the bound component.

    • Optional componentClass: any

      Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.

    • Optional noThrow: boolean

      Boolean option to tell the method to not throw on error.

    Returns BaseComponent

Properties

bind

bind: ComponentEvents

Allows the component to bind events and execute them only when it is enabled.

type

{Coveo.ComponentEvents}

componentOptionsModel

componentOptionsModel: ComponentOptionsModel

Contains the state of options for different components. Mainly used by ResultLink.

componentStateModel

componentStateModel: ComponentStateModel

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.

disabled

disabled: boolean

A disabled component will not participate in the query, or listen to ComponentEvents.

type

{boolean}

logger

logger: Logger

Allows component to log in the dev console.

queryController

queryController: QueryController

Contains the singleton that allows to trigger queries.

queryStateModel

queryStateModel: QueryStateModel

Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.

root

root: HTMLElement

A reference to the root HTMLElement (the SearchInterface).

searchInterface

searchInterface: SearchInterface

A reference to the root of every component, the SearchInterface.

Static ID

ID: string

The static ID that each component needs in order to be identified.
For example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton

Accessors

usageAnalytics

Component Options

expandedCaption

expandedCaption: string

Specifies the caption to display at the top of the child results when the folding result set is expanded.

Default value is undefined, which displays no caption.

Markup configuration example(s) :
data-expanded-caption='foo'

lessCaption

lessCaption: string

Specifies the caption to display on the link to shrink the loaded folding result set back to only the top result.

Default value is the localized string for ShowLess.

Markup configuration example(s) :
data-less-caption='foo'

moreCaption

moreCaption: string

Specifies the caption to display on the link to expand / show child results.

Default value is the localized string for ShowMore.

Markup configuration example(s) :
data-more-caption='foo'

normalCaption

normalCaption: string

Specifies the caption to display at the top of the child results when the folding result set is not expanded.

Default value is undefined, which displays no caption.

Markup configuration example(s) :
data-normal-caption='foo'

oneResultCaption

oneResultCaption: string

Specifies the caption to display when there is only one result in a folding result set.

Default value is the localized string for DisplayingTheOnlyMessage

Markup configuration example(s) :
data-one-result-caption='foo'

resultTemplate

resultTemplate: Template

Specifies the template to use to render each of the child results for a top result.

You can specify a previously registered template to use either by referring to its HTML id attribute or to a CSS selector (see TemplateCache).

Example:

Specifying a previously registered template by referring to its HTML id attribute:

<span class="CoveoResultFolding" data-result-template-id="Foo"></span>

Specifying a previously registered template by referring to a CSS selector:

<span class='CoveoResultFolding' data-result-template-selector="#Foo"></span>

If you do not specify a custom folding template, the component uses the default result folding template.

Constructors

constructor

  • Creates a new ResultFolding component.

    Parameters

    • element: HTMLElement
    • Optional options: IResultFoldingOptions

      The options for the ResultFolding component.

    • Optional bindings: IComponentBindings

      The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).

    • Optional result: IQueryResult

      The result to associate the component with.

    Returns ResultFolding