Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: A1lo <[email protected]>
  • Loading branch information
PassionPenguin and yin1999 authored Dec 21, 2024
1 parent a3b14ec commit 03e4f5c
Showing 1 changed file with 16 additions and 16 deletions.
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
---
title: 使用 userScripts
title: 使用 userScript
slug: Mozilla/Add-ons/WebExtensions/API/userScripts/Working_with_userScripts
l10n:
sourceCommit: 0b956178ef19e8fc3981ed97dc6659d5a63f59a6
---

{{AddonSidebar}}

通过实现 userScripts,拓展开发者可以修改网站的外观和/或功能,以更好地满足用户需求。
通过实现 userScript,扩展开发者可以修改网站的外观和/或功能,以更好地满足用户需求。

使用以下步骤在拓展中实现 userScripts
使用以下步骤在扩展中实现 userScript

1. 使用扩展的清单文件中的 `"user_scripts"` 键定义脚本。
2. 注册 userScript
3. 实现 userScript 函数

让我们通过一个小型 Web 拓展示例具体介绍这一过程,逐步了解它吧!该示例可在 GitHub 上的 [webextensions-examples](https://github.com/mdn/webextensions-examples) 获取得到
让我们通过一个小型 Web 扩展示例具体介绍这一过程,逐步了解它吧!该示例可在 GitHub 上的 [webextensions-examples](https://github.com/mdn/webextensions-examples) 获取到

## userScripts 清单
## userScript 清单

用户脚本是通过扩展的清单文件中的 [user_scripts](/zh-CN/docs/Mozilla/Add-ons/WebExtensions/manifest.json/user_scripts) 键来被识别的`user_scripts` 键的信息至少应该是:
用户脚本是通过扩展的清单文件中的 [user_scripts](/zh-CN/docs/Mozilla/Add-ons/WebExtensions/manifest.json/user_scripts) 键来标识的`user_scripts` 键的信息至少应该是:

```json
"user_scripts": {
Expand All @@ -29,23 +29,23 @@ l10n:

“api_script”属性指示包含 `userScript` 代码的 JavaScript 文件的路径。

## 加载示例拓展
## 加载示例扩展

一旦你下载了示例:

导航到 about:debugging,点击**加载临时附加组件**然后双击拓展的清单
导航到 about:debugging,点击**临时加载附加组件**然后双击扩展的清单

示例中包含的默认代码允许你加载一个 `userScript``userScript`“吃掉”与 Hosts 条目匹配的页面的内容。在单击面板底部的**注册脚本**按钮之前,可以对其进行任何更改。
示例中包含的默认代码允许你加载一个 `userScript`其会“吃掉”与 Hosts 条目匹配的页面的内容。在单击面板底部的**注册脚本**(Register script)按钮之前,可以对其进行任何更改。

在下图中,拓展将“吃掉”域名以 .org 结尾的页面的内容。这是该拓展的默认行为
在下图中,扩展将“吃掉”域名以 .org 结尾的页面的内容。这是该扩展的默认行为

![用户脚本示例](userscriptexample.png)

在单击**注册脚本**按钮之前,不会发生任何事情。该按钮根据对话框上的设置实现用户脚本。这意味着你可以在不必自己实现拓展的情况下尝试脚本的行为
在单击**注册脚本**按钮之前,不会发生任何事情。该按钮根据对话框上的设置实现用户脚本。这意味着你可以在不必自己实现扩展的情况下尝试脚本的行为

## 注册 userScript

在执行 userScript 之前,必须使用 `userScripts.register()` 方法注册它。以下是注册示例拓展的代码
在执行 userScript 之前,必须使用 `userScripts.register()` 方法注册它。以下是注册示例扩展的代码

```js
async function registerScript() {
Expand All @@ -61,7 +61,7 @@ async function registerScript() {
scriptMetadata: { name: scriptNameInput.value || null },
};

// 保存最后提交的值到扩展存储中(这样当下次打开弹出窗口时可以恢复这些值)。
// 保存最后提交的值到扩展存储中(这样当下次打开弹出窗口时可以恢复这些值)。
await browser.storage.local.set({
lastSetValues: params,
});
Expand All @@ -71,11 +71,11 @@ async function registerScript() {
lastResultEl.textContent = "";

await browser.runtime.sendMessage(params);
lastResultEl.textContent = "UserScript 成功被注册了";
lastResultEl.textContent = "UserScript 被成功注册了";
// 清空上次 userScripts.register 的错误。
lastErrorEl.textContent = "";

// 清空上次错误
// 清空上次存储的错误
await browser.storage.local.remove("lastError");
} catch (e) {
// 注册 userScript 时出现错误,让我们在弹出窗口中显示错误消息并将上次错误存储到扩展存储中。
Expand All @@ -96,7 +96,7 @@ async function registerScript() {

一旦脚本被注册,导航到域名以 .org 结尾的页面,你将看到类似于下面的内容:

![以 .org 结尾的网站页面被“吃掉”时显示的状态消息:“此页面已被吃掉。{"OldStoredValue:" "website address", "NewStoredValue:" "website address"}"](user_script_in_action.png)
![以 .org 结尾的网站页面被“吃掉”时显示的状态消息:“This page has been eaten. {"OldStoredValue:" "website address", "NewStoredValue:" "website address"}"](user_script_in_action.png)

## 参见

Expand Down

0 comments on commit 03e4f5c

Please sign in to comment.