page_action

类型 对象
必填
清单版本 2 或更高
示例
json
"page_action": {
  "default_icon": {
    "19": "button/geo-19.png",
    "38": "button/geo-38.png"
  },
  "default_title": "Whereami?",
  "default_popup": "popup/geo.html"
}

页面操作是扩展在浏览器 URL 栏中添加的图标。

扩展可以选择性地提供一个关联的弹出窗口,其内容使用 HTML、CSS 和 JavaScript 指定。

必须指定此键才能在扩展中包含页面操作。指定后,可以使用 pageAction API 以编程方式操作按钮。

如果提供弹出窗口,则当用户单击图标时将打开弹出窗口,并且在弹出窗口中运行的 JavaScript 可以处理用户与它的交互。如果不提供弹出窗口,则当用户单击图标时,将向扩展的 后台脚本 分派单击事件。

页面操作类似于浏览器操作,只是它们与特定的网页相关联,而不是与整个浏览器相关联。如果操作仅与某些页面相关,则应使用页面操作并仅在相关页面上显示它。如果操作与所有页面或浏览器本身相关,则使用浏览器操作。

虽然浏览器操作默认情况下会显示,但页面操作默认情况下是隐藏的。可以通过调用 pageAction.show() 并传递标签的 id 来为特定标签显示它们。还可以使用 show_matches 属性更改此默认行为。

语法

page_action 键是一个对象,可以具有以下三种属性,所有属性都是可选的

名称 类型 描述
浏览器样式
可选
已弃用 在清单 V3 中。
布尔值

可选。默认值为 false

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

在 Firefox 中,可以在 chrome://browser/content/extension.css 或 macOS 上的 chrome://browser/content/extension-mac.css 中查看样式表。

最新下载的 示例扩展 在其弹出窗口中使用 browser_style

默认图标 对象字符串

使用此属性指定操作的图标。

建议在此处提供两个图标(19×19 像素和 38×38 像素),并在名为 "19""38" 的对象中指定它们,如下所示

json
    "default_icon": {
      "19": "geo-19.png",
      "38": "geo-38.png"
    }

如果这样做,则浏览器将为屏幕的像素密度选择合适的图标大小。

可以在此处仅提供一个字符串

json
"default_icon": "geo.png"

如果这样做,则图标将被缩放以适合工具栏,并且可能出现模糊。

默认弹出窗口 字符串

包含弹出窗口规范的 HTML 文件的路径。

HTML 文件可以使用 <link><script> 元素包含 CSS 和 JavaScript 文件,就像普通网页一样。但是,不要使用带有嵌入式代码的 <script>,因为您将收到内容违规策略错误。相反,<script> 必须使用 src 属性加载单独的脚本文件。

与普通网页不同,在弹出窗口中运行的 JavaScript 可以访问所有 WebExtension API(当然,前提是扩展具有相应的 权限)。

这是一个 可本地化属性

默认标题 字符串

图标的工具提示,当用户将鼠标悬停在图标上时显示。

这是一个 可本地化属性

隐藏匹配项 Match Pattern 数组,不包括 <all_urls>

默认情况下,对 URL 与任何给定的 匹配模式 匹配的页面隐藏页面操作。

请注意,页面操作始终默认情况下是隐藏的,除非给定 show_matches。因此,仅当也给定 show_matches 时,才有意义地包含此属性,并且它将覆盖 show_matches 中的模式。

例如,考虑以下值

json
"page_action": {
  "show_matches": ["https://*.mozilla.org/*"],
  "hide_matches": ["https://mdn.org.cn/*"]
}

默认情况下,这将为 "mozilla.org" 域下的所有 HTTPS URL 显示页面操作,但 "developer.mozilla.org" 下的页面除外。

显示匹配项 Match Pattern 数组

默认情况下,对 URL 与任何给定的模式匹配的页面显示页面操作。

另请参阅 hide_matches

pinned 已弃用 布尔值

可选。默认值为 true

控制页面操作在用户安装扩展时是否默认情况下出现在位置栏中。自 Firefox 89 起,此属性不再受支持。

示例

json
"page_action": {
  "default_icon": {
    "19": "button/geo-19.png",
    "38": "button/geo-38.png"
  }
}

一个仅包含图标的页面操作,以两种不同的尺寸指定。扩展的后台脚本可以在用户单击图标时使用以下代码接收单击事件

js
browser.pageAction.onClicked.addListener(handleClick);
json
"page_action": {
  "default_icon": {
    "19": "button/geo-19.png",
    "38": "button/geo-38.png"
  },
  "default_title": "Whereami?",
  "default_popup": "popup/geo.html"
}

一个带有图标、标题和弹出窗口的页面操作。当用户单击图标时,将显示弹出窗口。

浏览器兼容性

BCD 表仅在浏览器中加载

另请参阅