DIV CSS 佈局教程網

用 JavaScript 開發 Chrome 擴充功能:UI 與互動完整指南
編輯:關於JavaScript     

Chrome 擴充功能的介面並不是隨便寫寫 HTML 就好,它有自己的一套結構與溝通機制。這篇文章把常見的 UI 元件、檔案互動方式與權限宣告一次梳理清楚。

一、擴充功能的基本結構

1. manifest.json

不論是擴充功能、可安裝的 Web App 還是主題,都必須具備一份 JSON 格式的 manifest,用來存放名稱、版本、權限與各項設定。

{
  "name": "browser action demo",
  "version": "1.0",
  "permissions": [ "tabs", "https://*/*", "https://*/*" ],
  "browser_action": {
    "default_title": "開關燈",
    "default_icon": "icon.png",
    "default_popup": "popup.html"
  },
  "background": { "page": "background.html" },
  "manifest_version": 2
}

2. popup

點擊工具列圖示後跳出的小視窗,就是上面設定裡 default_popup 指向的頁面。

3. background page

多數擴充功能都會有一個背景頁,負責執行主要邏輯與長時間運行的任務。

4. Content scripts

Content script 是注入到已載入網頁中執行的 JavaScript,可以把它視為網頁的一部分,而不是擴充功能本身的一部分。它讓擴充功能得以與實際頁面互動。

二、各檔案之間如何溝通

popup 可以直接呼叫背景頁的函式;content script 則能讀取並修改頁面的 DOM 樹,但無法直接改動背景頁的 DOM。content script 與擴充功能本體之間,透過訊息傳遞來協作。

三、把 JS 注入網頁的兩種方式

方式一,寫在 manifest 裡:

"content_scripts": [
  {
    "matches": ["https://www.google.com/*"],
    "css": ["mystyles.css"],
    "js": ["jquery.js", "myscript.js"]
  }
],

方式二,透過 executeScript() 動態注入:

chrome.tabs.executeScript(integer tabId, object details, function callback)
chrome.tabs.executeScript(tabId, {file: "func.js", allFrames: true});

四、UI 外觀:Browser Action

browser action 會在網址列右側放上一顆圖示。要注意的是,Packaged apps 無法使用 browser action。

先在 manifest 中註冊:

{
  "name": "My extension",
  ...
  "browser_action": {
    "default_icon": "images/icon19.png",   // optional
    "default_title": "Google Mail",        // optional; shown in tooltip
    "default_popup": "popup.html"          // optional
  },
  ...
}

三個主要設定項分別是:

default_icon:尺寸為 19×19 像素,可用 setIcon() 動態替換,值可以是圖片路徑,也可以是从 canvas 取得的像素資料。

chrome.browserAction.setIcon(object details)

default_title:滑鼠停留時顯示在 tooltip 中的文字,可用 setTitle() 修改,也支援在地化字串。

chrome.browserAction.setTitle(object details)

Badge:圖示上的小角標,適合顯示簡短的狀態提示。由於空間有限,最多只支援四個字元以內。

chrome.browserAction.setBadgeText(object details)
chrome.browserAction.setBadgeBackgroundColor(object details)

default_popup:點擊圖示後展開的彈出視窗,用 setPopup() 指定 HTML 檔。

chrome.browserAction.setPopup(object details)

為了讓顯示效果最好,官方建議:browser action 要用在多數網站都有意義的功能上;只對少數網站有用的功能該改用 page action;圖示盡量填滿 19×19 的空間,視覺份量應比 page action 更重;不要模仿 Chrome 的扳手圖示,換主題時容易出問題;善用 alpha 通道並柔化邊緣,確保各種背景下都清楚;更不要讓圖示持續閃動,那非常惱人。

五、右鍵選單

可以針對圖片、連結、頁面等不同對象加入右鍵選單,同一個擴充功能的多個選單項會被 Chrome 自動收進以擴充名稱命名的二層選單。選單可出現在任何文件或框架中,甚至 file:// 與 chrome:// 頁面;若要控制顯示範圍,可在 create() 與 update() 時指定 documentUrlPatterns。

