chrome.commands

説明

マニフェスト

コンセプトと使用方法

Commands API を使用すると、拡張機能のデベロッパーは特定のコマンドを定義し、デフォルトのキーの組み合わせにバインドできます。拡張機能が受け入れる各コマンドは、拡張機能のマニフェストの "commands" オブジェクトのプロパティとして宣言する必要があります。

プロパティ キーはコマンド名として使用されます。コマンド オブジェクトは 2 つのプロパティを受け取ることができます。

suggested_key

コマンドのデフォルトのキーボード ショートカットを宣言するプロパティ（省略可）。省略した場合、コマンドはバインド解除されます。このプロパティには、文字列またはオブジェクトの値を指定できます。

• 文字列値は、すべてのプラットフォームで使用されるデフォルトのキーボード ショートカットを指定します。

• オブジェクト値を使用すると、拡張機能のデベロッパーはプラットフォームごとにキーボード ショートカットをカスタマイズできます。プラットフォーム固有のショートカットを指定する場合、有効なオブジェクト プロパティは default、chromeos、linux、mac、windows です。

詳しくは、キーの組み合わせの要件をご覧ください。

description

コマンドの目的をユーザーに簡単に説明するために使用される文字列。この文字列は、拡張機能のキーボード ショートカット管理 UI に表示されます。説明は標準コマンドでは必須ですが、アクション コマンドでは無視されます。

拡張機能には多くのコマンドを設定できますが、推奨されるキーボード ショートカットは最大 4 つまで指定できます。ユーザーは chrome://extensions/shortcuts ダイアログから手動でショートカットを追加できます。

サポートされているキー

次のキーは、使用可能なコマンド ショートカットです。キーの定義では大文字と小文字が区別されます。キーのケースが正しくない拡張機能を読み込もうとすると、インストール時にマニフェストの解析エラーが発生します。

アルファ版キー

A … Z

数字キー

0 … 9

標準キー文字列

全般 - Comma、Period、Home、End、PageUp、PageDown、Space、Insert、Delete

矢印キー - Up、Down、Left、Right

メディアキー - MediaNextTrack、MediaPlayPause、MediaPrevTrack、MediaStop

修飾キー文字列

Ctrl、Alt、Shift、MacCtrl（macOS のみ）、Command（macOS のみ）、Search（ChromeOS のみ）

キーの組み合わせの要件

• 拡張機能コマンドのショートカットには、Ctrl または Alt のいずれかを含める必要があります。

  • 修飾子はメディアキーと組み合わせて使用することはできません。

  • 多くの macOS キーボードでは、Alt は Option キーを指します。

  • macOS では、Ctrl または Alt の代わりに Command または MacCtrl を使用することもできます（次の箇条書きを参照）。

• macOS では、Ctrl は自動的に Command に変換されます。

  • Command は、"mac" ショートカットで 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`);
});

登録済みのコマンドを確認する

別の拡張機能ですでに使用されているショートカットを拡張機能が登録しようとすると、2 つ目の拡張機能のショートカットは想定どおりに登録されません。この可能性を予測し、インストール時に競合をチェックすることで、より堅牢なエンドユーザー エクスペリエンスを提供できます。

service-worker.js:

chrome.runtime.onInstalled.addListener((details) => {
  if (details.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.
    }
  });
}

chrome.commands.getAll(): Promise<Command[]>

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