sidebarAction.setTitle()

设置侧边栏的标题。标题会在浏览器列出可用侧边栏的地方显示。例如,Firefox 会在“查看 > 侧栏”菜单中显示这一标题。当侧边栏打开时,该标题还会显示在侧边栏的顶部。

标题类型

你的扩展应该在 sidebar_action 清单键中指定侧边栏的标题(这被称为“清单标题”)。如果你没有指定清单标题,则将默认使用扩展名作为标题。

如果你使用 setTitle() 设置新标题,并包含了 tabId 选项,那么标题仅为给定的标签页设置。这个标题称为“标签页特定标题”。

如果你使用 setTitle() 设置新标题,并包含了 windowId 选项,那么标题仅为给定的窗口设置。这个标题称为“窗口特定标题”,并将出现在该窗口的所有没有设置标签页特定标题的标签页中。

如果你使用 setTitle() 设置新标题,并省略了 tabIdwindowId 选项,那么这将设置“全局标题”。全局标题将出现在所有没有设置标签页特定标题的标签中,且其窗口没有设置窗口特定标题的标签页中。

语法

js
browser.sidebarAction.setTitle(
  details // 对象
)

参数

details

object,包含下述属性的对象:

title

stringnull,侧边栏的新标题。

如果 title 是空字符串,则使用扩展名作为标题,但 sidebarAction.getTitle 仍会提供空字符串。

如果 titlenull,那么之前设置的标题将会被移除,并且:

  • 如果指定了 tabId,并且该标签页设置了标签页特定的标题,则该标签页将继承其所属窗口的标题。
  • 如果指定了 windowId,并且该窗口设置了特定的窗口标题,则该窗口将继承全局标题。
  • 否则,全局标题将被重置为清单标题。
tabId 可选

integer。仅为指定的标签页设置标题。

windowId 可选

integer。仅为指定的窗口设置标题。

  • 如果同时提供了 windowIdtabId,函数将失败且标题不会被设置。
  • 如果同时省略 windowIdtabId,则设置全局标题。

浏览器兼容性

BCD tables only load in the browser

示例

下面代码在用户点击浏览器操作时更改侧边栏的标题(但仅对当前标签页更改):

js
let title = "一个不同的标题";

function setTitleForTab(tab) {
  browser.sidebarAction.setTitle({ title, tabId: tab.id });
}

browser.browserAction.onClicked.addListener(setTitleForTab);

备注: 此 API 是基于 Opera 的 chrome.sidebarAction API。