This component can provide a kind of search-as-you-type functionality, allowing you to easily render complex Result Templates inside the Omnibox component.
<div class="CoveoOmniboxResultList"> <script class="result-template" type="text/x-underscore"> <div> <a class='CoveoResultLink'></a> </div> </script> </div>
Builds and returns an HTMLElement for the given result.
the result to build an HTMLElement from.
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). Component are enabled by default on creation.
Executes a query to fetch new results. After the query returns, renders the new results.
Asserts that there are more results to display by verifying whether the last query has returned as many results as requested.
Asserts that the
ResultList is not currently fetching results.
The number of results to fetch and display.
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.
Get the fields needed to be automatically included in the query for this result list.
Return the bindings, or environment, for the current component.
Gets the list of currently displayed result.
Gets the list of currently displayed result HTMLElement.
Creates a result container and appends each element from the received
HTMLElement array to it. For each element
it appends to the result container, this method triggers a
newResultDisplayed event. Once all elements have been
appended to the result container, the method triggers a
The array of
HTMLElement to render.
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 differents component. Mainly used by ResultLink.
Contains the state of different component (enabled vs disabled). Allows to get/set values. Trigger 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.
A reference to the Analytics.client.
The static ID that each component need to be identified.
For example, SearchButton -> static ID : SearchButton -> className : CoveoSearchButton
Specifies a list a css class that should be ignored when the end user click result in the omnibox
Any element that is specified here should normally be able to handle the standard click event.
Any element that does not match this css class and that is clicked will trigger a redirection by the OmniboxResultList.
Specifies the title to use for this section.
Default value is the localized string for
Specifies the z-index at which to render the ResultList inside the Omnibox.
Default value is
51. Minimum value is
16 (Facet components are at
50 by default)
Specifies the function to execute when the user selects a result suggestion.
The default function opens the corresponding result URI in the browser.
It is only possible to specify a value for this option in the init call of your search interface. You cannot set it directly as an HTML attribute.
Specifies the override to use on the query sent to the OmniboxResultList component.
Default value is
undefined, which means no default override is specified.
Creates a new OmniboxResultList component.
The HTMLElement on which to instantiate the component.
The options for the OmniboxResultList component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).