webNavigation.onCreatedNavigationTarget

Fired when a new window, or a new tab in an existing window, is created to host a navigation: for example, if the user opens a link in a new tab.

If this event is fired, it will be fired before webNavigation.onBeforeNavigate.

Syntax

browser.webNavigation.onCreatedNavigationTarget.addListener(
  listener,                   // function
  filter                      // optional object 
)
browser.webNavigation.onCreatedNavigationTarget.removeListener(listener)
browser.webNavigation.onCreatedNavigationTarget.hasListener(listener)

Events have three functions:

addListener(callback)
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

callback

Function that will be called when this event occurs. The function will be passed the following arguments:

details
object. Details about the navigation event.
filterOptional

object. An object containing a single property url, which is an Array of events.UrlFilter objects. If you include this parameter, then the event will fire only for transitions to URLs which match at least one UrlFilter in the array. If you omit this parameter, the event will fire for all transitions. Note that filter is not supported in Firefox.

Additional objects

details

sourceTabId
integer. The ID of the tab from which the navigation is initiated. For example, if the user opens a link in a new tab, this will be the ID of the tab containing the link.
url
string. The URL to which the new frame will navigate.
sourceProcessId
integer. The ID of the process from which the navigation is initiated.
sourceFrameId
integer. ID of the frame from which the navigation is initiated. 0 indicates that the frame is the tab's top-level browsing context, not a nested iframe. A positive value indicates that navigation is initiated from a nested iframe. Frame IDs are unique for a given tab and process.
timeStamp
number. The time when the browser created the navigation target, in milliseconds since the epoch.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes Yes No No 33

Examples

Logs the target URL, source Tab ID, and source frame ID for onCreatedNavigationTarget, if the target's hostname contains "example.com" or starts with "developer".

var filter = {
  url:
  [
    {hostContains: "example.com"},
    {hostPrefix: "developer"}
  ]
}

function logOnCreatedNavigationTarget(details) {
  console.log("onCreatedNavigationTarget: " + details.url);
  console.log(details.sourceTabId);
  console.log(details.sourceFrameId);
}

browser.webNavigation.onCreatedNavigationTarget.addListener(logOnCreatedNavigationTarget, filter);

Acknowledgements

This API is based on Chromium's chrome.webNavigation API. This documentation is derived from web_navigation.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Contributors to this page: wbamberg, Makyen
 Last updated by: wbamberg,