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 will fire. 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(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.

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.
processId
integer. The ID of the process in which this tab is being rendered.
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 iframe. A positive value indicates that navigation happens in a nested iframe. Frame IDs are unique for a given tab and process.
timeStamp
number. The time that the navigation was committed, in milliseconds since the epoch.
transitionType
transitionType. The reason for the navigation: for example, "link" if the user clicked a link.
transitionQualifiers
Array of transitionQualifier. Extra information about the navigation: for example, whether there was a server or client redirect.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
Basic supportChrome Full support Yes
Notes
Full support Yes
Notes
Notes If the filter parameter is empty, Chrome matches all URLs.
Edge Full support 14
Notes
Full support 14
Notes
Notes Filtering is not supported.
Firefox Full support 45
Notes
Full support 45
Notes
Notes Filtering is supported from version 50.
Notes If the filter parameter is empty, Firefox raises an exception.
Opera Full support 17
Notes
Full support 17
Notes
Notes If the filter parameter is empty, Opera matches all URLs.
Firefox Android Full support 48
Notes
Full support 48
Notes
Notes Filtering is supported from version 50.
Notes If the filter parameter is empty, Firefox raises an exception.
transitionQualifiersChrome Full support YesEdge No support NoFirefox Full support 48Opera Full support 17Firefox Android Full support 48
transitionTypeChrome Full support YesEdge No support NoFirefox Full support 48Opera Full support 17Firefox Android Full support 48

Legend

Full support  
Full support
No support  
No support
See implementation notes.
See implementation notes.

Examples

Logs the target URLs and extra transition information for onReferenceFragmentUpdated, if the target URL's hostname contains "example.com" or starts with "developer".

var 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);

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: michael-zapata, wbamberg, Makyen
Last updated by: michael-zapata,