chrome.commands

說明

使用 Commands API 新增鍵盤快速鍵，在擴充功能中觸發動作，例如開啟瀏覽器動作或傳送指令給擴充功能。

資訊清單

如要使用這項 API，必須在資訊清單中宣告下列鍵。

"commands"

用量

擴充功能開發人員可透過 Commands API 定義特定指令，並將這些指令繫結至預設的按鍵組合。擴充功能接受的每個指令都必須在擴充功能資訊清單中，宣告為 "commands" 物件的屬性。

屬性鍵會做為指令名稱。指令物件可以採用兩項屬性。

suggested_key

選用屬性，用於宣告指令的預設鍵盤快速鍵。如果省略，指令就會取消繫結。這個屬性可以採用字串或物件值。

  • 字串值：指定應在所有平台使用的預設鍵盤快速鍵。

  • 物件值可讓擴充功能開發人員自訂各平台的鍵盤快速鍵。提供平台專屬快速鍵時，有效物件屬性為 default、chromeos、linux、mac 和 windows。

詳情請參閱「按鍵組合規定」。

description

這個字串會向使用者簡短說明指令用途。這個字串會顯示在擴充功能鍵盤快速鍵管理 UI 中。標準指令必須提供說明，但動作指令會忽略說明。

擴充功能可以有多個指令，但最多只能指定四個建議的鍵盤快速鍵。使用者可以透過 chrome://extensions/shortcuts 對話方塊手動新增更多快速鍵。

支援的鍵

下列按鍵可用於指令快速鍵。金鑰定義須區分大小寫。如果嘗試載入金鑰大小寫不正確的擴充功能，安裝時就會發生資訊清單剖析錯誤。

Alpha 鍵
A … Z
數字鍵
0 … 9
標準金鑰字串

一般：Comma、Period、Home、End、PageUp、PageDown、Space、Insert、Delete

方向鍵：Up、Down、Left、Right

媒體鍵：MediaNextTrack、MediaPlayPause、MediaPrevTrack、MediaStop

輔助鍵字串

Ctrl、Alt (macOS 上的 Option)、Shift、MacCtrl (僅限 macOS)、Command (僅限 macOS)、Search (僅限 ChromeOS)

按鍵組合需求

  • 擴充功能指令快速鍵必須包含 Ctrl 或 Alt。

    • 修飾鍵無法與媒體鍵搭配使用。

  • 在 macOS 中，Ctrl 會自動轉換為 Command。

    • 如要在 macOS 上使用 Control 鍵，請定義 "mac" 快速鍵時，將 Ctrl 換成 MacCtrl。

    • 如果將 MacCtrl 用於其他平台的組合，就會導致驗證錯誤，且無法安裝擴充功能。

  • Shift 是所有平台上的選用修飾符。

  • Search 是 ChromeOS 專用的選用修飾鍵。

  • 某些作業系統和 Chrome 快速鍵 (例如視窗管理) 一律會優先於擴充功能指令快速鍵，且無法覆寫。

處理指令事件

manifest.json:

{
  "name": "My extension",
  ...
  "commands": {
    "run-foo": {
      "suggested_key": {
        "default": "Ctrl+Shift+Y",
        "mac": "Command+Shift+Y"
      },
      "description": "Run \"foo\" on the current page."
    },
    "_execute_action": {
      "suggested_key": {
        "windows": "Ctrl+Shift+Y",
        "mac": "Command+Shift+Y",
        "chromeos": "Ctrl+Shift+U",
        "linux": "Ctrl+Shift+J"
      }
    }
  },
  ...
}

在服務工作人員中，您可以使用 onCommand.addListener，將處理常式繫結至資訊清單中定義的每個指令。例如：

service-worker.js：

chrome.commands.onCommand.addListener((command) => {
  console.log(`Command: ${command}`);
});

動作指令

_execute_action (Manifest V3)、_execute_browser_action (Manifest V2) 和 _execute_page_action (Manifest V2) 指令分別保留給觸發動作、瀏覽器動作或頁面動作。這些指令不會像標準指令一樣，傳送 command.onCommand 事件。

如果需要根據彈出式視窗的開啟動作採取行動，請考慮在彈出式視窗的 JavaScript 中監聽 DOMContentLoaded 事件。

範圍

根據預設，指令的範圍僅限於 Chrome 瀏覽器。也就是說，瀏覽器未處於焦點時，指令快速鍵會停用。從 Chrome 35 開始，擴充功能開發人員可以選擇將指令標示為「全域」。即使 Chrome 未處於焦點狀態，全域指令也能運作。

