webNavigation.onDOMContentLoaded

Fired when the DOMContentLoaded event is fired in the page. At this point the document is loaded and parsed, and the DOM is fully constructed, but linked resources such as images, stylesheets and subframes may not yet be loaded.

Syntax

browser.webNavigation.onDOMContentLoaded.addListener(
  listener,                   // function
  filter                      // optional object
)
browser.webNavigation.onDOMContentLoaded.removeListener(listener)
browser.webNavigation.onDOMContentLoaded.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_inline}}

  • : object. An object containing a single property url, which is an {{jsxref("Array")}} of {{WebExtAPIRef("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 has occurred.
• url
  • : string. The URL to which the given frame has navigated.
• frameId
  • : integer. Frame in which the navigation is occurring. 0 indicates that navigation happens in the tab's top-level browsing context, not in a nested {{HTMLElement("iframe")}}. A positive value indicates that navigation happens in a nested iframe. Frame IDs are unique for a given tab and process.
• frameType
  • : string. The type of frame the navigation occurred in. Returns the values "outermost_frame", "fenced_frame", and "sub_frame".
• parentFrameId
  • : integer. ID of this frame's parent. Set to -1 if this is a top-level frame.
• documentId
  • : string. A UUID of the document loaded.
• 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", and "pending_deletion".
• timeStamp
  • : number. The time at which DOMContentLoaded was fired, in milliseconds since the epoch.
• processId {{optional_inline}} {{deprecated_inline}}
  • : 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 onDOMContentLoaded, if the target URL's hostname contains "example.com" or starts with "developer".

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

function logOnDOMContentLoaded(details) {
  console.log(`onDOMContentLoaded: ${details.url}`);
}

browser.webNavigation.onDOMContentLoaded.addListener(
  logOnDOMContentLoaded,
  filter,
);

{{WebExtExamples}}

Browser compatibility

{{Compat}}

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