webNavigation.onCreatedNavigationTarget
Fired when a new window, or a new tab in an existing window, is created to host the target of a navigation. For example, this event is sent when:
- the user opens a link in a new tab or window
- a web page loads a resource into a new tab or window using
window.open()
(but note that the event is not sent if the browser's popup blocker blocks the load).
The event is not sent if a tab or window is created without a navigation target (for example, if the user opens a new tab by pressing Ctrl+T).
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(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. Returnstrue
if it is listening,false
otherwise.
addListener syntax
Parameters
listener
-
The function called when this event occurs. The function is passed this argument:
filter
Optional-
object
. An object containing a single propertyurl
, which is anArray
ofevents.UrlFilter
objects. If you include this parameter, then the event fires only for transitions to URLs which match at least oneUrlFilter
in the array. If you omit this parameter, the event fires for all transitions. Note thatfilter
is not supported in Firefox.
Additional objects
details
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. processId
Optional Deprecated-
integer
. This value is not set in modern browsers. When it was set, it represented the ID of the process the navigation originated from. 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. tabId
-
integer
. The ID of the newly created tab. timeStamp
-
number
. The time when the browser created the navigation target, in milliseconds since the epoch. url
-
string
. The URL which will be loaded in the new tab. windowId
-
number
. The ID of the window in which the new tab is created.
Browser compatibility
BCD tables only load in the browser
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".
const 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,
);
Note:
This API is based on Chromium's chrome.webNavigation
API. This documentation is derived from web_navigation.json
in the Chromium code.