The HiddenQuery component handles a "hidden" query parameter (
hq) and its description (
Concretely, this means that if a HiddenQuery component is present in your page and you load your search interface
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).
hq set in the QueryStateModel.
Also logs the
contextRemove event in the usage analytics and triggers a new query.
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
Specifies the maximum number of characters from the hidden query description (
hd) to display in the
Beyond this length, the HiddenQuery component slices the rest of the description and replaces it by
Default value is
100. Minimum value is
Specifies the title that should appear in the Breadcrumb when the HiddenQuery populates it.
Default value is the localized string f
The HTMLElement on which to instantiate the component.
The options for the HiddenQuery component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).