Add-ons

tabs.update()

Navigate the tab to a new URL, or modify other properties of the tab.

To use this function, pass the ID of the tab to update, and an updateProperties object containing the properties you want to update. Properties that are not specified in updateProperties are not modified.

This is an asynchronous function that returns a Promise.

Syntax

var updating = browser.tabs.update(
  tabId,              // optional integer
  updateProperties    // object
)

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.
activeOptional
boolean. Whether the tab should be active. Does not affect whether the window is focused (see windows.update).
autoDiscardableOptional
boolean. Whether the tab should be discarded automatically by the browser when resources are low.
highlightedOptional
boolean. Adds or removes the tab from the current selection.
loadReplaceOptional

boolean. Whether the new URL should replace the old URL in the tab's navigation history, as accessed via the "Back" button.

For example, suppose the user creates a new tab using Ctrl+T. By default, in Firefox, this would load "about:newtab". If your extension then updates this page using tabs.update, without loadReplace, the "Back" button will be enabled and will take the user back to "about:newtab". If the extension sets loadReplace, then the "Back" button will be disabled and it will be just as if the URL supplied by the extension was the first page visited in that tab.

Note though that the original URL will still appear in the browser's global history.

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.
pinnedOptional
boolean. Whether the tab should be pinned.
selected Optional
boolean. Whether the tab should be selected.
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
  • file: URLs (i.e., files on the filesystem. However, to use a file packaged inside the extension, see below)
  • privileged about: URLs (for example, about:config, about:addons, about:debugging, about:newtab) . Non-privileged URLs (about:home, about:blank) are allowed.
To load a page that's packaged with your extension, specify an absolute URL starting at the extension's manifest.json file. For example: '/path/to/my-page.html'. If you omit the leading '/', the URL is treated as a relative URL, and different browsers may construct different absolute URLs.

Return value

A Promise that will be fulfilled with a tabs.Tab object containing details about the updated tab. The tabs.Tab object doesn't contain url, title and favIconUrl unless the "tabs" permission has been requested. If the tab could not be found or some other error occurs, the promise will be rejected with an error message.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic support Yes Yes4554 Yes
updateProperties.active Yes Yes4554 Yes
updateProperties.autoDiscardable54 No No No41
updateProperties.highlighted Yes No No No Yes
updateProperties.loadReplace No No57 No No
updateProperties.muted45 No455432
updateProperties.openerTabId18 No57 No15
updateProperties.pinned Yes No4554 Yes
updateProperties.selected Yes No No No Yes
updateProperties.url Yes Yes4554 Yes

Examples

Navigate the active tab in the current window to https://developer.mozilla.org:

function onUpdated(tab) {
  console.log(`Updated tab: ${tab.id}`);
}

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

var updating = browser.tabs.update({url: "https://developer.mozilla.org"});
updating.then(onUpdated, onError);

Activate the first tab in the current window, and navigate it to https://developer.mozilla.org:

function onUpdated(tab) {
  console.log(`Updated tab: ${tab.id}`);
}

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

function updateFirstTab(tabs) {
  var updating = browser.tabs.update(tabs[0].id, {
    active: true,
    url: "https://developer.mozilla.org"
  });
  updating.then(onUpdated, onError);
}

var querying = browser.tabs.query({currentWindow:true});
querying.then(updateFirstTab, onError);

Example extensions

Acknowledgements

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

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Contributors to this page: aswan, Makyen, wbamberg, snoack, yadutaf, Jeremie, jonathanKingston
 Last updated by: aswan,