tabs.move()

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

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

Syntax

browser.tabs.move(
  tabIds,              // integer or integer array
  moveProperties,      // object
  function(tabs) {...} // optional function
)

Parameters

tabIds

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

If you move more than one tab to a single window, the first tab in the array will be moved to the given index position, and the other tabs will follow it in the order given here.

moveProperties

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

windowIdOptional

integer. The ID of the window to which you want to move the tab(s). If you omit this, then each tab is relocated within its current window.

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

callbackOptional

function. The function is passed the following arguments:

tabs

tabs.Tab or array of tabs.Tab. Details about the moved tabs.

In Firefox, 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. In Chrome, this will pass the tabs that you tried to move, with their indices updated to the destination indices you asked for, even if the tabs were not actually moved.

Browser compatibility

Examples

Example add-ons

• tabs-tabs-tabs

// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.