tabs.update()

Modifies the properties of a tab. Properties that are not specified in updateProperties are not modified.

Syntax

browser.tabs.update(
  tabId,              // optional integer
  updateProperties,   // object
  function(tab) {...} // optional function
)

Parameters

tabIdOptional

integer. Defaults to the selected tab of the current window.

updateProperties

object. The set of properties to update for this tab. To learn more about these properties, see the tabs.Tab documentation.
 

urlOptional

string. A URL to navigate the tab to. 

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 (about:home, about:newtab, about:blank) are allowed.

activeOptional

boolean. Whether the tab should be active. Does not affect whether the window is focused (see windows.update).

highlightedOptional

boolean. Adds or removes the tab from the current selection.

selectedOptional

boolean. Whether the tab should be selected.

Deprecated.

pinnedOptional

boolean. Whether the tab should be pinned.

mutedOptional

boolean. Whether the tab should be muted.

openerTabIdOptional

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

callbackOptional

function. The function is passed the following arguments:

tabOptional

tabs.Tab. Details about the updated tab. The tabs.Tab object doesn't contain url, title and favIconUrl unless the "tabs" permission has been requested.

Browser compatibility

1. It's not possible to update the "highlighted" and "selected" properties.

Examples

Example add-ons

• chill-out

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