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.
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.
browser.sidebarAction.setTitle(
details
// object
)
details
对象
. An object with the following properties:
title
string
or
null
. The sidebar's new title.
若
title
is an empty string, the used title will be the extension name, but
sidebarAction.getTitle
will still provide the empty string.
若
title
is
null
, then a previously set title will be removed, so that:
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.
windowId
is specified, and the window has a window-specific title set, then the window will inherit the global title.
tabId
可选
integer
. Sets the title only for the given tab.
windowId
可选
integer
. Sets the title only for the given window.
windowId
and
tabId
are both supplied, the function fails and the title is not set.
windowId
and
tabId
are both omitted, the global title is set.
BCD tables only load in the browser
This code changes the title for the sidebar when the user clicks a browser action, but only for the current tab:
var title = "A different title";
function setTitleForTab(tab) {
browser.sidebarAction.setTitle({title, tabId: tab.id});
}
browser.browserAction.onClicked.addListener(setTitleForTab);
注意:
This API is based on Opera's
chrome.sidebarAction
API。
最后修改: , 由 MDN 贡献者