omnibox.onInputStarted

Fired when the user starts interacting with your extension by entering its keyword in the address bar and then pressing the space key.

This will be sent before any omnibox.onInputChanged events.

Syntax

js
browser.omnibox.onInputStarted.addListener(listener)
browser.omnibox.onInputStarted.removeListener(listener)
browser.omnibox.onInputStarted.hasListener(listener)

Events have three functions:

addListener(listener)

Adds a listener to this event.

removeListener(listener)

Stop listening to this event. The listener argument is the listener to remove.

hasListener(listener)

Check whether listener is registered for this event. Returns true if it is listening, false otherwise.

addListener syntax

Parameters

listener

The function called when this event occurs. The function is passed no arguments.

Browser compatibility

BCD tables only load in the browser

Examples

js
browser.omnibox.onInputStarted.addListener(() => {
  console.log("User has started interacting with me.");
});

Note: This API is based on Chromium's chrome.omnibox API.