chrome.action

說明

使用 chrome.action API 控制 Google Chrome 工具列中的擴充功能圖示。

瀏覽器工具列中的網址列旁會顯示操作圖示。安裝完成後，這些圖示會顯示在擴充功能選單 (拼圖圖示) 中。 使用者可以將擴充功能圖示固定到工具列。

可用性

Chrome 88 以上版本 MV3 以上

資訊清單

您必須在資訊清單中宣告下列金鑰，才能使用這個 API。

"action"

如要使用 chrome.action API，請指定 3 的 "manifest_version"，並加入 資訊清單檔案中的 "action" 金鑰。

{
  "name": "Action Extension",
  ...
  "action": {
    "default_icon": {              // optional
      "16": "images/icon16.png",   // optional
      "24": "images/icon24.png",   // optional
      "32": "images/icon32.png"    // optional
    },
    "default_title": "Click Me",   // optional, shown in tooltip
    "default_popup": "popup.html"  // optional
  },
  ...
}

"action" 鍵 (及其子項) 是選用項目，未包含的擴充功能仍會顯示在工具列中，供你存取該擴充功能的選單。因此，建議您一律加入至少 "action" 和 "default_icon" 金鑰。

概念和用法

UI 的組成部分

圖示

圖示是擴充功能工具列上的主要圖片，由 "default_icon" 鍵的設定 資訊清單的 "action" 鍵。圖示的寬度和高度必須為 16 個裝置獨立像素 (DIP)。

"default_icon" 鍵是圖片路徑大小的字典。Chrome 會使用這些圖示 選擇要使用的圖片比例如果找不到完全相符的結果，Chrome 會選擇最接近的項目 並縮放以調整為適合圖片的大小，這可能會影響圖像品質。

因為使用比例較低的因素 (例如 1.5 或 1.2 倍) 的裝置數量會越來越高 很常見的做法，因此建議您為圖示提供多種尺寸。這也 有助於擴充功能日後可能發生圖示顯示大小變更的情況。不過 如果只提供單一大小，也可將 "default_icon" 鍵設為 字串，其中包含單一圖示 (而非字典) 的路徑。

您也可以呼叫 action.setIcon()，透過程式輔助方式設定擴充功能的圖示 方法是指定不同的圖片路徑，或使用 HTML 畫布提供動態產生的圖示 元素；如果是擴充功能 Service Worker 的設定，則為「外部畫面」 Canvas API。

const canvas = new OffscreenCanvas(16, 16);
const context = canvas.getContext('2d');
context.clearRect(0, 0, 16, 16);
context.fillStyle = '#00FF00';  // Green
context.fillRect(0, 0, 16, 16);
const imageData = context.getImageData(0, 0, 16, 16);
chrome.action.setIcon({imageData: imageData}, () => { /* ... */ });

如果是封裝的擴充功能 (從 .crx 檔案安裝)，則圖片可能是 Blink 轉譯引擎可顯示包括 PNG、JPEG、BMP、ICO 等。且不支援 SVG。 未封裝的擴充功能必須使用 PNG 圖片。

工具提示 (標題)

當使用者將滑鼠遊標懸停在 也就是在按下按鈕時，螢幕閱讀器朗讀的文字內容 重點。

如要設定預設工具提示，請使用 manifest.json 中 "action" 鍵的 "default_title" 欄位。 您也可以呼叫 action.setTitle()，透過程式輔助方式進行設定。

徽章

您可以選擇在動作中顯示「標記」：在圖示上疊放一些文字。這樣一來， 更新動作，顯示少量的擴充功能狀態資訊 例如計數器徽章內含文字元件和背景顏色。由於空間有限 我們建議徽章文字使用最多四個字元。

如要建立徽章，請呼叫 action.setBadgeBackgroundColor() 和 action.setBadgeText()。資訊清單中沒有預設徽章設定。徽章顏色值 可以是介於 0 到 255 之間的四個整數陣列，構成 標記或含有 CSS 顏色值的字串。

chrome.action.setBadgeBackgroundColor(
  {color: [0, 255, 0, 0]},  // Green
  () => { /* ... */ },
);

chrome.action.setBadgeBackgroundColor(
  {color: '#00FF00'},  // Also green
  () => { /* ... */ },
);

chrome.action.setBadgeBackgroundColor(
  {color: 'green'},  // Also, also green
  () => { /* ... */ },
);

當使用者按一下 彈出式視窗可以包含任何您想要的 HTML 內容，而且會自動調整大小，以符合您的需求 排程。彈出式視窗的大小必須介於 25x25 至 800x600 像素之間。

