sidebarAction.setTitle()
Sets the sidebar's title. The title is displayed anywhere the browser lists available sidebars. For example, Firefox will show it in the "View > Sidebar" menu. It's also shown at the top o the sidebar when the sidebar is open.
Types of title
Your extension should specify an title for the sidebar in the sidebar_action manifest key. This is called the "manifest title". If you don't specify the manifest title, it will default to the extension name.
If you set a new title using setTitle()
, and include the tabId
option, then the title is set only for the given tab. This title is called the "tab-specific title".
If you set a new title using setTitle()
, and include the windowId
option, then the title is set only for the given window. This title is called the "window-specific title", and will appear in all tabs of that window that do not have a tab-specific title set.
If you set a new title using setTitle()
, and omit both the tabId
and windowId
options, then this sets the "global title". The global title will then appear in all tabs that do not have a tab-specific title set and whose window does not have a window-specific title.
Syntax
browser.sidebarAction.setTitle(
details // object
)
Parameters
details
-
object
. An object with the following properties:title
-
string
ornull
. The sidebar's new title.If
title
is an empty string, the used title will be the extension name, butsidebarAction.getTitle
will still provide the empty string.If
title
isnull
, then a previously set title will be removed, so that:- If
tabId
is specified, and the tab has a tab-specific title set, then the tab will inherit the title from the window it belongs to. - If
windowId
is specified, and the window has a window-specific title set, then the window will inherit the global title. - Otherwise, the global title will be reset to the manifest title.
- If
tabId
Optional-
integer
. Sets the title only for the given tab. windowId
Optional-
integer
. Sets the title only for the given window.
- If
windowId
andtabId
are both supplied, the function fails and the title is not set. - If
windowId
andtabId
are both omitted, the global title is set.
Browser compatibility
BCD tables only load in the browser
Examples
This code changes the title for the sidebar when the user clicks a browser action, but only for the current tab:
let title = "A different title";
function setTitleForTab(tab) {
browser.sidebarAction.setTitle({title, tabId: tab.id});
}
browser.browserAction.onClicked.addListener(setTitleForTab);
Note: This API is based on Opera's chrome.sidebarAction
API.