全域指令的鍵盤快速鍵建議僅限 Ctrl+Shift+[0..9]。這項保護措施可盡量避免覆寫其他應用程式的快速鍵，因為舉例來說，如果允許 Alt+P 做為全域快速鍵，開啟列印對話方塊的鍵盤快速鍵可能無法在其他應用程式中運作。

使用者可以透過 chrome://extensions/shortcuts 顯示的 UI，將全域指令重新對應至偏好的按鍵組合。

範例：

manifest.json:

{
  "name": "My extension",
  ...
  "commands": {
    "toggle-feature-foo": {
      "suggested_key": {
        "default": "Ctrl+Shift+5"
      },
      "description": "Toggle feature foo",
      "global": true
    }
  },
  ...
}

範例

下列範例會運用 Commands API 的核心功能。

基本指令

擴充功能可透過指令將邏輯對應至使用者可叫用的鍵盤快速鍵。最基本的指令只需要擴充功能資訊清單中的指令宣告，以及接聽程式註冊，如下列範例所示。

manifest.json:

{
  "name": "Command demo - basic",
  "version": "1.0",
  "manifest_version": 3,
  "background": {
    "service_worker": "service-worker.js"
  },
  "commands": {
    "inject-script": {
      "suggested_key": "Ctrl+Shift+Y",
      "description": "Inject a script on the page"
    }
  }
}

service-worker.js：

chrome.commands.onCommand.addListener((command) => {
  console.log(`Command "${command}" triggered`);
});

動作指令

如「使用方式」一節所述，您也可以將指令對應至擴充功能的動作。在下列範例中，使用者點選擴充功能的動作或觸發鍵盤快速鍵時，系統會插入內容指令碼，在目前網頁上顯示快訊。

manifest.json:

{
  "name": "Commands demo - action invocation",
  "version": "1.0",
  "manifest_version": 3,
  "background": {
    "service_worker": "service-worker.js"
  },
  "permissions": ["activeTab", "scripting"],
  "action": {},
  "commands": {
    "_execute_action": {
      "suggested_key": {
        "default": "Ctrl+U",
        "mac": "Command+U"
      }
    }
  }
}

service-worker.js：

chrome.action.onClicked.addListener((tab) => {
  chrome.scripting.executeScript({
    target: {tabId: tab.id},
    func: contentScriptFunc,
    args: ['action'],
  });
});

function contentScriptFunc(name) {
  alert(`"${name}" executed`);
}

// This callback WILL NOT be called for "_execute_action"
chrome.commands.onCommand.addListener((command) => {
  console.log(`Command "${command}" called`);
});

驗證已註冊的指令

如果擴充功能嘗試註冊的快速鍵已由其他擴充功能使用，第二個擴充功能的快速鍵將無法如預期註冊。您可以預期這種情況，並在安裝時檢查是否發生衝突，進而提供更穩定的使用者體驗。

service-worker.js：

chrome.runtime.onInstalled.addListener((reason) => {
  if (reason === chrome.runtime.OnInstalledReason.INSTALL) {
    checkCommandShortcuts();
  }
});

// Only use this function during the initial install phase. After
// installation the user may have intentionally unassigned commands.
function checkCommandShortcuts() {
  chrome.commands.getAll((commands) => {
    let missingShortcuts = [];

    for (let {name, shortcut} of commands) {
      if (shortcut === '') {
        missingShortcuts.push(name);
      }
    }

    if (missingShortcuts.length > 0) {
      // Update the extension UI to inform the user that one or more
      // commands are currently unassigned.
    }
  });
}

類型

Command

屬性

  • 說明

    字串 選填

    擴充功能指令說明

  • 名稱

    字串 選填

    擴充功能指令的名稱

  • 捷徑

    字串 選填

    這個指令目前使用的快速鍵，如果沒有，則為空白。

方法

getAll()

Promise 
chrome.commands.getAll(
  callback?: function,
): Promise<Command[]>

傳回這個擴充功能的所有已註冊擴充功能指令，以及這些指令的快速鍵 (如有啟用)。在 Chrome 110 之前的版本中，這項指令不會傳回 _execute_action。

參數

  • callback

    函式 選用

    callback 參數如下： 

    (commands: Command[]) => void

傳回

  • Promise<Command[]>

    Chrome 96 以上版本

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

事件

onCommand

chrome.commands.onCommand.addListener(
  callback: function,
)

使用鍵盤快速鍵啟動已註冊的指令時觸發。

參數

  • callback

    函式

    callback 參數如下： 

    (command: string, tab?: tabs.Tab) => void