このページは Cloud Translation API によって翻訳されました。

chrome.commands

説明

Command API を使用すると、拡張機能での操作（ブラウザの操作を開く操作や拡張機能にコマンドを送信する操作など）をトリガーするキーボードショートカットを追加できます。

マニフェスト

この API を使用するには、次のキーをマニフェストで宣言する必要があります。

"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（macOS では Option）、Shift、MacCtrl（macOS のみ）、Command（macOS のみ）、Search（ChromeOS のみ）

注: Tab は、ユーザー補助の理由から Chrome 33 でサポートされているキーのリストから削除されました。

キーの組み合わせの要件

拡張機能コマンドのショートカットには、Ctrl または Alt のいずれかを含める必要があります。
- 修飾子はメディアキーと組み合わせて使用することはできません。
macOS では、Ctrl は自動的に Command に変換されます。
- macOS で Control キーを使用するには、"mac" を定義するときに Ctrl を MacCtrl に置き換えます。できます。
- 別のプラットフォームの組み合わせで MacCtrl を使用すると、検証エラーが発生し、拡張機能はインストールされません。
Shift は、すべてのプラットフォームでオプションの修飾子です。
Search は ChromeOS 専用の修飾子です（省略可）。
特定のオペレーティングシステムや Chrome のショートカット（ウィンドウ管理など）は、常に優先されます拡張機能コマンドのショートカットです。上書きはできません。

で確認できます。

注: キーとの競合を避けるため、Ctrl+Alt を含むキーの組み合わせは許可されません。 AltGr キー。

コマンドイベントの処理

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"
      }
    }
  },
  ...
}

Service Worker では、マニフェストで定義された各コマンドにハンドラをバインドできます。 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 イベントを発生させます。

ポップアップが開くことに基づいて対応が必要な場合は、 DOMContentLoaded イベントを実装する必要があります。

範囲

デフォルトでは、コマンドのスコープは Chrome ブラウザです。つまりブラウザがコマンドショートカットは無効です。Chrome 35 以降、拡張機能のデベロッパーは必要に応じて、コマンドを「global」とマークします。Chrome にフォーカスがないときも、グローバルコマンドを使用できます。

グローバルコマンドでのキーボードショートカットの候補は Ctrl+Shift+[0..9] に制限されています。これは他のアプリケーションでショートカットがオーバーライドされるリスクをたとえば、Alt+P はグローバル（印刷ダイアログを開くためのキーボードショートカット）として許可されていました。他のアプリケーションでは動作しない場合があります。

エンドユーザーは、公開されている UI を使用して、グローバルコマンドを好みのキーの組み合わせに自由に再マッピングできます。 chrome://extensions/shortcuts です。

例:

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 番目の拡張機能のショートカットが想定どおりに登録されません。より堅牢なエンドユーザーをこの可能性を予測し、インストール時の競合を確認することで、ユーザーエクスペリエンスを向上できます。

注:_execute_action はリストに表示されません。 commands.getAll() から返されるコマンドの数。

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

プロパティ

description

文字列（省略可）

拡張コマンドの説明
name

文字列（省略可）

拡張機能コマンドの名前
ショートカット

文字列（省略可）

このコマンドで有効なショートカットです。有効になっていない場合は空白になります。

メソッド

getAll()

<ph type="x-smartling-placeholder"></ph> 約束

chrome.commands.getAll(
  callback?: function,
)

この拡張機能に登録されているすべての拡張機能コマンドとそのショートカット（有効な場合）を返します。Chrome 110 より前では、このコマンドは _execute_action を返しませんでした。

パラメータ

callback

関数（省略可）

callback パラメータは次のようになります。
```
(commands: Command[]) => void
```
- commands
  
  コマンド

戻り値

Promise<コマンド[]>

Chrome 96 以降

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

イベント

onCommand

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

登録済みのコマンドがキーボードショートカットを使用して有効化されたときに呼び出されます。

パラメータ

callback

関数

callback パラメータは次のようになります。
```
(command: string, tab?: tabs.Tab) => void
```
- command
  
  文字列
- タブ
  
  tabs.Tab オプション

chrome.commands

説明

マニフェスト

用途

サポートされているキー

キーの組み合わせの要件

コマンド イベントの処理

アクション コマンド

範囲

例

基本コマンド

アクション コマンド

登録されたコマンドを確認する

型

Command

プロパティ

メソッド

getAll()

パラメータ

戻り値

イベント

onCommand

パラメータ

コマンドイベントの処理

アクションコマンド

アクションコマンド