manifest.json

这是一个Chrome插件最重要也是必不可少的文件,用来配置所有和插件相关的配置,必须放在根目录。其中,manifest_versionnameversion3个是必不可少的,descriptionicons是推荐的。

下面给出的是一些常见的配置项,均有中文注释,完整的配置文档请戳这里

  1. {
  2. // 清单文件的版本,这个必须写,而且必须是2
  3. "manifest_version": 2,
  4. // 插件的名称
  5. "name": "demo",
  6. // 插件的版本
  7. "version": "1.0.0",
  8. // 插件描述
  9. "description": "简单的Chrome扩展demo",
  10. // 图标,一般偷懒全部用一个尺寸的也没问题
  11. "icons":
  12. {
  13. "16": "img/icon.png",
  14. "48": "img/icon.png",
  15. "128": "img/icon.png"
  16. },
  17. // 会一直常驻的后台JS或后台页面
  18. "background":
  19. {
  20. // 2种指定方式,如果指定JS,那么会自动生成一个背景页
  21. "page": "background.html"
  22. //"scripts": ["js/background.js"]
  23. },
  24. // 浏览器右上角图标设置,browser_action、page_action、app必须三选一
  25. "browser_action":
  26. {
  27. "default_icon": "img/icon.png",
  28. // 图标悬停时的标题,可选
  29. "default_title": "这是一个示例Chrome插件",
  30. "default_popup": "popup.html"
  31. },
  32. // 当某些特定页面打开才显示的图标
  33. /*"page_action":
  34. {
  35. "default_icon": "img/icon.png",
  36. "default_title": "我是pageAction",
  37. "default_popup": "popup.html"
  38. },*/
  39. // 需要直接注入页面的JS
  40. "content_scripts":
  41. [
  42. {
  43. //"matches": ["http://*/*", "https://*/*"],
  44. // "<all_urls>" 表示匹配所有地址
  45. "matches": ["<all_urls>"],
  46. // 多个JS按顺序注入
  47. "js": ["js/jquery-1.8.3.js", "js/content-script.js"],
  48. // JS的注入可以随便一点,但是CSS的注意就要千万小心了,因为一不小心就可能影响全局样式
  49. "css": ["css/custom.css"],
  50. // 代码注入的时间,可选值: "document_start", "document_end", or "document_idle",最后一个表示页面空闲时,默认document_idle
  51. "run_at": "document_start"
  52. },
  53. // 这里仅仅是为了演示content-script可以配置多个规则
  54. {
  55. "matches": ["*://*/*.png", "*://*/*.jpg", "*://*/*.gif", "*://*/*.bmp"],
  56. "js": ["js/show-image-content-size.js"]
  57. }
  58. ],
  59. // 权限申请
  60. "permissions":
  61. [
  62. "contextMenus", // 右键菜单
  63. "tabs", // 标签
  64. "notifications", // 通知
  65. "webRequest", // web请求
  66. "webRequestBlocking",
  67. "storage", // 插件本地存储
  68. "http://*/*", // 可以通过executeScript或者insertCSS访问的网站
  69. "https://*/*" // 可以通过executeScript或者insertCSS访问的网站
  70. ],
  71. // 普通页面能够直接访问的插件资源列表,如果不设置是无法直接访问的
  72. "web_accessible_resources": ["js/inject.js"],
  73. // 插件主页,这个很重要,不要浪费了这个免费广告位
  74. "homepage_url": "https://www.baidu.com",
  75. // 覆盖浏览器默认页面
  76. "chrome_url_overrides":
  77. {
  78. // 覆盖浏览器默认的新标签页
  79. "newtab": "newtab.html"
  80. },
  81. // Chrome40以前的插件配置页写法
  82. "options_page": "options.html",
  83. // Chrome40以后的插件配置页写法,如果2个都写,新版Chrome只认后面这一个
  84. "options_ui":
  85. {
  86. "page": "options.html",
  87. // 添加一些默认的样式,推荐使用
  88. "chrome_style": true
  89. },
  90. // 向地址栏注册一个关键字以提供搜索建议,只能设置一个关键字
  91. "omnibox": { "keyword" : "go" },
  92. // 默认语言
  93. "default_locale": "zh_CN",
  94. // devtools页面入口,注意只能指向一个HTML文件,不能是JS文件
  95. "devtools_page": "devtools.html"
  96. }

matches的语法参考:https://developer.chrome.com/extensions/match_patterns