tabs.create()

Creates a new tab.

Syntax

chrome.tabs.create(
  createProperties,   // object
  function(tab) {...} // optional function
)

This API is also available as browser.tabs.create() in a version that returns a promise.

Parameters

createProperties

object. Properties to give the new tab.

activeOptional

boolean. Whether the tab should become the active tab in the window. Does not affect whether the window is focused (see windows.update). Defaults to true.

indexOptional

integer. The position the tab should take in the window. The provided value will be clamped to between zero and the number of tabs in the window.

openerTabIdOptional

integer. The ID of the tab that opened this tab. If specified, the opener tab must be in the same window as the newly created tab.

pinnedOptional

boolean. Whether the tab should be pinned. Defaults to false.

selectedOptional

boolean. Whether the tab should become the selected tab in the window. Defaults to true.

This property is deprecated, and is not supported in Firefox. Use active instead.

urlOptional

string. The URL to navigate the tab to initially. Fully-qualified URLs must include a scheme (i.e. 'https://www.google.com', not 'www.google.com'). Relative URLs will be relative to the current page within the extension. Defaults to the New Tab Page.

For security reasons, in Firefox, this may not be a privileged URL. So passing any of the following URLs will fail, with runtime.lastError being set to an error message:

• chrome: URLs
• javascript: URLs
• data: URLs
• privileged about: URLs (for example, about:config, about:addons, about:debugging) . Non-privileged URLs (e.g., about:blank) are allowed.

windowIdOptional

integer. The window to create the new tab in. Defaults to the current window.

callbackOptional

function. The function is passed the following arguments:

tab

tabs.Tab. Details about the created tab. Will contain the ID of the new tab.

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Compatibility notes

Edge

• 'selected', 'pinned', or 'openerTabId' are not supported.

Firefox

• 'selected' is deprecated and not supported. Use 'active' instead.

Examples

The simplest way to call this function. Opens a new tab in the current window, at the highest index position, set to the new tab page:

chrome.tabs.create({});

Open "https://example.org" in a new tab:

chrome.tabs.create({url:"https://example.org"});

Open "https://example.org" in a new tab, and get the new tab's ID:

function onCreated(tabInfo) {
  console.log(tabInfo.id);
}

chrome.tabs.create({url:"https://example.org"}, onCreated);

Example add-ons

• open-my-page-button

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