Sets the browser action's title. The title is displayed in a tooltip over the browser action's icon. You can pass a tabId
in or a windowId
as an optional parameter — if you do this then the title is changed only for the given tab or the given window. Tabs or windows without a specific title will inherit the global title text, which defaults to the default_title
or name
specified in the manifest.
browser.browserAction.setTitle( details // object )
details
object
. The new title and optionally the ID of the tab or window to target. title
string
or null
. The string the browser action should display when moused over.
If title
is an empty string, the used title will be the extension name, but browserAction.getTitle
will still provide the empty string.
If title
is null
:
tabId
is specified, and the tab has a tab-specific title set, then the tab will inherit the title from the window to which it belongs.windowId
is specified, and the window has a window-specific title set, then the window will inherit the global title.tabId
Optional
integer
. Sets the title only for the given tab.
windowId
Optional
integer
. Sets the title for the given window.
windowId
and tabId
are both supplied, the function fails and the title is not set.windowId
and tabId
are both omitted, the global title is set.Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
setTitle |
Yes |
15 |
45
45-58
Tab-specific titles are not cleared when a new page is loaded.
|
? |
Yes |
14 |
? |
? |
55
55-58
Tab-specific titles are not cleared when a new page is loaded.
|
? |
? |
? |
null |
No |
No |
59 |
? |
No |
14 |
? |
? |
79 |
? |
? |
? |
This code switches the title between "this" and "that" each time the user clicks the browser action:
function toggleTitle(title) { if (title == "this") { browser.browserAction.setTitle({title: "that"}); } else { browser.browserAction.setTitle({title: "this"}); } } browser.browserAction.onClicked.addListener(() => { var gettingTitle = browser.browserAction.getTitle({}); gettingTitle.then(toggleTitle); });
Note: This API is based on Chromium's chrome.browserAction
API. This documentation is derived from browser_action.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/browserAction/setTitle