tabs.remove()

Closes one or more tabs.

If any of the tabs are:

  • part of a split view, the split view is removed.
  • the last tab in a group, the group is removed.

Syntax

js
let removing = browser.tabs.remove(
  tabIds          // integer or integer array
)

Parameters

tabIds

integer or array of integer The ids of the tab or tabs to close.

Return value

A Promise fulfilled with no arguments when all the specified tabs have been removed or their beforeunload prompts have been handled. If any error occurs, the promise is rejected with an error message.

Examples

Close a single tab:

js
function onRemoved() {
  console.log(`Removed`);
}

function onError(error) {
  console.log(`Error: ${error}`);
}

let removing = browser.tabs.remove(2);
removing.then(onRemoved, onError);

Close multiple tabs:

js
function onRemoved() {
  console.log(`Removed`);
}

function onError(error) {
  console.log(`Error: ${error}`);
}

let removing = browser.tabs.remove([15, 14, 1]);
removing.then(onRemoved, onError);

Example extensions

Browser compatibility

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