sidebarAction.setTitle()

设置侧边栏的标题。该标题会在浏览器列出可用侧边栏的任何地方显示。例如,Firefox 会在“视图 > 侧边栏”菜单中显示它。侧边栏打开时,标题也会显示在侧边栏顶部。

标题的类型

您的扩展应该在 sidebar_action manifest 键中为侧边栏指定一个标题。这被称为“manifest 标题”。如果您不指定 manifest 标题,它将默认为扩展名。

如果您使用 setTitle() 设置新标题,并包含 tabId 选项,则该标题仅为给定的标签页设置。这被称为“标签页特定标题”

如果您使用 setTitle() 设置新标题,并包含 windowId 选项,则该标题仅为给定的窗口设置。这被称为“窗口特定标题”,并且会出现在该窗口中所有未设置标签页特定标题的标签页上。

如果您使用 setTitle() 设置新标题,并省略 tabIdwindowId 选项,则会设置“全局标题”。全局标题将显示在所有未设置标签页特定标题且其窗口未设置窗口特定标题的标签页上。

语法

js
browser.sidebarAction.setTitle(
  details // object
)

参数

details

object。一个具有以下属性的对象。

title

stringnull。侧边栏的新标题。

如果 title 是一个空字符串,则使用的标题将是扩展名,但 sidebarAction.getTitle 仍会返回空字符串。

如果 titlenull,则会移除之前设置的标题,以便

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

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

windowId 可选

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

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

示例

此代码会在用户点击浏览器操作时更改侧边栏的标题,但仅针对当前标签页。

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。