Coveo HiddenQuery Component (CoveoHiddenQuery)

The HiddenQuery component handles a "hidden" query parameter (hq) and its description (hd).

Concretely, this means that if a HiddenQuery component is present in your page and you load your search interface with hq=foo&hd=bar in the URL hash, the component adds foo as an expression to the query (hq is the hidden query) and renders bar in the Breadcrumb (hd is the hidden query description).

Index

Methods

Properties

Accessors

Component Options

Constructors

Methods

clear

  • clear(): void

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

maximumDescriptionLength

maximumDescriptionLength: number

Specifies the maximum number of characters from the hidden query description (hd) to display in the Breadcrumb.

Beyond this length, the HiddenQuery component slices the rest of the description and replaces it by ....

Default value is 100. Minimum value is 0.

Minimum

0

Default

100

Markup configuration example(s) :
data-maximum-description-length='10'

title

title: string

Specifies the title that should appear in the Breadcrumb when the HiddenQuery populates it.

Default value is the localized string f or "Additional filters:"

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

Constructors

constructor