sidebarAction.getTitle()
Gets the sidebar's title.
Just as you can set the title on a per-tab basis using sidebarAction.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
js
let gettingTitle = browser.sidebarAction.getTitle(
details // object
)
Parameters
details
-
object
. An object with the following properties:tabId
Optional-
integer
. Get the title for the sidebar specific to the given tab. windowId
Optional-
integer
. Get the title for the sidebar specific to the given window.
- 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 sidebar's title.
Browser compatibility
BCD tables only load in the browser
Examples
This code switches the title between "this" and "that" each time the user clicks the browser action
js
function toggleTitle(title) {
if (title === "this") {
browser.sidebarAction.setTitle({title: "that"});
} else {
browser.sidebarAction.setTitle({title: "this"});
}
}
browser.browserAction.onClicked.addListener(() => {
let gettingTitle = browser.sidebarAction.getTitle({});
gettingTitle.then(toggleTitle);
});
Note: This API is based on Opera's chrome.sidebarAction
API.