彈出式視窗一開始是由以下項目的 "action" 鍵中的 "default_popup" 屬性設定： manifest.json 檔案。如果有，此屬性應指向延伸模組中的相對路徑 目錄。也可以使用 action.setPopup() 方法。

用途

個別分頁狀態

每個分頁的擴充功能動作可能會有不同的狀態。如何設定 分頁，使用 action API 設定方法中的 tabId 屬性。舉例來說 設定特定分頁的徽章文字，請執行下列操作：

function getTabId() { /* ... */}
function getTabBadge() { /* ... */}

chrome.action.setBadgeText(
  {
    text: getTabBadge(tabId),
    tabId: getTabId(),
  },
  () => { ... }
);

如未提供 tabId 屬性，系統會將設定視為全域設定。特定分頁 設定的優先順序高於通用設定

已啟用狀態

根據預設，每個分頁都會啟用 (可點擊) 工具列動作。如要控管這項設定，請使用 action.enable() 和 action.disable() 方法。這只會影響彈出式視窗 (如有) 或 系統將action.onClicked事件傳送到您的額外資訊；也不會影響動作呈現 點選工具列中的「校對這份文件」

範例

以下範例說明一些在擴充功能中使用動作的常見方式。如要試用這個 API， 安裝 chrome-extension-samples 中的 Action API 範例 Cloud Storage 也提供目錄同步處理功能

顯示彈出式視窗

擴充功能會在使用者點選擴充功能的動作時顯示彈出式視窗。目的地： 在自己的擴充功能中實作，並在 manifest.json 中宣告彈出式視窗，並指定 Chrome 應該顯示在彈出式視窗的內容

// manifest.json
{
  "name": "Action popup demo",
  "version": "1.0",
  "manifest_version": 3,
  "action": {
    "default_title": "Click to view a popup",
    "default_popup": "popup.html"
  }
}

<!-- popup.html -->
<!DOCTYPE html>
<html>
<head>
  <style>
    html {
      min-height: 5em;
      min-width: 10em;
      background: salmon;
    }
  </style>
</head>
<body>
  <p>Hello, world!</p>
</body>
</html>

點擊時插入內容指令碼

常見的擴充功能模式是使用擴充功能的 動作。此模式如以下範例所示。使用者點擊動作時，擴充功能 在目前的網頁中插入內容指令碼。接著，內容指令碼會顯示快訊來進行驗證 確保一切運作正常

// manifest.json
{
  "name": "Action script injection demo",
  "version": "1.0",
  "manifest_version": 3,
  "action": {
    "default_title": "Click to show an alert"
  },
  "permissions": ["activeTab", "scripting"],
  "background": {
    "service_worker": "background.js"
  }
}

// background.js
chrome.action.onClicked.addListener((tab) => {
  chrome.scripting.executeScript({
    target: {tabId: tab.id},
    files: ['content.js']
  });
});

// content.js
alert('Hello, world!');

使用 declarativeContent 模擬動作

這個範例說明擴充功能的背景邏輯如何 (a) 預設停用動作；以及 (b) 使用 declarativeContent 即可讓特定網站執行動作。

// service-worker.js

// Wrap in an onInstalled callback to avoid unnecessary work
// every time the service worker is run
chrome.runtime.onInstalled.addListener(() => {
  // Page actions are disabled by default and enabled on select tabs
  chrome.action.disable();

  // Clear all rules to ensure only our expected rules are set
  chrome.declarativeContent.onPageChanged.removeRules(undefined, () => {
    // Declare a rule to enable the action on example.com pages
    let exampleRule = {
      conditions: [
        new chrome.declarativeContent.PageStateMatcher({
          pageUrl: {hostSuffix: '.example.com'},
        })
      ],
      actions: [new chrome.declarativeContent.ShowAction()],
    };

    // Finally, apply our new array of rules
    let rules = [exampleRule];
    chrome.declarativeContent.onPageChanged.addRules(rules);
  });
});

類型

OpenPopupOptions

Chrome 99 以上版本

屬性

  • windowId

    編號 選填

    要開啟動作彈出式視窗的視窗 ID。如未指定，則會預設為目前使用中的視窗。

TabDetails

屬性

  • tabId

    編號 選填

    要查詢狀態的分頁 ID。如未指定分頁，系統會傳回非分頁專屬的狀態。

UserSettings

Chrome 91 以上版本

與擴充功能動作相關的使用者指定的設定集合。

屬性

  • isOnToolbar

    布林值

    是否在瀏覽器視窗中顯示擴充功能的動作圖示頂層工具列 (例如使用者是否已「固定」擴充功能)。

方法

disable()

Promise 
chrome.action.disable(
  tabId?: number,
  callback?: function,
)

