sidebarAction.setTitle()
设置侧边栏的标题。标题会在浏览器列出可用侧边栏的任何位置显示。例如,Firefox 会在“查看 > 侧边栏”菜单中显示它。当侧边栏打开时,它也会在侧边栏顶部显示。
标题类型
您的扩展应该在 sidebar_action 清单键中为侧边栏指定标题。这被称为“清单标题”。如果您没有指定清单标题,它将默认使用扩展名称。
如果您使用 setTitle()
设置新标题,并且包含 tabId
选项,那么标题仅针对给定选项卡设置。此标题被称为“选项卡特定标题”。
如果您使用 setTitle()
设置新标题,并且包含 windowId
选项,那么标题仅针对给定窗口设置。此标题被称为“窗口特定标题”,并且会在该窗口中所有未设置选项卡特定标题的选项卡中显示。
如果您使用 setTitle()
设置新标题,并且省略了 tabId
和 windowId
选项,那么这会设置“全局标题”。全局标题随后会出现在所有未设置选项卡特定标题且其窗口未设置窗口特定标题的选项卡中。
语法
js
browser.sidebarAction.setTitle(
details // object
)
参数
details
-
object
。具有以下属性的对象title
-
string
或null
。侧边栏的新标题。如果
title
是空字符串,则使用的标题将是扩展名称,但sidebarAction.getTitle
仍然会提供空字符串。如果
title
是null
,则会删除之前设置的标题,因此- 如果指定了
tabId
,并且选项卡设置了选项卡特定标题,那么选项卡将从其所属的窗口继承标题。 - 如果指定了
windowId
,并且窗口设置了窗口特定标题,那么窗口将从全局标题继承。 - 否则,全局标题将重置为清单标题。
- 如果指定了
tabId
可选-
integer
。仅为给定选项卡设置标题。 windowId
可选-
integer
。仅为给定窗口设置标题。
- 如果同时提供了
windowId
和tabId
,则函数将失败,并且标题不会设置。 - 如果同时省略了
windowId
和tabId
,则会设置全局标题。
浏览器兼容性
BCD 表仅在浏览器中加载
示例
这段代码在用户点击浏览器操作时更改侧边栏的标题,但仅针对当前选项卡
js
let title = "A different title";
function setTitleForTab(tab) {
browser.sidebarAction.setTitle({ title, tabId: tab.id });
}
browser.browserAction.onClicked.addListener(setTitleForTab);
注意: 此 API 基于 Opera 的 chrome.sidebarAction
API。