W3cubDocs

/Web Extensions

history.onTitleChanged

Fired when the title of a page visited by the user is recorded. To listen for visits to a page you can use history.onVisited. However, the history.HistoryItem that this event passes to its listener does not include the page title, because the page title is typically not known at the time history.onVisited is sent. Instead, the stored history.HistoryItem is updated with the page title after the page has loaded, once the title is known. The history.onTitleChanged event is fired at that time. So if you need to know the titles of pages as they are visited, listen for history.onTitleChanged.

Syntax

browser.history.onTitleChanged.addListener(listener)
browser.history.onTitleChanged.removeListener(listener)
browser.history.onTitleChanged.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

callback

Function that will be called when this event occurs. The function will be passed an object with the following properties:

url
String. URL of the page visited.
title
String. Title of the page visited.

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
onTitleChanged
No
No
55
?
No
No
?
?
No
?
?
?

Examples

Listen for title change events, and log the URL and title of the visited pages.

function handleTitleChanged(item) {
  console.log(item.title);
  console.log(item.url);
}

browser.history.onTitleChanged.addListener(handleTitleChanged);

Note: This API is based on Chromium's chrome.history API. This documentation is derived from history.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.

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/history/onTitleChanged