# Class OmniboxEvents

The `OmniboxEvents` static class contains the string definitions of all events that strongly relate to the `Omnibox` component.

## Index

### Properties

- buildingQuerySuggest
- populateOmniboxSuggestions
- querySuggestGetFocus
- querySuggestLoseFocus
- querySuggestRendered
- querySuggestSelection
- querySuggestSuccess

## Properties

### Static buildingQuerySuggest

buildingQuerySuggest: string

- Defined in events/OmniboxEvents.ts :87

Triggered by the `Omnibox` component before sending a query suggestion request to the Search API.

Allows external functions to refine the payload b3efore sending the request.

This event is only triggered by standard ML-powered query suggestions, and not AnalyticsSuggestions or FieldSuggestions.

### Static populateOmniboxSuggestions

populateOmniboxSuggestions: string

- Defined in events/OmniboxEvents.ts :76

Triggered by the `Omnibox` component before query completion suggestions are rendered.

The out-of-the-box Coveo JavaScript Search Framework query completion suggestion addons (see the `enableFieldAddon`, `enableQueryExtensionAddon`, and `enableQuerySuggestAddon` options of the `Omnibox`) push their respective suggestions in the argument object which is passed along with this event.

All `populateOmniboxSuggestions` event handlers receive a `PopulateOmniboxSuggestionsEventArgs` object as an argument.

type

  {string} The string value is `populateOmniboxSuggestions`.

### Static querySuggestGetFocus

querySuggestGetFocus: string

- Defined in events/OmniboxEvents.ts :105

Triggered by the `Omnibox` component when a query suggestion gets focus following a mouse hovering or keyboard navigation event.

All `querySuggestGetFocus` event handlers receive an object implementing the `IQuerySuggestSelection` interface as an argument.

### Static querySuggestLoseFocus

querySuggestLoseFocus: string

- Defined in events/OmniboxEvents.ts :109

Triggered by the `Omnibox` component when a query suggestion loses focus following a mouse hovering or keyboard navigation event.

### Static querySuggestRendered

querySuggestRendered: string

- Defined in events/OmniboxEvents.ts :99

Triggered by the `Omnibox` component when a query suggestion has finished rendering.

### Static querySuggestSelection

querySuggestSelection: string

- Defined in events/OmniboxEvents.ts :115

Triggered by the `Omnibox` component when a query suggestion is selected by a mouse click or pressing the enter key.

All `querySuggestSelection` event handlers receive an object implementing the `IQuerySuggestSelection` interface as an argument.

### Static querySuggestSuccess

querySuggestSuccess: string

- Defined in events/OmniboxEvents.ts :95

Triggered by the `Omnibox` component when query suggestions are received from the Search API.

Allows external functions to look into the received query suggestions, and modify them if needed.

This event is only triggered by standard ML-powered query suggestions, and not AnalyticsSuggestions or FieldSuggestions.

### Hierarchy

- OmniboxEvents