The DidYouMean component is responsible for displaying query corrections. If this component is in the page and the query returns no result but finds a possible query correction, the component either suggests the correction or automatically triggers a new query with the suggested term.
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.
Executes a query with the corrected term.
Throws an exception if the corrected term has not been initialized.
If successful, logs a
didyoumeanClick event in the usage analytics.
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 whether the DidYouMean component automatically triggers a new query when a query returns no result and a possible correction is available.
Default value is
Creates a new DidYouMean component.
The HTMLElement on which to instantiate the component.
The options for the DidYouMean component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).