chrome.action

说明

使用 chrome.action API 控制 Google Chrome 工具栏中的扩展程序图标。

操作图标显示在浏览器工具栏中的 Omnibox 旁边。安装后，这些扩展程序会显示在扩展程序菜单（拼图块图标）中。用户可以将您的扩展程序图标固定到工具栏。

可用性

Chrome 88 及更高版本 MV3 及更高版本

清单

必须在清单中声明以下键才能使用此 API。

"action"

如需使用 chrome.action API，请指定 3 的 "manifest_version"，并在清单文件中添加 "action" 键。

{
  "name": "Action Extension",
  ...
  "action": {
    "default_icon": {              // optional
      "16": "images/icon16.png",   // optional
      "24": "images/icon24.png",   // optional
      "32": "images/icon32.png"    // optional
    },
    "default_title": "Click Me",   // optional, shown in tooltip
    "default_popup": "popup.html"  // optional
  },
  ...
}

"action" 键（及其子项）是可选的。如果未包含该图标，您的扩展程序仍会显示在工具栏中，以便用户访问扩展程序的菜单。因此，我们建议您始终至少添加 "action" 和 "default_icon" 键。

概念和用法

界面的各个部分

图标

该图标是扩展程序工具栏上的主图片，由清单的 "action" 键中的 "default_icon" 键设置。图标的宽度和高度必须为 16 个设备无关像素 (DIP)。

"default_icon" 键是一个将尺寸与图片路径对应的字典。Chrome 使用这些图标来选择要使用的图片缩放比例。如果未找到完全匹配的字体，Chrome 会选择最接近的字体并将其缩放为适合图片的大小，这可能会影响图片质量。

由于采用不太常见的缩放比例（例如 1.5 倍或 1.2 倍）的设备越来越多，因此我们建议您为图标提供多种尺寸。这也有助于使您的扩展程序适应未来可能发生的图标显示大小变化。不过，如果只提供单个尺寸，"default_icon" 键也可以设置为包含单个图标路径的字符串，而不是字典。

您还可以通过指定其他图片路径或使用 HTML 画布元素提供动态生成的图标，或者使用 屏幕外画布 API（如果从扩展程序服务 worker 进行设置），调用 action.setIcon() 以程序化方式设置扩展程序的图标。

const canvas = new OffscreenCanvas(16, 16);
const context = canvas.getContext('2d');
context.clearRect(0, 0, 16, 16);
context.fillStyle = '#00FF00';  // Green
context.fillRect(0, 0, 16, 16);
const imageData = context.getImageData(0, 0, 16, 16);
chrome.action.setIcon({imageData: imageData}, () => { /* ... */ });

对于已打包的扩展程序（通过 .crx 文件安装），图片可以采用 Blink 渲染引擎可以显示的大多数格式，包括 PNG、JPEG、BMP、ICO 等。不支持 SVG。 未解压缩的扩展程序必须使用 PNG 图片。

提示（标题）

当用户将鼠标指针悬停在工具栏中的扩展程序图标上时，系统会显示提示或标题。当按钮获得焦点时，屏幕阅读器读出的无障碍文本中也会包含此属性。

默认提示是使用 manifest.json 中 "action" 键的 "default_title" 字段设置的。您还可以通过调用 action.setTitle() 以编程方式进行设置。

徽章

操作可以选择显示“标记”，即在图标上叠加一些文字。这样，您就可以更新操作，以显示有关扩展程序状态的少量信息，例如计数器。徽章包含文本组件和背景颜色。由于空间有限，我们建议徽章文本使用不超过 4 个字符。

如需创建徽章，请调用 action.setBadgeBackgroundColor() 和 action.setBadgeText() 以程序化方式进行设置。清单中没有默认徽章设置。徽章颜色值可以是四个介于 0 到 255 之间的整数的数组，这些整数构成了徽章的 RGBA 颜色，也可以是包含 CSS 颜色值的字符串。

chrome.action.setBadgeBackgroundColor(
  {color: [0, 255, 0, 0]},  // Green
  () => { /* ... */ },
);

chrome.action.setBadgeBackgroundColor(
  {color: '#00FF00'},  // Also green
  () => { /* ... */ },
);

chrome.action.setBadgeBackgroundColor(
  {color: 'green'},  // Also, also green
  () => { /* ... */ },
);

当用户点击工具栏中的扩展程序操作按钮时，系统会显示操作的弹出式窗口。该弹出式窗口可以包含您喜欢的任何 HTML 内容，并且会自动调整大小以适应其内容。弹出式窗口的尺寸必须介于 25x25 像素到 800x600 像素之间。

该弹出式窗口最初由 manifest.json 文件中 "action" 键中的 "default_popup" 属性设置。如果存在，此属性应指向扩展程序目录中的相对路径。您还可以使用 action.setPopup() 方法动态更新此值，以指向其他相对路径。

