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
js
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. Returnstrue
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 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.
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 fragment identifier for the page was changed, in milliseconds since the epoch. transitionType
-
. The reason for the navigation: for example,transitionType
"link"
if the user clicked a link. transitionQualifiers
-
Array
oftransitionQualifier
. Extra information about the navigation: for example, whether there was a server or client redirect.
Browser compatibility
BCD tables only load in the browser
Examples
Logs the target URLs and extra transition information for onReferenceFragmentUpdated
, if the target URL's hostname contains "example.com" or starts with "developer".
js
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);
Note: This API is based on Chromium's chrome.webNavigation
API. This documentation is derived from web_navigation.json
in the Chromium code.