Gets the browser action's title.
Just as you can set the title on a per-tab basis using browserAction.setTitle()
, so you can retrieve a tab-specific title by passing the tab's ID into this function.
This is an asynchronous function that returns a Promise
.
var gettingTitle = browser.browserAction.getTitle( details // object )
details
object
.tabId
Optional
integer
. Specify the tab to get the title from.windowId
Optional
integer
. Specify the window to get the title from.windowId
and tabId
are both supplied, the function fails and the promise it returns is rejected.windowId
and tabId
are both omitted, the global title is returned.A Promise
that will be fulfilled with a string containing the browser action's title.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
getTitle |
Yes |
15 |
45 |
? |
Yes |
14 |
? |
? |
55 |
? |
? |
? |
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/getTitle