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 // object
)
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
andtabId
are both supplied, the function fails and the promise it returns is rejected. - If
windowId
andtabId
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
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);
});
Note:
This API is based on Chromium's chrome.browserAction
API. This documentation is derived from browser_action.json
in the Chromium code.