1. Mozilla
  2. 附加组件
  3. 浏览器扩展
  4. manifest.json
  5. sidebar_action

sidebar_action

类型 Object
必填 否
Manifest 版本 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
可选
在 Manifest V3 中。		 Boolean

可选，默认为

  • Manifest V2 和 Firefox 115 之前的 Manifest V3 中为 true。
  • Firefox 115 及更高版本的 Manifest V3 中为 false。

请勿将 browser_style 设置为 true：从 Firefox 118 开始，Manifest V3 不支持它。请参阅browser_style 的 Manifest V3 迁移。

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

使用此项为侧边栏指定一个或多个图标。该图标显示在浏览器 UI 中，用于打开和关闭侧边栏。

图标指定为相对于 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 String

指向一个 HTML 文件的路径，该文件指定侧边栏的内容。

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

与普通网页不同，在面板中运行的 JavaScript 可以访问所有WebExtension API（当然，这取决于扩展是否具有适当的权限）。

此属性是必需的。

这是一个 可本地化属性。
default_title
可选		 String

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

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

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

示例

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

要查看使用侧边栏的扩展示例，请参阅annotate-page。

浏览器兼容性

另见

帮助改进 MDN

了解如何贡献

此页面最后修改于 ，由 MDN 贡献者。

在 GitHub 上查看此页面 • 报告此内容的问题
© . Content available under a Creative Commons license.