{
  "name": "My extension",
  ...
  "permissions": [ "contextMenus" ],
  "icons": {
    "16": "icon-bitty.png",
    "48": "icon-small.png",
    "128": "icon-large.png"
  },
  ...
}

六、桌面通知

桌面通知會顯示在瀏覽器視窗之外,不同平台的呈現樣式略有差異。你可以直接用一小段 JavaScript 建立通知,也可以透過擴充包內獨立的 HTML 頁面來做。

{
  "name": "My extension",
  ...
  "permissions": [ "notifications" ],
  ...
}

通知與擴充頁面之間可以用 getBackgroundPage() 與 getViews() 互相呼叫:

// 在通知中呼叫擴充頁面的方法
chrome.extension.getBackgroundPage().doThing();

// 從擴充頁面呼叫通知的方法
chrome.extension.getViews({type:"notification"}).forEach(function(win) {
  win.doOtherThing();
});

七、Omnibox

Omnibox 就是網址列。擴充功能可以向它註冊一個關鍵字,使用者在網址列輸入該關鍵字後即可觸發。manifest 中必須有 omnibox 欄位,並提供 16×16 的圖示;Chrome 會自動產生灰階版本,因此最好另外附上全彩圖示供其他場景使用。

{
  "name": "Aaron's omnibox extension",
  "version": "1.0",
  "omnibox": { "keyword" : "aaron" },
  "icons": { "16": "16-full-color.png" },
  "background_page": "background.html"
}

八、選項頁

如果擴充功能需要使用者自行設定,就該提供選項頁。設定完成後,chrome://extensions 的擴充資訊頁會出現一個「選項」連結。

{
  "name": "My extension",
  ...
  "options_page": "options.html",
  ...
}

九、覆寫特定頁面

透過 chrome_url_overrides,可以把 Chrome 的部分內建頁面換成擴充功能提供的版本。

{
  "name": "My extension",
  ...
  "chrome_url_overrides" : {
    "pageToOverride": "myPage.html"
  },
  ...
}

十、Page Actions

page action 同樣把圖示放在網址列,差別在於它預設隱藏,需要用 show() 與 hide() 控制,並指定圖示要出現在哪個分頁。圖示一旦顯示就會持續存在,直到該分頁關閉或導向另一個 URL。若希望圖示永遠可見,請改用 browser action;Packaged apps 也不能使用 page action。

{
  "name": "My extension",
  ...
  "page_action": {
    "default_icon": "icons/foo.png",  // optional
    "default_title": "Do action",     // optional; shown in tooltip
    "default_popup": "popup.html"     // optional
  },
  ...
}

page action 可以有圖示、提示文字與彈出視窗,但沒有 badge。使用原則與 browser action 相反:只對少數頁面使用它,別讓圖示動來動去。

十一、主題(Theme)

主題是一種特殊的擴充功能,用來替換整個瀏覽器的外觀。打包方式與一般擴充功能類似,但主題裡不能包含 JavaScript 或 HTML 程式碼。

{
  "version": "2.6",
  "name": "camo theme",
  "theme": {
    "images" : {
      "theme_frame" : "images/theme_frame_camo.png",
      "theme_frame_overlay" : "images/theme_frame_stripe.png",
      "theme_toolbar" : "images/theme_toolbar_camo.png",
      "theme_ntp_background" : "images/theme_ntp_background_norepeat.png",
      "theme_ntp_attribution" : "images/attribution.png"
    },
    "colors" : {
      "frame" : [71, 105, 91],
      "toolbar" : [207, 221, 192],
      "ntp_text" : [20, 40, 0],
      "ntp_link" : [36, 70, 0],
      "ntp_section" : [207, 221, 192],
      "button_background" : [255, 255, 255]
    },
    "tints" : { "buttons" : [0.33, 0.5, 0.47] },
    "properties" : { "ntp_background_alignment" : "bottom" }
  }
}

把這些元件搭配起來,就足以做出功能完整的擴充功能介面。實作時建議先確認需求屬於「全站通用」還是「特定頁面」,再決定用 browser action 還是 page action,這一步選錯,後面的 UI 設計都會顯得彆扭。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved