tabs.onReplaced

Fired when a tab is replaced with another tab due to prerendering or instant.

Syntax

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

addedTabId
integer. ID of the replacement tab.
removedTabId
integer. ID of the tab that was replaced.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes No 45.0 No 33

Examples

Listen for replacement events, and log the associated info:

function handleReplaced(addedTabId, removedTabId) {
  console.log("New tab: " + addedTabId);
  console.log("Old tab: " + removedTabId);
}

browser.tabs.onReplaced.addListener(handleReplaced);

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,