Add-ons

tabs.onUpdated

Fired when a tab is updated.

Syntax

browser.tabs.onUpdated.addListener(listener)
browser.tabs.onUpdated.removeListener(listener)
browser.tabs.onUpdated.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:

tabId
integer. ID of the tab that was updated.
changeInfo
object. Contains properties for the tab properties that have changed. See changeInfo below.
tab
tabs.Tab. The new state of the tab.

Additional objects

changeInfo

Lists the changes to the state of the tab that was updated. To learn more about these properties, see the tabs.Tab documentation.

audibleOptional
boolean. The tab's new audible state.
discarded Optional
boolean. Whether the tab is discarded. A discarded tab is one whose content has been unloaded from memory, but is still visible in the tab strip. Its content gets reloaded the next time it's activated.
favIconUrlOptional
string. The tab's new favicon URL.
mutedInfoOptional
tabs.MutedInfo. The tab's new muted state and the reason for the change.
pinnedOptional
boolean. The tab's new pinned state.
statusOptional
string. The status of the tab. Can be either loading or complete.
titleOptional
string. The tab's new title.
urlOptional
string. The tab's URL if it has changed.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic Support (Yes) (Yes)4554 (Yes)
changeInfo.audible (Yes) (Yes)4554 (Yes)
changeInfo.discarded (Yes) (Yes)5757 (Yes)
changeInfo.favIconUrl (Yes) (Yes)4554 (Yes)
changeInfo.mutedInfo (Yes) (Yes)4554 (Yes)
changeInfo.pinned (Yes) (Yes)4554 (Yes)
changeInfo.status (Yes) (Yes)4554 (Yes)
changeInfo.title (Yes) (Yes)5354 (Yes)
changeInfo.url (Yes) (Yes)4554 (Yes)

Examples

Listen for and log all the change info and new state:

function handleUpdated(tabId, changeInfo, tabInfo) {
  console.log("Updated tab: " + tabId);
  console.log("Changed attributes: ");
  console.log(changeInfo);
  console.log("New tab Info: ");
  console.log(tabInfo);  
}

browser.tabs.onUpdated.addListener(handleUpdated);

Log changes to URLs:

function handleUpdated(tabId, changeInfo, tabInfo) {
  if (changeInfo.url) {
    console.log("Tab: " + tabId +
                " URL changed to " + changeInfo.url);
  }
}

browser.tabs.onUpdated.addListener(handleUpdated);

Example extensions

Acknowledgements

This API is based on Chromium's chrome.tabs API. This documentation is derived from tabs.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: wbamberg, Makyen
 Last updated by: wbamberg,