使用场景

每个标签页的状态

每个标签页的扩展程序操作可以具有不同的状态。如需为单个标签页设置值，请在 action API 的设置方法中使用 tabId 属性。例如，如需为特定标签页设置标记文本，请执行以下操作：

function getTabId() { /* ... */}
function getTabBadge() { /* ... */}

chrome.action.setBadgeText(
  {
    text: getTabBadge(tabId),
    tabId: getTabId(),
  },
  () => { ... }
);

如果省略 tabId 属性，系统会将该设置视为全局设置。标签页专用设置优先于全局设置。

已启用状态

默认情况下，每个标签页上的工具栏操作均处于启用（可点击）状态。您可以通过在清单的 action 键中设置 default_state 属性来更改此默认值。如果 default_state 设置为 "disabled"，则操作默认处于停用状态，必须通过程序化方式启用才能点击。如果 default_state 设置为 "enabled"（默认值），则操作默认处于启用状态且可点击。

您可以使用 action.enable() 和 action.disable() 方法以编程方式控制状态。这只会影响是否向您的扩展程序发送弹出式窗口（如果有）或 action.onClicked 事件；不会影响该操作在工具栏中的显示。

示例

以下示例展示了在扩展程序中使用操作的一些常见方式。如需试用此 API，请从 chrome-extension-samples 代码库安装 Action API 示例。

显示弹出式窗口

通常，当用户点击扩展程序的操作时，扩展程序会显示一个弹出式窗口。如需在您自己的扩展程序中实现此功能，请在 manifest.json 中声明该弹出式窗口，并指定 Chrome 应在该弹出式窗口中显示的内容。

// manifest.json
{
  "name": "Action popup demo",
  "version": "1.0",
  "manifest_version": 3,
  "action": {
    "default_title": "Click to view a popup",
    "default_popup": "popup.html"
  }
}

<!-- popup.html -->
<!DOCTYPE html>
<html>
<head>
  <style>
    html {
      min-height: 5em;
      min-width: 10em;
      background: salmon;
    }
  </style>
</head>
<body>
  <p>Hello, world!</p>
</body>
</html>

在点击时注入内容脚本

扩展程序的常见模式是使用扩展程序的操作来公开其主要功能。以下示例演示了此模式。当用户点击该操作时，扩展程序会将内容脚本注入当前网页。然后，内容脚本会显示一条提醒，以验证一切是否按预期运行。

// manifest.json
{
  "name": "Action script injection demo",
  "version": "1.0",
  "manifest_version": 3,
  "action": {
    "default_title": "Click to show an alert"
  },
  "permissions": ["activeTab", "scripting"],
  "background": {
    "service_worker": "background.js"
  }
}

// background.js
chrome.action.onClicked.addListener((tab) => {
  chrome.scripting.executeScript({
    target: {tabId: tab.id},
    files: ['content.js']
  });
});

// content.js
alert('Hello, world!');

使用 declarativeContent 模拟操作

此示例展示了扩展程序的后台逻辑如何（a）默认停用操作，以及（b）使用 declarativeContent 在特定网站上启用操作。

// service-worker.js

// Wrap in an onInstalled callback to avoid unnecessary work
// every time the service worker is run
chrome.runtime.onInstalled.addListener(() => {
  // Page actions are disabled by default and enabled on select tabs
  chrome.action.disable();

  // Clear all rules to ensure only our expected rules are set
  chrome.declarativeContent.onPageChanged.removeRules(undefined, () => {
    // Declare a rule to enable the action on example.com pages
    let exampleRule = {
      conditions: [
        new chrome.declarativeContent.PageStateMatcher({
          pageUrl: {hostSuffix: '.example.com'},
        })
      ],
      actions: [new chrome.declarativeContent.ShowAction()],
    };

    // Finally, apply our new array of rules
    let rules = [exampleRule];
    chrome.declarativeContent.onPageChanged.addRules(rules);
  });
});

类型

OpenPopupOptions

Chrome 99 及更高版本

属性

  • windowId

    number 可选

    用于打开操作弹出式窗口的窗口的 ID。如果未指定，则默认为当前处于活动状态的窗口。

TabDetails

属性

  • tabId

    number 可选

    要查询状态的标签页的 ID。如果未指定任何标签页，则系统会返回非标签页专用状态。

UserSettings

Chrome 91 及更高版本

与扩展程序操作相关的用户指定设置集合。

属性

  • isOnToolbar

    布尔值

    扩展程序的操作图标是否显示在浏览器窗口的顶级工具栏中（即扩展程序是否已被用户“固定”）。

UserSettingsChange

Chrome 130 及更高版本

属性

  • isOnToolbar

    布尔值（可选）

    扩展程序的操作图标是否显示在浏览器窗口的顶级工具栏中（即扩展程序是否已被用户“固定”）。