停用分頁動作。

參數

  • tabId

    編號 選填

    您要修改動作的分頁 ID。

  • 回呼

    函式 選用

    callback 參數如下所示： 

    () => void

傳回

  • Promise&lt;void&gt;

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

enable()

Promise 
chrome.action.enable(
  tabId?: number,
  callback?: function,
)

啟用分頁動作。根據預設，系統會啟用動作。

參數

  • tabId

    編號 選填

    您要修改動作的分頁 ID。

  • 回呼

    函式 選用

    callback 參數如下所示： 

    () => void

傳回

  • Promise&lt;void&gt;

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

getBadgeBackgroundColor()

Promise 
chrome.action.getBadgeBackgroundColor(
  details: TabDetails,
  callback?: function,
)

取得動作的背景顏色。

參數

傳回

  • Promise&lt;browserAction.ColorArray&gt;

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

getBadgeText()

Promise 
chrome.action.getBadgeText(
  details: TabDetails,
  callback?: function,
)

取得動作的徽章文字。如未指定分頁，系統會傳回非分頁專屬的標記文字。如果已啟用 displayActionCountAsBadgeText，則系統會傳回預留位置文字，除非有 declarativeNetRequestFeedback 權限，或是提供特定分頁的徽章文字。

參數

  • 詳細資料

    TabDetails

  • 回呼

    函式 選用

    callback 參數如下所示： 

    (result: string) => void

    • 結果

      字串

傳回

  • 承諾<字串>

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

getBadgeTextColor()

Promise Chrome 110 以上版本 
chrome.action.getBadgeTextColor(
  details: TabDetails,
  callback?: function,
)

取得動作的文字顏色。

參數

傳回

  • Promise&lt;browserAction.ColorArray&gt;

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

getPopup()

Promise 
chrome.action.getPopup(
  details: TabDetails,
  callback?: function,
)

取得 html 文件集，做為此動作的彈出式視窗。

參數

  • 詳細資料

    TabDetails

  • 回呼

    函式 選用

    callback 參數如下所示： 

    (result: string) => void

    • 結果

      字串

傳回

  • 承諾<字串>

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

getTitle()

Promise 
chrome.action.getTitle(
  details: TabDetails,
  callback?: function,
)

取得動作的標題。

參數

  • 詳細資料

    TabDetails

  • 回呼

    函式 選用

    callback 參數如下所示： 

    (result: string) => void

    • 結果

      字串

傳回

  • 承諾<字串>

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

getUserSettings()

Promise Chrome 91 以上版本 
chrome.action.getUserSettings(
  callback?: function,
)

傳回與擴充功能動作相關的使用者指定設定。

參數

傳回

  • Promise&lt;UserSettings&gt;

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

isEnabled()

Promise Chrome 110 以上版本 
chrome.action.isEnabled(
  tabId?: number,
  callback?: function,
)

指出是否為分頁啟用擴充功能動作 (如未提供 tabId，則設為全域)。僅使用 declarativeContent 啟用的動作一律會傳回 false。

參數

  • tabId

    編號 選填

    要查看其啟用狀態的分頁 ID。

  • 回呼

    函式 選用

    callback 參數如下所示： 

    (isEnabled: boolean) => void

    • isEnabled

      布林值

      如果已啟用額外資訊動作，則為「是」。

傳回

  • Promise&lt;boolean&gt;

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

openPopup()

Promise Chrome 127 以上版本 
chrome.action.openPopup(
  options?: OpenPopupOptions,
  callback?: function,
)

開啟擴充功能的彈出式視窗。在 Chrome 118 和 Chrome 126 之間，只有已安裝政策的擴充功能能夠提供這項權限。

參數

  • 選項

    OpenPopupOptions 選用

    指定開啟彈出式視窗的選項。

  • 回呼

    函式 選用

    callback 參數如下所示： 

    () => void

傳回

  • Promise&lt;void&gt;

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

setBadgeBackgroundColor()

Promise 
chrome.action.setBadgeBackgroundColor(
  details: object,
  callback?: function,
)

設定徽章的背景顏色。

參數

  • 詳細資料

    物件

    • 顏色

      string |ColorArray

      介於 [0,255] 範圍內的四個整數，構成徽章的 RGBA 顏色。例如，不透明紅色是 [255, 0, 0, 255]。可以是包含 CSS 值的字串，且不透明的紅色為 #FF0000 或 #F00。

    • tabId

      編號 選填

      限制在選取特定分頁的時機。會在分頁關閉時自動重設。

  • 回呼

    函式 選用

    callback 參數如下所示： 

    () => void

傳回

  • Promise&lt;void&gt;

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

setBadgeText()

