Coveo QuerySummary Component (CoveoQuerySummary)

The QuerySummary component can display information about the currently displayed range of results (e.g., "Results 1-10 of 123").

When the query does not match any items, the QuerySummary component can instead display information to the end users.

The information displayed to the end user is customizable through this component.

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

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

enableCancelLastAction

enableCancelLastAction: boolean

Specifies whether to display the Cancel last action link when there are no search results.

When clicked, the link restores the previous query that contained results.

Default value is true.

Default

true

Markup configuration example(s) :
data-enable-cancel-last-action='true'
data-enable-cancel-last-action='false'

enableNoResultsFoundMessage

enableNoResultsFoundMessage: boolean

Specifies whether to display the QuerySummary.options.noResultsFoundMessage message when there are no search results.

Default value is true.

Default

true

Available since

August 2018 Release (v2.4609.6)

Markup configuration example(s) :
data-enable-no-results-found-message='true'
data-enable-no-results-found-message='false'

enableSearchTips

enableSearchTips: boolean

Specifies whether to display search tips when there are no search results.

Default value is true.

Default

true

Markup configuration example(s) :
data-enable-search-tips='true'
data-enable-search-tips='false'

noResultsFoundMessage

noResultsFoundMessage: string

Specifies a custom message to display when there are no search results.

You can refer to the query the end user has entered using the ${query} query tag.

Example

For the noResultFoundMessage option, you enter There were no results found for "${query}". Your end user searches for query without results, which does not return any result. On your page, they see this message: There were no results found for "query without results".

Default value is No results for ${query}.

Note

If there is no query, the value will fallback to No results.

Only effective when

enableNoResultsFoundMessage is truthy

Available since

August 2018 Release (v2.4609.6)

Markup configuration example(s) :
data-no-results-found-message='foo'

onlyDisplaySearchTips

onlyDisplaySearchTips: boolean

Specifies whether to hide the number of returned results.

When this option is set to true, the number of returned results will be hidden from the page, meaning that your end users will not know how many results were returned for their query.

Default value is false.

Default

false

Markup configuration example(s) :
data-only-display-search-tips='true'
data-only-display-search-tips='false'

Constructors

constructor

  • Creates a new QuerySummary component.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component.

    • Optional options: IQuerySummaryOptions

      The options for the QuerySummary 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).

    Returns QuerySummary