webNavigation.onReferenceFragmentUpdated

Fired if the fragment identifier for a page is changed. For example, if a page implements a table of contents using fragments, and the user clicks an entry in the table of contents, this event fires. All future events for this frame will use the updated URL.

Syntax

browser.webNavigation.onReferenceFragmentUpdated.addListener(
  listener,                   // function
  filter                      // optional object
)
browser.webNavigation.onReferenceFragmentUpdated.removeListener(listener)
browser.webNavigation.onReferenceFragmentUpdated.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 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 is about to occur.
• url
  • : string. The URL to which the given frame will navigate.
• frameId
  • : integer. Frame in which the navigation will occur. 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".
• transitionType
  • : {{WebExtAPIRef("webNavigation.transitionType", "transitionType")}}. The reason for the navigation: for example, "link" if the user clicked a link.
• transitionQualifiers
  • : Array of {{WebExtAPIRef("webNavigation.transitionQualifier", "transitionQualifier")}}. Extra information about the navigation: for example, whether there was a server or client redirect.
• timeStamp
  • : number. The time that the fragment identifier for the page was changed, 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 and extra transition information for onReferenceFragmentUpdated, if the target URL's hostname contains "example.com" or starts with "developer".

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

function logOnReferenceFragmentUpdated(details) {
  console.log(`onReferenceFragmentUpdated: ${details.url}`);
  console.log(`Transition type: ${details.transitionType}`);
  console.log(`Transition qualifiers: ${details.transitionQualifiers}`);
}

browser.webNavigation.onReferenceFragmentUpdated.addListener(
  logOnReferenceFragmentUpdated,
  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.