chrome.browserAction

說明

可用性

在下圖中，網址列右側的多色方塊是瀏覽器動作的圖示。圖示下方會顯示彈出式視窗。

如要建立並非一律處於啟用狀態的圖示，請改用網頁動作，而非瀏覽器動作。

資訊清單

在擴充功能資訊清單中註冊瀏覽器動作，如下所示：

{   "name": "My extension",   ...   "browser_action": {     "default_icon": {                // optional       "16": "images/icon16.png",     // optional       "24": "images/icon24.png",     // optional       "32": "images/icon32.png"      // optional     },     "default_title": "Google Mail",  // optional, shown in tooltip     "default_popup": "popup.html"    // optional   },   ... } 

你可以提供任何大小的圖示供 Chrome 使用，Chrome 會選取最接近的圖示，並將其縮放至適當大小，填滿 16 dp 的空間。不過，如果未提供確切大小，縮放作業可能會導致圖示失去細節或模糊不清。

由於 1.5 倍或 1.2 倍等較不常見的比例係數裝置越來越普及，建議您提供多種尺寸的圖示。此外，如果圖示顯示大小有任何變更，您也不需要再提供其他圖示！

系統仍支援註冊預設圖示的舊語法：

{   "name": "My extension",   ...   "browser_action": {     ...     "default_icon": "images/icon32.png"  // optional     // equivalent to "default_icon": { "32": "images/icon32.png" }   },   ... } 

使用者介面各部分

瀏覽器動作可以有圖示、工具提示、徽章和彈出式視窗。

圖示

Chrome 中的瀏覽器動作圖示寬度和高度都是 16 dips (與裝置無關的像素)。系統會調整較大的圖示大小，以符合規定，但為求最佳效果，請使用 16 dp 的正方形圖示。

您可以透過兩種方式設定圖示：使用靜態圖片或 HTML5 畫布元素。使用靜態圖片較容易製作簡單的應用程式，但您可以使用畫布元素建立更動態的 UI，例如流暢的動畫。

靜態圖片可採用 WebKit 支援的任何格式，包括 BMP、GIF、ICO、JPEG 或 PNG。如果是未封裝的擴充功能，圖片必須為 PNG 格式。

如要設定圖示，請使用 資訊清單中 default_icon 的 default_icon 欄位，或呼叫 browserAction.setIcon 方法。

如要在螢幕像素密度 (比例 size_in_pixel / size_in_dip) 不是 1 時正確顯示圖示，可以將圖示定義為一組不同大小的圖片。系統會從該組圖片中選取最適合 16 dip 像素大小的圖片顯示。圖示集可包含任何大小的圖示規格，Chrome 會選取最合適的規格。

工具提示

如要設定工具提示，請使用資訊清單中 default_title 的 default_title 欄位，或呼叫 browserAction.setTitle 方法。您可以為 default_title 欄位指定特定語言代碼的字串；詳情請參閱「國際化」一文。

徽章

瀏覽器動作可以選擇性顯示徽章，也就是疊加在圖示上的文字。 徽章可讓您輕鬆更新瀏覽器動作，顯示擴充功能狀態的少量資訊。

徽章空間有限，因此長度不得超過 4 個字元。

分別使用 browserAction.setBadgeText 和 browserAction.setBadgeBackgroundColor 設定徽章的文字和顏色。

彈出式廣告

如果瀏覽器動作有彈出式視窗，使用者點按擴充功能的圖示時，就會看到彈出式視窗。彈出式視窗可包含任何 HTML 內容，並會自動調整大小以配合內容。彈出式視窗不得小於 25x25，也不得大於 800x600。

如要為瀏覽器動作新增彈出式視窗，請建立含有彈出式視窗內容的 HTML 檔案。在 資訊清單的 default_popup 欄位中，於 default_popup 欄位指定 HTML 檔案，或呼叫 browserAction.setPopup 方法。

訣竅

如要達到最佳視覺效果，請遵循下列規範：

• 請針對大多數網頁適用的功能使用瀏覽器動作。
• 請勿將瀏覽器動作用於只適用於少數網頁的功能。請改用頁面動作。
• 請使用大型彩色圖示，充分利用 16x16 dp 的空間。瀏覽器動作圖示應比網頁動作圖示稍大且粗。
• 請勿嘗試模仿 Google Chrome 的單色選單圖示。這與主題不太相容，而且無論如何，擴充功能應該要稍微突出。
• 請使用 Alpha 透明度為圖示加上柔和的邊緣。由於許多人會使用主題，因此圖示在各種背景顏色上都應呈現美觀。
• 請勿讓圖示持續呈現動畫效果。這真的很煩。

範例

您可以在 examples/api/browserAction 目錄中找到使用瀏覽器動作的簡單範例。如需其他範例及查看原始碼的說明，請參閱「範例」。

chrome.browserAction.disable(
  tabId?: number,
  callback?: function,
): Promise<void>

chrome.browserAction.enable(
  tabId?: number,
  callback?: function,
): Promise<void>

chrome.browserAction.getBadgeBackgroundColor(
  details: TabDetails,
  callback?: function,
): Promise<extensionTypes.ColorArray>

chrome.browserAction.getBadgeText(
  details: TabDetails,
  callback?: function,
): Promise<string>

chrome.browserAction.getPopup(
  details: TabDetails,
  callback?: function,
): Promise<string>

chrome.browserAction.getTitle(
  details: TabDetails,
  callback?: function,
): Promise<string>

chrome.browserAction.setBadgeBackgroundColor(
  details: object,
  callback?: function,
): Promise<void>

chrome.browserAction.setBadgeText(
  details: object,
  callback?: function,
): Promise<void>

chrome.browserAction.setIcon(
  details: object,
  callback?: function,
): Promise<void>

chrome.browserAction.setPopup(
  details: object,
  callback?: function,
): Promise<void>

chrome.browserAction.setTitle(
  details: object,
  callback?: function,
): Promise<void>

chrome.browserAction.onClicked.addListener(
  callback: function,
)