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
.
var updating = browser.tabs.update( tabId, // optional integer updateProperties // object )
tabId
Optional
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.active
Optional
boolean
. Whether the tab should become active. Does not affect whether the window is focused (see windows.update
). If true
, non-active highlighted tabs will stop being highlighted. If false
, does nothing.autoDiscardable
Optional
boolean
. Whether the tab should be discarded automatically by the browser when resources are low.highlighted
Optional
boolean
. Adds or removes the tab from the current selection. If true
and the tab is not highlighted, it will become active by default.
If you only want to highlight the tab without activating it, Firefox accepts setting highlighted
to true
and active
to false
. Other browsers may activate the tab even in this case.
loadReplace
Optional
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.
muted
Optional
boolean
. Whether the tab should be muted.openerTabId
Optional
integer
. The ID of the tab that opened this tab. If specified, the opener tab must be in the same window as this tab.pinned
Optional
boolean
. Whether the tab should be pinned.selected
Optional
boolean
. Whether the tab should be selected. This property has been replaced by active
and highlighted
.successorTabId
Optional
integer
. The id of the ID of the tab's successor.url
Optional
string
. A URL to navigate the tab to. runtime.lastError
being set to an error message:about:config
, about:addons
, about:debugging
, about:newtab
). Non-privileged URLs (e.g., about:blank
) are allowed.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 matching host permissions or 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.
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);
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
update |
Yes |
14 |
45 |
? |
Yes |
14 |
? |
? |
54 |
? |
? |
? |
Note: 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.
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/tabs/update