browserAction.getTitle()
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
.
Syntax
let gettingTitle = browser.browserAction.getTitle(
details
)
Parameters
-
details
-
An object with the following properties:
tabId
Optional
-
integer
. Specify the tab to get the title from.
windowId
Optional
-
integer
. Specify the window to get the title from.
- If
windowId
and tabId
are both supplied, the function fails and the promise it returns is rejected.
- If
windowId
and tabId
are both omitted, the global title is returned.
Return value
A Promise
that will be fulfilled with a string containing the browser action's title.
Browser compatibility
|
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 |
? |
15The API exists, but the title not visible in the UI.
|
? |
details_windowId_parameter |
No |
No |
62 |
? |
No |
No |
? |
? |
No |
? |
No |
? |
Examples
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(() => {
let gettingTitle = browser.browserAction.getTitle({});
gettingTitle.then(toggleTitle);
});