webNavigation.onHistoryStateUpdated
Fired when the page used the history API to update the URL displayed in the browser's location bar. All future events for this frame will use the updated URL.
Fired when the page used the history API to update the URL displayed in the browser's location bar. All future events for this frame will use the updated URL.
Syntax
browser.webNavigation.onHistoryStateUpdated.addListener(
listener, // function
filter // optional object
)
browser.webNavigation.onHistoryStateUpdated.removeListener(listener)
browser.webNavigation.onHistoryStateUpdated.hasListener(listener)
Events have three functions:
addListener(listener)- : Adds a listener to this event.
removeListener(listener)- : Stop listening to this event. The
listenerargument is the listener to remove. hasListener(listener)- : Check whether
listeneris registered for this event. Returnstrueif it is listening,falseotherwise.
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 - :
object. An object containing a single propertyurl, which is anArrayof events.UrlFilter objects. If you include this parameter, then the event fires only for transitions to URLs which match at least oneUrlFilterin 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.0indicates 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- :
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-1if this is a top-level frame. documentId- :
string. A UUID of the document loaded. See the Work with documentId article for more information. parentDocumentId- :
string. A UUID of the parent document owning the frame. Not set if there is no parent. See the Work with documentId article for more information. documentLifecycle- :
string. The lifecycle the document is in. Returns the values"prerender","active","cached", and"pending_deletion". transitionType- : transitionType. The reason for the navigation: for example,
"link"if the user clicked a link. transitionQualifiers- :
Arrayof transitionQualifier. Extra information about the navigation: for example, whether there was a server or client redirect. timeStamp- :
number. The time that the URL was changed by the history API, in milliseconds since the epoch. processId- :
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 onHistoryStateUpdated, if the target URL's hostname contains "example.com" or starts with "developer".
const filter = {
url: [{ hostContains: "example.com" }, { hostPrefix: "developer" }],
};
function logOnHistoryStateUpdated(details) {
console.log(`onHistoryStateUpdated: ${details.url}`);
console.log(`Transition type: ${details.transitionType}`);
console.log(`Transition qualifiers: ${details.transitionQualifiers}`);
}
browser.webNavigation.onHistoryStateUpdated.addListener(
logOnHistoryStateUpdated,
filter,
);
Browser compatibility
[!NOTE] This API is based on Chromium's
chrome.webNavigationAPI. This documentation is derived fromweb_navigation.jsonin the Chromium code.