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).
The SearchButton component instance.
A reference to the root of every component, the SearchInterface.
The component instance which allows end users to input queries.
Can be either a Querybox or an Omnibox component, depending on the value of
enableOmnibox.
The static ID that each component needs in order to be identified.
For example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
data-add-search-button='true' data-add-search-button='false'
Specifies whether to instantiate an Omnibox component.
When this option is false, the Searchbox instantiates a Querybox component instead.
Note:
You can use configuration options specific to the component you choose to instantiate with the
Searchbox.
Examples:
In this first case, the Searchbox instantiates a Querybox component. You can configure this Querybox
instance using any of the Querybox component options, such as
triggerQueryOnClear.
<div class='CoveoSearchbox' data-trigger-query-on-clear='true'></div>
In this second case, the Searchbox instantiates an Omnibox component. You can configure this Omnibox
instance using any of the Omnibox component options, such as
placeholder.
Moreover, since the Omnibox component inherits all of the Querybox component options, the
data-trigger-query-on-clear option from the previous example would also work on this Omnibox instance.
<div class='CoveoSearchbox' data-enable-omnibox='true' data-placeholder='Please enter a query'></div>
Default value is true.
data-enable-omnibox='true' data-enable-omnibox='false'
A custom height for the search box (in pixels).
Note: Avoid setting this option if you want to modify the search box styling through custom CSS.
Minimum value is 25
Default behavior: The most specific CSS rules targeting HTML elements generated by the Searchbox component are used (e.g., if you are only using the default CoveoFullSearch.css stylesheet with no further styling customizations, the search box height will be set to 50 pixels by default).
data-height='10'
Creates a new Searchbox component. Creates a new Coveo.Magicbox instance and wraps magic box methods (onblur,
onsubmit, etc.). Binds event on buildingQuery and on redirection (for standalone box).
The HTMLElement on which to instantiate the component. This cannot be an HTMLInputElement for technical reasons.
The options for the Searchbox component. These will merge with the options from the component set
directly on the HTMLElement.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).
The
Searchboxcomponent allows you to conveniently instantiate two components which end users frequently use to enter and submit queries.This component attaches itself to a
divelement and takes care of instantiating either aQueryboxor anOmniboxcomponent (see theenableOmniboxoption). Optionally, theSearchboxcan also instantiate aSearchButtoncomponent, and append it inside the samediv(see theaddSearchButtonoption).