Promise 
chrome.action.setBadgeText(
  details: object,
  callback?: function,
)

設定動作的徽章文字。徽章會顯示在圖示頂端。

參數

  • 詳細資料

    物件

    • tabId

      編號 選填

      限制在選取特定分頁的時機。會在分頁關閉時自動重設。

    • text

      string optional

      可以傳送任意數量的字元，但空間大約只有 4 個字元。如果傳遞空白字串 ('')，系統會清除徽章文字。如果指定 tabId 且 text 為空值，系統會清除指定分頁的文字，並預設為全域徽章文字。

  • 回呼

    函式 選用

    callback 參數如下所示： 

    () => void

傳回

  • Promise&lt;void&gt;

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

setBadgeTextColor()

Promise Chrome 110 以上版本 
chrome.action.setBadgeTextColor(
  details: object,
  callback?: function,
)

設定徽章的文字顏色。

參數

  • 詳細資料

    物件

    • 顏色

      string |ColorArray

      介於 [0,255] 範圍內的四個整數，構成徽章的 RGBA 顏色。例如，不透明紅色是 [255, 0, 0, 255]。可以是包含 CSS 值的字串，且不透明的紅色為 #FF0000 或 #F00。如未設定這個值，系統會自動選擇與徽章底色對比的顏色，以便顯示文字。Alpha 值相當於 0 的顏色不會設定，並且會傳回錯誤。

    • tabId

      編號 選填

      限制在選取特定分頁的時機。會在分頁關閉時自動重設。

  • 回呼

    函式 選用

    callback 參數如下所示： 

    () => void

傳回

  • Promise&lt;void&gt;

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

setIcon()

Promise 
chrome.action.setIcon(
  details: object,
  callback?: function,
)

設定動作的圖示。可以將圖示指定為圖片檔的路徑，或是畫布元素中的像素資料，或是圖示為其中一個項目的字典。必須指定 path 或 imageData 屬性。

參數

  • 詳細資料

    物件

    • 圖片資料

      ImageData |物件 optional

      ImageData 物件或字典 {size ->ImageData} 代表要設定的圖示。如果將圖示指定為字典，系統會根據螢幕像素密度選擇要使用的實際圖片。如果單一螢幕空間單位的圖片像素數量等於 scale，系統會選取大小為 scale * n 的圖片像素，其中 n 是使用者介面中的圖示尺寸。至少須指定一張圖片。請注意，「details.imageData = foo」相當於 'details.imageData = {'16': foo}'

    • 路徑

      string |物件 optional

      相對圖片路徑或字典 {size ->相對圖片路徑}，指向要設定的圖示。如果將圖示指定為字典，系統會根據螢幕像素密度選擇要使用的實際圖片。如果單一螢幕空間單位的圖片像素數量等於 scale，系統會選取大小為 scale * n 的圖片像素，其中 n 是使用者介面中的圖示尺寸。至少須指定一張圖片。請注意，「details.path = foo」相當於 'details.path = {'16': foo}'

    • tabId

      編號 選填

      限制在選取特定分頁的時機。會在分頁關閉時自動重設。

  • 回呼

    函式 選用

    callback 參數如下所示： 

    () => void

傳回

  • Promise&lt;void&gt;

    Chrome 96 以上版本

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

setPopup()

Promise 
chrome.action.setPopup(
  details: object,
  callback?: function,
)

設定當使用者按一下動作圖示時，要開啟彈出式視窗的 HTML 文件。

參數

  • 詳細資料

    物件

    • 彈出式訊息

      字串

      在彈出式視窗中顯示的 HTML 檔案的相對路徑。如果設為空字串 ('')，系統不會顯示彈出式視窗。

    • tabId

      編號 選填

      限制在選取特定分頁的時機。會在分頁關閉時自動重設。

  • 回呼

    函式 選用

    callback 參數如下所示： 

    () => void

傳回

  • Promise&lt;void&gt;

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

setTitle()

Promise 
chrome.action.setTitle(
  details: object,
  callback?: function,
)

設定動作的標題。這項資訊會顯示在工具提示中。

參數

  • 詳細資料

    物件

    • tabId

      編號 選填

      限制在選取特定分頁的時機。會在分頁關閉時自動重設。

    • title

      字串

      滑鼠遊標懸停時應顯示動作的字串。

  • 回呼

    函式 選用

    callback 參數如下所示： 

    () => void

傳回

  • Promise&lt;void&gt;

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

活動

onClicked

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

點按動作圖示時觸發。如果動作含有彈出式視窗，則不會觸發這個事件。

參數

  • 回呼

    函式

    callback 參數如下所示： 

    (tab: tabs.Tab) => void