アクションを実装する

アクションとは、ユーザーがツールバー アイコン（通常は拡張機能のアクション アイコン）をクリックしたときに発生する動作のことです。アクションが Action API を使用して拡張機能の機能を呼び出すか、ポップアップを開きます。このページでは、拡張機能の機能を呼び出す方法について説明します。ポップアップを使用するには、ポップアップを追加するをご覧ください。

アクションを登録する

browser.action API を使用するには、拡張機能のマニフェスト ファイルに "action" キーを追加します。このフィールドの省略可能なプロパティの詳細については、browser.action API リファレンスのマニフェスト セクションをご覧ください。

manifest.json:

{
  "name": "My Awesome action Extension",
 ...
  "action": {
   ...
  }
 ...
}

アクションに対応する

ユーザーがアクション アイコンをクリックしたときに onClicked ハンドラを登録します。ポップアップが manifest.json ファイルに登録されている場合、このイベントはトリガーされません。

service-worker.js:

browser.action.onClicked.addListener((tab) => {
  browser.action.setTitle({
    tabId: tab.id,
    title: `You are on tab: ${tab.id}`});
});

条件付きでアクションを有効にする

browser.declarativeContent API を使用すると、ページ URL に基づいて、または CSS セレクタがページの要素と一致したときに、拡張機能のアクション アイコンを有効にできます。拡張機能のアクション アイコンが無効になっている場合、アイコンはグレー表示になります。ユーザーが無効なアイコンをクリックすると、拡張機能のコンテキスト メニューが表示されます。

無効なアクション アイコン
無効なアクション アイコン。

アクション バッジ

バッジは、拡張機能の状態やユーザーによる操作が必要なことを示すために、アクション アイコンの上に配置される書式設定されたテキストです。これを実証するために、Drink Water サンプルでは、アラームが正常に設定されたことを示す「ON」というバッジが表示され、拡張機能がアイドル状態のときは何も表示されません。バッジには最大 4 文字まで入力できます。

バッジなしとバッジありの拡張機能アイコン。
バッジ付き（左）とバッジなし（右）の拡張機能アイコン。

バッジのテキストは browser.action.setBadgeText() を呼び出して設定し、背景色は browser.action.setBadgeBackgroundColor() を呼び出して設定します。

service-worker.js:

browser.action.setBadgeText({text: 'ON'});
browser.action.setBadgeBackgroundColor({color: '#4688F1'});

ツールチップ

manifest.json ファイルの "action" キーの "default_title" フィールドにツールチップを登録します。

manifest.json:

{
  "name": "Tab Flipper",
 ...
  "action": {
    "default_title": "Press Ctrl(Win)/Command(Mac)+Shift+Right/Left to flip tabs"
  }
...
}

action.setTitle() を呼び出して、ツールチップを設定または更新することもできます。ツールチップが設定されていない場合、拡張機能の名前が表示されます。