方法

disable()

prometido 
chrome.action.disable(
  tabId?: number,
  callback?: function,
)

停用标签页的操作。

参数

  • tabId

    编号（可选）

    您要修改操作的标签页的 ID。

  • callback

    函数（可选）

    callback 参数如下所示： 

    () => void

返回

  • Promise<void>

    清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。

enable()

prometido 
chrome.action.enable(
  tabId?: number,
  callback?: function,
)

为标签页启用操作。默认情况下，操作处于启用状态。

参数

  • tabId

    编号（可选）

    您要修改操作的标签页的 ID。

  • callback

    函数（可选）

    callback 参数如下所示： 

    () => void

返回

  • Promise<void>

    清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。

getBadgeBackgroundColor()

prometido 
chrome.action.getBadgeBackgroundColor(
  details: TabDetails,
  callback?: function,
)

获取操作的背景颜色。

参数

返回

  • 清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。

getBadgeText()

prometido 
chrome.action.getBadgeText(
  details: TabDetails,
  callback?: function,
)

获取操作的徽章文本。如果未指定任何标签页，系统会返回非标签页专用标记文本。如果启用了 displayActionCountAsBadgeText，系统会返回占位符文本，除非存在 declarativeNetRequestFeedback 权限或已提供标签页专用标记文本。

参数

  • 详细信息

    TabDetails

  • callback

    函数（可选）

    callback 参数如下所示： 

    (result: string) => void

    • 结果

      字符串

返回

  • Promise<string>

    清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。

getBadgeTextColor()

Promise Chrome 110 及更高版本 
chrome.action.getBadgeTextColor(
  details: TabDetails,
  callback?: function,
)

获取操作的文字颜色。

参数

返回

  • 清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。

getPopup()

prometido 
chrome.action.getPopup(
  details: TabDetails,
  callback?: function,
)

获取设置为此操作的弹出式窗口的 HTML 文档。

参数

  • 详细信息

    TabDetails

  • callback

    函数（可选）

    callback 参数如下所示： 

    (result: string) => void

    • 结果

      字符串

返回

  • Promise<string>

    清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。

getTitle()

prometido 
chrome.action.getTitle(
  details: TabDetails,
  callback?: function,
)

获取操作的标题。

参数

  • 详细信息

    TabDetails

  • callback

    函数（可选）

    callback 参数如下所示： 

    (result: string) => void

    • 结果

      字符串

返回

  • Promise<string>

    清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。

getUserSettings()

Promise Chrome 91 及更高版本 
chrome.action.getUserSettings(
  callback?: function,
)

返回与扩展程序操作相关的用户指定设置。

参数

  • callback

    函数（可选）

    callback 参数如下所示： 

    (userSettings: UserSettings) => void

返回

  • Promise<UserSettings>

    清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。

isEnabled()

Promise Chrome 110 及更高版本 
chrome.action.isEnabled(
  tabId?: number,
  callback?: function,
)

指示是否为标签页启用了扩展程序操作（如果未提供 tabId，则表示在全球范围内启用）。仅使用 declarativeContent 启用的操作始终返回 false。

参数

  • tabId

    number 可选

    您要查看其启用状态的标签页的 ID。

  • callback

    函数（可选）

    callback 参数如下所示： 

    (isEnabled: boolean) => void

    • isEnabled

      布尔值

      如果扩展程序操作处于启用状态，则为“true”。

返回

  • Promise<boolean>

    清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。

openPopup()

Promise Chrome 127 及更高版本 
chrome.action.openPopup(
  options?: OpenPopupOptions,
  callback?: function,
)

打开扩展程序的弹出式窗口。在 Chrome 118 和 Chrome 126 之间，此 API 仅适用于根据政策安装的扩展程序。

参数

  • 选项

    OpenPopupOptions（可选）

    指定用于打开弹出式窗口的选项。

  • callback

    函数（可选）

    callback 参数如下所示： 

    () => void

返回

  • Promise<void>

    清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。

setBadgeBackgroundColor()

prometido 
chrome.action.setBadgeBackgroundColor(
  details: object,
  callback?: function,
)

设置标志的背景颜色。

参数

  • 详细信息

    对象

    • 颜色

      字符串 | ColorArray

      一个由四个整数组成的数组，这些整数在 [0,255] 范围内，构成徽章的 RGBA 颜色。例如，不透明红色为 [255, 0, 0, 255]。也可以是包含 CSS 值的字符串，不透明的红色为 #FF0000 或 #F00。

    • tabId

      number 可选

      将更改限制为仅在选择特定标签页时生效。关闭标签页时自动重置。

  • callback

    函数（可选）

    callback 参数如下所示： 

    () => void

返回

  • Promise<void>

    清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。

setBadgeText()

