icewing

制作一个Chrome右键划词搜索扩展
前言Chrome中最常用的就是划词搜索了。然而这个功能只能使用一个搜索引擎来搜索。有时需要用到其他搜索引擎。还需要...
扫描右侧二维码阅读全文
06
2019/03

制作一个Chrome右键划词搜索扩展

前言

Chrome中最常用的就是划词搜索了。然而这个功能只能使用一个搜索引擎来搜索。有时需要用到其他搜索引擎。还需要打开相应的主页面去搜索。很不方便。

也想过要去找个扩展,把菜单扩展一下。我只是想扩展一下多个百度搜索就行。其他什么功能我都不想要。然而并没有找到中意的。简单看了一下谷歌的扩展文档。所幸并不是很复杂。所以自己动手来做一个。


下载

crx文件地址:https://drop.me/o11z7O

商店地址:https://chrome.google.com/webstore/detail/%E5%8F%B3%E9%94%AE%E8%8F%9C%E5%8D%95/gbldcaajiiliclkffblgeaiblkggnapd/related

  • 如需源码在下方。

介绍

在Chrome扩展程序中,manifest.json是核心文件。是必不可少的文件。用来配置所有和插件相关的配置,必须放在根目录中。

其中,manifest_versionnameversion3个是必不可少的,descriptionicons是推荐的。


manifest.json源码

以下是manifest.json文件的源码。

{

    "name": "右键菜单",
    
    "description": "一个简单的右键菜单扩展,使用了百度搜索。制作者:ic翼(bingyishow.top)",

    "version": "0.5",
    
    "permissions": ["contextMenus", "tabs"],
    
    "background": {
        "scripts": ["menu.js"]
    },

    "manifest_version": 2

}

manifest文件解释

以下是manifest文件的解释。

  • name:插件的名称
  • description:插件的描述
  • version:插件的版本
  • permissions:权限的申请

    • 这里我用到了contextMenustabs。分别是 右键菜单、标签。
    • 其他还有:notifications (通知)webRequest、webRequestBlocking(web请求)storage(插件本地存储)http://*/*https://*/*是可以通过executeScript或者insertCSS访问的网站
  • background:一直常驻的后台JS或后台页面,其中有两种指定方式

    • "page" : "background.html" 或者 "scripts" : ["menu.js"]
  • manifest_version:本文件的版本,这个必须要写,而且现在只添2。

其他未用到的参数解释。(为了直观就用代码的方式来说明了)

// 图标,一般偷懒全部用一个尺寸的也没问题
    "icons":
    {
        "16": "img/icon.png",
        "48": "img/icon.png",
        "128": "img/icon.png"
    },

---------------------------------------------
    
// 浏览器右上角图标设置,browser_action、page_action、app必须三选一
    "browser_action": 
    {
        "default_icon": "img/icon.png",
        // 图标悬停时的标题,可选
        "default_title": "这是一个示例Chrome插件",
        "default_popup": "popup.html"
    },
    或者
    "page_action":
    {
        "default_icon": "img/icon.png",
        "default_title": "我是pageAction",
        "default_popup": "popup.html"
    },

---------------------------------------------

    // 需要直接注入页面的JS
    "content_scripts": 
    [
        {
            // "matches": ["http://*/*", "https://*/*"],
            // "<all_urls>" 表示匹配所有地址
            "matches": ["<all_urls>"],
            // 多个JS按顺序注入
            "js": ["js/jquery-1.8.3.js", "js/content-script.js"],
            // JS的注入可以随便一点,但是CSS的注意就要千万小心了,因为一不小心就可能影响全局样式
            "css": ["css/custom.css"],
            // 代码注入的时间,可选值: "document_start", "document_end", or "document_idle",最后一个表示页面空闲时,默认document_idle
            "run_at": "document_start"
        },
    // 这里仅仅是为了演示content-script可以配置多个规则
        {
            "matches": ["*://*/*.png", "*://*/*.jpg", "*://*/*.gif", "*://*/*.bmp"],
            "js": ["js/show-image-content-size.js"]
        }
    ],

---------------------------------------------

    // 普通页面能够直接访问的插件资源列表,如果不设置是无法直接访问的
    "web_accessible_resources": ["js/inject.js"],

---------------------------------------------

    // 插件主页,这个很重要,可以添加广告位
    "homepage_url": "https://www.baidu.com",

---------------------------------------------

    // 覆盖浏览器默认页面
    "chrome_url_overrides":
    {
        // 覆盖浏览器默认的新标签页
        "newtab": "newtab.html"
    },

---------------------------------------------

    // Chrome40以前的插件配置页写法
    "options_page": "options.html",

---------------------------------------------

    // Chrome40以后的插件配置页写法,如果2个都写,新版Chrome只认后面这一个
    "options_ui":
    {
        "page": "options.html",
        // 添加一些默认的样式,推荐使用
        "chrome_style": true
    },

---------------------------------------------

    // 向地址栏注册一个关键字以提供搜索建议,只能设置一个关键字
    "omnibox": { "keyword" : "go" },

---------------------------------------------

    // 默认语言
    "default_locale": "zh_CN",

---------------------------------------------

    // devtools页面入口,注意只能指向一个HTML文件,不能是JS文件
    "devtools_page": "devtools.html"

        

核心代码

简单创建完manifest后,就可以添加自己的js文件了。这里我添加了menu.js。源码如下。

function baiduSearch(info, tab) {
    window.open("https://www.baidu.com/s?wd=" + info.selectionText);
}

chrome.contextMenus.create({
    "title": "使用百度搜索",
    "contexts": ["selection"],
    "onclick": baiduSearch
});

这里就只介绍一下contextmenus

chrome.contextMenus.create({
    type: 'normal', // 类型,可选:["normal", "checkbox", "radio", "separator"],默认 normal
    title: '菜单的名字', // 显示的文字,除非为“separator”类型否则此参数必需,如果类型为“selection”,可以使用%s显示选定的文本
    contexts: ['page'], // 上下文环境,可选:["all", "page", "frame", "selection", "link", "editable", "image", "video", "audio"],默认page
    onclick: function(){}, // 单击时触发的方法
    parentId: 1, // 右键菜单项的父菜单项ID。指定父菜单项将会使此菜单项成为父菜单项的子菜单
    documentUrlPatterns: 'https://*.baidu.com/*' // 只在某些页面显示此右键菜单
});
// 删除某一个菜单项
chrome.contextMenus.remove(menuItemId);
// 删除所有自定义右键菜单
chrome.contextMenus.removeAll();
// 更新某一个菜单项
chrome.contextMenus.update(menuItemId, updateProperties);

关于打包&使用

写好这两个文件。直接放到某个文件夹里。然后打开chrome的扩展程序页面chrome://extensions/。左上角分别有 加载已解压的扩展程序、打包扩展程序、更新。

使用 加载已解压的扩展程序 可以调试扩展、打包就是打包扩展。就不过多介绍了。

到此就完成了一个简单的扩展。更高级的功能之后再编写吧。现在已经满足了。:)

最后修改:2019 年 03 月 06 日 08 : 57 PM
生活需要一些仪式感,比如手冲一杯咖啡:)

发表评论