tabs.onAttached

Fired when a tab is attached to a window, for example because it was moved between windows.

Syntax

js

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

listener

The function called when this event occurs. The function is passed these arguments:

tabId

integer. ID of the tab that was attached to a new window.

attachInfo

object. ID of the new window, and index of the tab within it. See the attachInfo section for more details.

Additional objects

attachInfo

newWindowId

integer. ID of the new window.

newPosition

integer. Index position that the tab has in the new window.

Examples

Listen for attach events, and log the info:

js

function handleAttached(tabId, attachInfo) {
  console.log(`Tab: ${tabId} attached`);
  console.log(`New window: ${attachInfo.newWindowId}`);
  console.log(`New index: ${attachInfo.newPosition}`);
}

browser.tabs.onAttached.addListener(handleAttached);

Browser compatibility

BCD tables only load in the browser

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