谷歌扩展开发教程(三)案例:“聚焦阅读”扩展

通过单击扩展工具栏图标或快捷键来简化当前页面的样式,使其更易于阅读。

构建扩展

首先,创建一个名为focus-mode保存扩展文件的新目录。如果您愿意,可以从GitHub下载完整的源代码。

第一步 添加有关扩展的信息和图标

创建一个名为manifest.json并包含以下代码的文件。

{
  "manifest_version": 3,
  "name": "聚焦模式",
  "description": "使新浪新闻页面更加聚焦新闻内容",
  "version": "1.0",
  "icons": {
    "16": "images/icon-16.png",
    "32": "images/icon-32.png",
    "48": "images/icon-48.png",
    "128": "images/icon-128.png"
  }
}

第 2 步:初始化扩展

background:是一个常驻的页面,它的生命周期是插件中所有类型页面中最长的,它随着浏览器的打开而打开,随着浏览器的关闭而关闭,所以通常把需要一直运行的、启动就运行的、全局的代码放在background里面。

background的权限非常高,几乎可以调用所有的Chrome扩展API(除了devtools),而且它可以无限制跨域,也就是可以跨域访问任何网站而无需要求对方设置CORS

扩展可以使用扩展的 service worker在后台监控浏览器事件。Service workers是特殊的 JavaScript 环境,它们被加载以处理事件并在不再需要时终止。

首先在manifest.json文件中注册service worker:

{
  ...
  "background": {
    "service_worker": "background.js"
  },
  ...
}

创建一个名为的文件background.js并添加以下代码:

chrome.runtime.onInstalled.addListener(() => {
  chrome.action.setBadgeText({
    text: "OFF",
  });
});

我们的 service worker 将监听的第一个事件是runtime.onInstalled(). 此方法允许扩展首次安装扩展程序、扩展程序更新到新版本以及 Chrome 更新到新版本时触发。

扩展可以使用Storage API和IndexedDB来存储应用程序状态。但是,在现在这个案例情况下,由于我们只处理两种状态,我们将使用action's badge文本本身来跟踪扩展是“开”还是“关”。

chrome.action.setBadgeText({
    text: "OFF",
});

设置图标下方显示内容,注意:空间有限,通常应使用四个或更少的字符。

第3步:启用扩展操作

扩展操作控制扩展的工具栏图标。因此,每当用户单击扩展操作时,它要么运行一些代码(如本例所示),要么显示一个弹出窗口。添加以下代码以在manifest.json文件中声明扩展操作:

{
  ...
  "action": {
    "default_icon": {
      "16": "images/icon-16.png",
      "32": "images/icon-32.png",
      "48": "images/icon-48.png",
      "128": "images/icon-128.png"
    }
  },
  ...
}

使用activeTab权限保护用户隐私

activeTab权限授予扩展在当前活动选项卡上执行代码的临时能力。它还允许访问当前选项卡的敏感属性。

此权限在用户调用invokes扩展程序时启用。在这种情况下,用户通过单击扩展操作来调用扩展。

要使用activeTab权限,请将其添加到清单的权限数组中:

{
  ...
  "permissions": ["activeTab"],
  ...
}

第 4 步:跟踪当前选项卡的状态

用户单击扩展操作后,扩展将检查 URL 是否与文档页面匹配,使用startsWith方法。

接下来,它将检查当前选项卡的状态并设置下一个状态。将以下代码添加到background.js

const extensions = 'https://news.sina.com.cn/';

chrome.action.onClicked.addListener(async (tab) => {
  if (tab.url.startsWith(extensions)) {
    // Retrieve the action badge to check if the extension is 'ON' or 'OFF'
    const prevState = await chrome.action.getBadgeText({ tabId: tab.id });
    // Next state will always be the opposite
    const nextState = prevState === 'ON' ? 'OFF' : 'ON'

    // 设置图标(badge)下一个状态
    await chrome.action.setBadgeText({
      tabId: tab.id,
      text: nextState,
    });
...

tab.url 获取当前页面的相关信息

第 5 步:添加或删除样式表

现在是时候改变页面的布局了。创建一个名为focus_mode.css并包含以下代码的文件:

body > .main-content > .top-banner,
body > .main-content > .article-content > .article-content-left > .top-ad,
body > .main-content > .article-content > .article-content-left > .blk-comment,
body > .main-content > .article-content > .article-content-left > .blk-related,
body > .main-content > .article-content > .article-content-right{
  display: none;
}

让我们使用Scripting API插入或删除样式表。首先"scripting"在清单中声明权限:

{
  ...
  "permissions": ["activeTab", "scripting"],
  ...
}

最后,在background.js添加以下代码来更改页面的布局:

  ...
    if (nextState === "ON") {
      // Insert the CSS file when the user turns the extension on
      await chrome.scripting.insertCSS({
        files: ["focus_mode.css"],
        target: { tabId: tab.id },
      });
    } else if (nextState === "OFF") {
      // Remove the CSS file when the user turns the extension off
      await chrome.scripting.removeCSS({
        files: ["focus_mode.css"],
        target: { tabId: tab.id },
      });
    }
  }
});

第6步:分配键盘快捷键

只是为了好玩,让我们添加一个快捷方式,以便更轻松地启用或禁用焦点模式。将"commands"密钥添加到清单中。

  "commands": {
    "_execute_action": {
      "suggested_key": {
        "default": "Ctrl+Z",
        "mac": "Command+Z"
      }
    }
  }
}

对焦模式扩展关闭时:

对焦模式扩展开启时:


©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,658评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,482评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,213评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,395评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,487评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,523评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,525评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,300评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,753评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,048评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,223评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,905评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,541评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,168评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,417评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,094评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,088评论 2 352

推荐阅读更多精彩内容