此页面由 Cloud Translation API 翻译。

chrome.declarativeContent

说明

使用 chrome.declarativeContent API 可根据网页内容执行操作，而无需拥有读取网页内容的权限。

权限

declarativeContent

概念和用法

借助声明式内容 API，您可以根据网页的网址或 CSS 选择器是否与网页上的元素匹配来启用扩展程序的操作，而无需添加主机权限或注入内容脚本。

使用 activeTab 权限可在用户点击扩展程序的操作后与网页互动。

规则

规则由条件和操作组成。如果满足其中任一条件，系统就会执行所有操作。相应操作分别为 setIcon() 和 showAction()。

只有当网页符合所列的所有条件时，PageStateMatcher 才会与该网页匹配。它可以匹配网页网址、CSS 复合选择器或网页的已添加书签状态。以下规则可在存在密码字段时，在 Google 网页上启用扩展程序的操作：

let rule1 = {
  conditions: [
    new chrome.declarativeContent.PageStateMatcher({
      pageUrl: { hostSuffix: '.google.com', schemes: ['https'] },
      css: ["input[type='password']"]
    })
  ],
  actions: [ new chrome.declarativeContent.ShowAction() ]
};

如需还针对包含视频的 Google 网站启用扩展程序的操作，您可以添加第二个条件，因为每个条件都足以触发所有指定的操作：

let rule2 = {
  conditions: [
    new chrome.declarativeContent.PageStateMatcher({
      pageUrl: { hostSuffix: '.google.com', schemes: ['https'] },
      css: ["input[type='password']"]
    }),
    new chrome.declarativeContent.PageStateMatcher({
      css: ["video"]
    })
  ],
  actions: [ new chrome.declarativeContent.ShowAction() ]
};

onPageChanged 事件用于测试是否有任何规则至少满足一个条件，并执行相应操作。规则会跨浏览会话保留；因此，在扩展程序安装期间，您应先使用 removeRules 清除之前安装的规则，然后使用 addRules 注册新规则。

chrome.runtime.onInstalled.addListener(function(details) {
  chrome.declarativeContent.onPageChanged.removeRules(undefined, function() {
    chrome.declarativeContent.onPageChanged.addRules([rule2]);
  });
});

获得 activeTab 权限后，您的扩展程序将不会显示任何权限警告，并且当用户点击扩展程序操作时，该操作只会在相关网页上运行。

网页网址匹配

当网址条件满足时，PageStateMatcher.pageurl 会匹配。最常见的条件是主机、路径或网址的串联，后跟“包含”“等于”“前缀”或“后缀”。下表包含一些示例：

条件	配对
`{ hostSuffix: 'google.com' }`	所有 Google 网址
`{ pathPrefix: '/docs/extensions'` }	扩展程序文档网址
`{ urlContains: 'developer.chrome.com'` }	所有 Chrome 开发者文档网址

所有条件都区分大小写。如需查看标准的完整列表，请参阅 UrlFilter。

CSS 匹配

PageStateMatcher.css 条件必须是复合选择器，这意味着您不能在选择器中添加空格或“>”等组合元件。这有助于 Chrome 更高效地匹配选择器。

复合选择器（确定）	复杂选择器（不正确）
`a`	`div p`
`iframe.special[src^='http']`	`p>span.highlight`
`ns\|*`	`p + ol`
`#abcd:checked`	`p::first-line`

CSS 条件仅与显示的元素匹配：如果与选择器匹配的元素为 display:none，或者其父元素之一为 display:none，则不会导致条件匹配。使用 visibility:hidden 设置样式、位于屏幕范围外或被其他元素隐藏的元素仍可使您的条件匹配。

已添加书签状态匹配

PageStateMatcher.isBookmarked 条件允许匹配用户个人资料中当前网址的已加入书签状态。如需使用此条件，必须在扩展程序manifest中声明“书签”权限。

类型

ImageDataType

请参阅 https://developer.mozilla.org/en-US/docs/Web/API/ImageData。

类型

ImageData

PageStateMatcher

根据各种条件匹配网页的状态。

属性

构造函数

void

constructor 函数如下所示：
```
(arg: PageStateMatcher) => {...}
```
- 参数
  
  PageStateMatcher
- 返回
  PageStateMatcher
css

string[] 可选

如果数组中的所有 CSS 选择器都与与页面主框架具有相同源的框架中的显示元素匹配，则匹配。此数组中的所有选择器都必须是复合选择器，以加快匹配速度。注意：列出数百个 CSS 选择器或列出每页匹配数百次的 CSS 选择器可能会导致网站运行缓慢。
isBookmarked

布尔值（可选）

Chrome 45 及更高版本

如果网页的已加入书签状态等于指定值，则匹配。需要书签权限。
pageUrl

UrlFilter（可选）

如果网页的顶级网址满足 UrlFilter 的条件，则匹配。

RequestContentScript

用于注入内容脚本的声明式事件操作。

警告：此操作仍处于实验阶段，Chrome 的稳定版不支持此操作。

属性

构造函数

void

constructor 函数如下所示：
```
(arg: RequestContentScript) => {...}
```
- 参数
  
  RequestContentScript
- 返回
  RequestContentScript
allFrames

布尔值（可选）

内容脚本是在匹配网页的所有框架中运行，还是仅在顶部框架中运行。默认值为 false。
css

string[] 可选

要作为内容脚本的一部分注入的 CSS 文件的名称。
js

string[] 可选

要作为内容脚本的一部分注入的 JavaScript 文件的名称。
matchAboutBlank

布尔值（可选）

是否在 about:blank 和 about:srcdoc 上插入内容脚本。默认值为 false。

SetIcon

声明式事件操作，用于在满足相应条件时为扩展程序的网页操作或浏览器操作设置 n 像素的方形图标。无需主机权限即可使用此操作，但扩展程序必须具有网页操作或浏览器操作。

必须指定 imageData 或 path 中的一个。这两者都是将多个像素映射到图片表示形式的字典。imageData 中的图片表示法是 ImageData 对象；例如，来自 canvas 元素，而 path 中的图片表示法是相对于扩展程序清单的图片文件路径。如果 scale 屏幕像素适合设备独立像素，则使用 scale * n 图标。如果缺少该比例，系统会将另一张图片调整为所需大小。

属性

构造函数

void

constructor 函数如下所示：
```
(arg: SetIcon) => {...}
```
- 参数
  
  SetIcon
- 返回
  SetIcon
imageData

ImageData | 对象可选

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