webNavigation.onBeforeNavigate

Syntax

browser.webNavigation.onBeforeNavigate.addListener(
  listener,                   // function
  filter                      // optional object
)
browser.webNavigation.onBeforeNavigate.removeListener(listener)
browser.webNavigation.onBeforeNavigate.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 this argument:

details

object. Details about the navigation event. See the details section for more information.

filter Optional

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

Additional objects

details

tabId

integer. The ID of the tab in which the navigation is about to occur.

url

string. The URL to which the given frame will navigate.

frameId

integer. Frame in which the navigation is about to occur. 0 indicates that navigation happens in the tab's top-level browsing context, not in a nested <iframe>. A positive value indicates that navigation happens in a nested iframe. Frame IDs are unique for a given tab and process. frameType

frameType

string. The type of frame. Returns the values "outermost_frame", "fenced_frame", or "sub_frame" .

parentFrameId

integer. ID of this frame's parent. Set to -1 if this is a top-level frame.

parentDocumentId

string. A UUID of the parent document owning the frame. Not set if there is no parent.

documentLifecycle

string. The lifecycle the document is in. Returns the values "prerender", "active", "cached", or "pending_deletion".

timeStamp

number. The time when the browser is about to start the navigation, in milliseconds since the epoch.

processId Optional Deprecated

integer. This value is not set in modern browsers. When it was set, it represented the ID of the process running the renderer for this tab.

Examples

Logs the target URLs for onBeforeNavigate, if the target's hostname contains "example.com" or starts with "developer".

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

function logOnBefore(details) {
  console.log(`onBeforeNavigate to: ${details.url}`);
}

browser.webNavigation.onBeforeNavigate.addListener(logOnBefore, filter);

Browser compatibility