prometido 
chrome.action.setBadgeText(
  details: object,
  callback?: function,
)

设置操作的标志文本。徽章会显示在图标上方。

参数

  • 详细信息

    对象

    • tabId

      number 可选

      将更改限制为仅在选择特定标签页时生效。关闭标签页时自动重置。

    • text

      字符串（选填）

      可以传递任意数量的字符，但该空间中最多只能容纳 4 个字符。如果传递空字符串 ('')，系统会清除标记文本。如果指定了 tabId 且 text 为 null，则系统会清除指定标签页的文本，并默认使用全局标记文本。

  • callback

    函数（可选）

    callback 参数如下所示： 

    () => void

返回

  • Promise<void>

    清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。

setBadgeTextColor()

Promise Chrome 110 及更高版本 
chrome.action.setBadgeTextColor(
  details: object,
  callback?: function,
)

设置标志的文字颜色。

参数

  • 详细信息

    对象

    • 颜色

      字符串 | ColorArray

      一个由四个整数组成的数组，这些整数在 [0,255] 范围内，构成徽章的 RGBA 颜色。例如，不透明红色为 [255, 0, 0, 255]。也可以是包含 CSS 值的字符串，不透明的红色为 #FF0000 或 #F00。如果不设置此值，系统会自动选择与徽章背景颜色形成对比的颜色，以便文本清晰可见。系统不会设置 Alpha 值等于 0 的颜色，并会返回错误。

    • tabId

      number 可选

      将更改限制为仅在选择特定标签页时生效。关闭标签页时自动重置。

  • callback

    函数（可选）

    callback 参数如下所示： 

    () => void

返回

  • Promise<void>

    清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。

setIcon()

prometido 
chrome.action.setIcon(
  details: object,
  callback?: function,
)

设置操作的图标。图标可以指定为图片文件的路径、画布元素中的像素数据，也可以指定为这两者的字典。必须指定 path 或 imageData 属性。

参数

  • 详细信息

    对象

    • imageData

      ImageData | 对象 可选

      表示要设置的图标的 ImageData 对象或字典 {size -> ImageData}。如果将图标指定为字典，系统会根据屏幕的像素密度选择要使用的实际图片。如果一个屏幕空间单元中可容纳的图片像素数等于 scale，则系统会选择大小为 scale * n 的图片，其中 n 是界面中图标的大小。必须至少指定一张图片。请注意，“details.imageData = foo”等同于“details.imageData = {'16': foo}”

    • 路径

      字符串 | 对象（可选）

      相对图片路径或指向要设置的图标的字典 {size -> relative image path}。如果将图标指定为字典，系统会根据屏幕的像素密度选择要使用的实际图片。如果一个屏幕空间单元中可容纳的图片像素数等于 scale，则系统会选择大小为 scale * n 的图片，其中 n 是界面中图标的大小。必须至少指定一张图片。请注意，“details.path = foo”等同于“details.path = {'16': foo}”

    • tabId

      number 可选

      将更改限制为仅在选择特定标签页时生效。关闭标签页时自动重置。

  • callback

    函数（可选）

    callback 参数如下所示： 

    () => void

返回

  • Promise<void>

    Chrome 96 及更高版本

    清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。

setPopup()

prometido 
chrome.action.setPopup(
  details: object,
  callback?: function,
)

设置在用户点击操作的图标时以弹出式窗口打开 HTML 文档。

参数

  • 详细信息

    对象

    • 弹出

      字符串

      要在弹出式窗口中显示的 HTML 文件的相对路径。如果设置为空字符串 ('')，则不会显示任何弹出式窗口。

    • tabId

      number 可选

      将更改限制为仅在选择特定标签页时生效。关闭标签页时自动重置。

  • callback

    函数（可选）

    callback 参数如下所示： 

    () => void

返回

  • Promise<void>

    清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。

setTitle()

prometido 
chrome.action.setTitle(
  details: object,
  callback?: function,
)

设置操作的标题。此信息会显示在提示中。

参数

  • 详细信息

    对象

    • tabId

      number 可选

      将更改限制为仅在选择特定标签页时生效。关闭标签页时自动重置。

    • title

      字符串

      操作在鼠标悬停时应显示的字符串。

  • callback

    函数（可选）

    callback 参数如下所示： 

    () => void

返回

  • Promise<void>

    清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。

事件

onClicked

chrome.action.onClicked.addListener(
  callback: function,
)

在用户点击操作图标时触发。如果操作包含弹出式窗口，此事件将不会触发。

参数

  • callback

    函数

    callback 参数如下所示： 

    (tab: tabs.Tab) => void

onUserSettingsChanged

Chrome 130 及更高版本 
chrome.action.onUserSettingsChanged.addListener(
  callback: function,
)

当与扩展程序操作相关的用户指定设置发生变化时触发。

参数