index.md

---

title: webNavigation.onTabReplaced
slug: Mozilla/Add-ons/WebExtensions/API/webNavigation/onTabReplaced
page-type: webextension-api-event
tags:
  - API
  - Add-ons
  - Event
  - Extensions
  - Non-standard
  - Reference
  - WebExtensions
  - onTabReplaced
  - webNavigation
browser-compat: webextensions.api.webNavigation.onTabReplaced

---

{{AddonSidebar()}}

Fired when the contents of the tab is replaced by a different (usually previously pre-rendered) tab.

Syntax

browser.webNavigation.onTabReplaced.addListener(
  listener,                   // function
  filter                      // optional object
);
browser.webNavigation.onTabReplaced.removeListener(listener)
browser.webNavigation.onTabReplaced.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:

    • details

      • : object. See the details section for more information.

Additional objects

details

• replacedTabId

  • : integer. The ID of the tab that was replaced.

• tabId

  • : integer. The ID of the tab that replaced the old tab.

• timeStamp

  • : number. The time when the replacement happened, in milliseconds since the epoch.

Browser compatibility

{{Compat}}

Examples

function logOnTabReplaced(details) {
  console.log(`onTabReplaced ${details}`);
}

browser.webNavigation.onTabReplaced.addListener(logOnTabReplaced);

{{WebExtExamples}}

Note: This API is based on Chromium's chrome.webNavigation API. This documentation is derived from web_navigation.json in the Chromium code.