tabs.move()

Moves one or more tabs to a new position in the same window or to a different window.

You can only move tabs to and from windows whose WindowType is "normal".

This is an asynchronous function that returns a Promise.

Syntax

js
let moving = browser.tabs.move(
  tabIds,              // integer or integer array
  moveProperties       // object
)

Parameters

tabIds

integer or array of integer. ID of the tab to move, or an array of tab IDs.

moveProperties

object. An object that specifies where to move the tab(s).

windowId Optional

integer. The ID of the window to which you want to move the tab(s). If you omit this, then each tab in tabIds will be moved to index in its current window. If you include this, and tabIds contains more than one tab, then the first tab in tabIds will be moved to index, and the other tabs will follow it in the order given in tabIds.

index

integer. The index position to move the tab to, starting at 0. A value of -1 will place the tab at the end of the window.

If you pass a value less than -1, the function will throw an error.

Note that you can't move pinned tabs to a position after any unpinned tabs in a window, or move any unpinned tabs to a position before any pinned tabs. For example, if you have one or more pinned tabs in the target window and tabIds refers to an unpinned tab, then you can't pass 0 here. If you try to do this, the function will silently fail (it will not throw an error).

Return value

A Promise that will be fulfilled with a tabs.Tab object or an array of tabs.Tab objects, containing details about the moved tabs. If no tabs were moved (for example, because you tried to move an unpinned tab before a pinned tab) this will be an empty array. If any error occurs, the promise will be rejected with an error message.

Examples

Move the first tab in the current window to the last position in the current window:

js
function onMoved(tab) {
  console.log(`Moved: ${tab}`);
}

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

function firstToLast(windowInfo) {
  if (windowInfo.tabs.length === 0) {
    return;
  }
  let moving = browser.tabs.move(windowInfo.tabs[0].id, { index: -1 });
  moving.then(onMoved, onError);
}

browser.browserAction.onClicked.addListener(() => {
  let gettingCurrent = browser.windows.getCurrent({ populate: true });
  gettingCurrent.then(firstToLast, onError);
});

Move all tabs served over HTTP or HTTPS from *.mozilla.org to the end of their window:

js
function onMoved(tab) {
  console.log(`Moved: ${tab}`);
}

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

function moveMoz(tabs) {
  let mozTabIds = tabs.map((tabInfo) => tabInfo.id);
  let moving = browser.tabs.move(mozTabIds, { index: -1 });
  moving.then(onMoved, onError);
}

browser.browserAction.onClicked.addListener(() => {
  let gettingMozTabs = browser.tabs.query({ url: "*://*.mozilla.org/*" });
  gettingMozTabs.then(moveMoz, onError);
});

Move all tabs served over HTTP or HTTPS from *.mozilla.org to the window that hosts the first such tab, starting at position 0:

js
function onMoved(tab) {
  console.log(`Moved: ${tab}`);
}

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

function moveMoz(tabs) {
  let mozTabIds = tabs.map((tabInfo) => tabInfo.id);
  let targetWindow = tabs[0].windowId;
  let moving = browser.tabs.move(mozTabIds, {
    windowId: targetWindow,
    index: 0,
  });
  moving.then(onMoved, onError);
}

browser.browserAction.onClicked.addListener(() => {
  let gettingMozTabs = browser.tabs.query({ url: "*://*.mozilla.org/*" });
  gettingMozTabs.then(moveMoz, onError);
});

Example extensions

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.getZoom