sidebar_action

类型 对象
必填 否
清单版本 2 或更高版本
示例
json
"sidebar_action": {
  "default_icon": {
    "16": "button/geo-16.png",
    "32": "button/geo-32.png"
  },
  "default_title": "My sidebar",
  "default_panel": "sidebar/sidebar.html",
  "open_at_install":true
}

一个 侧边栏 是一个显示在浏览器窗口左侧、网页旁边的窗格。浏览器提供了一个用户界面，使用户能够查看当前可用的侧边栏并选择要显示的侧边栏。

sidebar_action 键允许您定义侧边栏的默认属性。您可以使用 sidebarAction API 在运行时更改这些属性。

语法

sidebar_action 键是一个对象，可以包含下面列出的任何属性。唯一必填属性是 default_panel。

名称 类型 描述
browser_style
可选
在清单 V3 中。		 布尔值

可选，默认为

  • 在清单 V2 中和 Firefox 115 之前的清单 V3 中为 true。
  • 从 Firefox 115 开始，在清单 V3 中为 false。

不要将 browser_style 设置为 true：从 Firefox 118 开始，它在清单 V3 中不受支持。请参阅 清单 V3 中 browser_style 的迁移。

在 Firefox 中，样式表可以在 chrome://browser/content/extension.css 或 macOS 上的 chrome://browser/content/extension-mac.css 中看到。设置尺寸时，请注意此样式表设置了 box-sizing: border-box（请参阅 box-sizing）。
default_icon
可选		 对象 或 字符串

使用此属性指定侧边栏的一个或多个图标。该图标显示在浏览器用于打开和关闭侧边栏的用户界面中。

图标指定为相对于 manifest.json 文件本身的 URL。

您可以通过在此处提供字符串来指定单个图标文件

json
"default_icon": "path/to/geo.svg"

要指定不同大小的多个图标，请在此处指定一个对象。每个属性的名称是以像素为单位的图标高度，并且必须可转换为整数。该值为 URL。例如

json
    "default_icon": {
      "16": "path/to/geo-16.png",
      "32": "path/to/geo-32.png"
    }

有关此方面的更多指导，请参阅 选择图标大小。

此属性是可选的：如果省略，侧边栏将不会获得图标。
default_panel 字符串

指定侧边栏内容的 HTML 文件的路径。

HTML 文件可以使用 <link> 和 <script> 元素包含 CSS 和 JavaScript 文件，就像普通的网页一样。

与普通网页不同，在面板中运行的 JavaScript 可以访问所有 WebExtension API（当然，前提是扩展具有相应的 权限）。

此属性是必填的。

这是一个 可本地化的属性。
default_title
可选		 字符串

侧边栏的标题。这用于浏览器 UI 中列出和打开侧边栏，并在侧边栏打开时显示在侧边栏顶部。

此属性是可选的：如果省略，侧边栏的标题将是扩展的 名称。

这是一个 可本地化的属性。
open_at_install
可选		 布尔值 可选，默认为 true。确定是否应在安装时打开侧边栏。默认行为是在安装完成后打开侧边栏。

示例

json
"sidebar_action": {
  "default_icon": "sidebar.svg",
  "default_title": "My sidebar!",
  "default_panel": "sidebar.html"
}

有关使用侧边栏的扩展的简单示例，请参阅 annotate-page。

浏览器兼容性

BCD 表仅在浏览器中加载

另请参阅