chrome.action

説明

chrome.action API を使用して、Google Chrome ツールバーにある拡張機能のアイコンを制御します。

操作アイコンは、ブラウザのツールバーでアドレスバーの横に表示されます。インストールすると、拡張機能メニュー（パズルピース アイコン）に表示されます。ユーザーは拡張機能アイコンをツールバーに固定できます。

可用性

Chrome 88 以降 MV3 以降

マニフェスト

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

"action"

chrome.action API を使用するには、"manifest_version" として 3 を指定し、マニフェスト ファイルに "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 の各部

Icon

このアイコンは、拡張機能のツールバーのメイン画像であり、マニフェストの "action" キーの "default_icon" キーで設定されます。アイコンは、幅と高さが 16 のデバイス非依存ピクセル（DIP）である必要があります。

"default_icon" キーは、画像パスのサイズの辞書です。Chrome はこれらのアイコンを使用して、使用する画像スケールを選択します。完全一致が見つからない場合は、最も近いものが選択され、画像に合わせてスケーリングされます。このため、画質に影響する可能性があります。

1.5x や 1.2x など、あまり一般的でないスケーリング ファクタのデバイスは一般的になりつつあるため、アイコンには複数のサイズを指定することをおすすめします。これにより、アイコンの表示サイズが変更される可能性も拡張機能が維持されます。ただし、1 つのサイズのみを指定する場合は、辞書ではなく、1 つのアイコンへのパスを含む文字列に "default_icon" キーを設定することもできます。

action.setIcon() を呼び出して、プログラムで拡張機能のアイコンを設定することもできます。そのためには、別の画像パスを指定するか、HTML キャンバス要素（拡張機能 Service Worker から設定する場合はオフスクリーン キャンバス 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() を呼び出して、プログラムで設定することもできます。

スキルバッジ

アクションではオプションで「バッジ」を表示できます。バッジとは、アイコンの上に重ねて表示される短いテキストです。これにより、アクションを更新して、拡張機能の状態に関する少量の情報（カウンタなど）を表示できます。バッジにはテキスト コンポーネントと背景色があります。スペースが限られているため、バッジテキストは 4 文字以下にすることをおすすめします。

バッジを作成するには、action.setBadgeBackgroundColor() と action.setBadgeText() を呼び出して、プログラムでバッジを設定します。マニフェストにデフォルトのバッジ設定はありません。バッジの色の値は、バッジの RGBA カラーを構成する 0 ～ 255 の 4 つの整数の配列か、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 ピクセルにする必要があります。

ポップアップは、manifest.json ファイルの "action" キーの "default_popup" プロパティで初期設定されています。存在する場合、このプロパティは拡張機能ディレクトリ内の相対パスを指します。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 の例をインストールします。

ポップアップを表示する

ユーザーが拡張機能のアクションをクリックしたときに、拡張機能がポップアップを表示するのが一般的です。これを独自の拡張機能に実装するには、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

    boolean

    拡張機能のアクション アイコンをブラウザ ウィンドウの最上位のツールバーに表示するかどうか（拡張機能がユーザーによって「固定」されているかどうか）。

メソッド

disable()

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

タブの操作を無効にします。

パラメータ

  • tabId

    数値（省略可）

    アクションを変更するタブの ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • Promise<void>

    Promise は Manifest V3 以降でサポートされていますが、下位互換性のためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise はコールバックに渡された型と同じ型で解決されます。

enable()

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

タブのアクションを有効にします。デフォルトでは、アクションは有効になっています。

パラメータ

  • tabId

    数値（省略可）

    アクションを変更するタブの ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • Promise<void>

    Promise は Manifest V3 以降でサポートされていますが、下位互換性のためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise はコールバックに渡された型と同じ型で解決されます。

getBadgeBackgroundColor()

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

アクションの背景色を取得します。

パラメータ

  • 詳細

    TabDetails

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: ColorArray) => void

戻り値

  • Promise は Manifest V3 以降でサポートされていますが、下位互換性のためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise はコールバックに渡された型と同じ型で解決されます。

getBadgeText()

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

アクションのバッジテキストを取得します。タブが指定されていない場合は、タブに固有ではないバッジテキストが返されます。displayActionCountAsBadgeText が有効になっている場合は、declarativeNetRequestFeedback 権限が存在するか、タブ固有のバッジテキストが提供されない限り、プレースホルダ テキストが返されます。

パラメータ

  • 詳細

    TabDetails

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: string) => void

    • 件の結果

      string

戻り値

  • Promise<文字列>

    Promise は Manifest V3 以降でサポートされていますが、下位互換性のためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise はコールバックに渡された型と同じ型で解決されます。

getBadgeTextColor()

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

アクションのテキストの色を取得します。

パラメータ

  • 詳細

    TabDetails

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: ColorArray) => void

戻り値

  • Promise は Manifest V3 以降でサポートされていますが、下位互換性のためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise はコールバックに渡された型と同じ型で解決されます。

getPopup()

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

このアクションのポップアップとして設定された HTML ドキュメント セットを取得します。

パラメータ

  • 詳細

    TabDetails

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: string) => void

    • 件の結果

      string

戻り値

  • Promise<文字列>

    Promise は Manifest V3 以降でサポートされていますが、下位互換性のためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise はコールバックに渡された型と同じ型で解決されます。

getTitle()

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

アクションのタイトルを取得します。

パラメータ

  • 詳細

    TabDetails

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: string) => void

    • 件の結果

      string

戻り値

  • Promise<文字列>

    Promise は Manifest V3 以降でサポートされていますが、下位互換性のためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise はコールバックに渡された型と同じ型で解決されます。

getUserSettings()

Promise Chrome 91 以降 
chrome.action.getUserSettings(
  callback?: function,
)

拡張機能のアクションに関連するユーザー指定の設定を返します。

パラメータ

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (userSettings: UserSettings) => void

戻り値

  • Promise<UserSettings>

    Promise は Manifest V3 以降でサポートされていますが、下位互換性のためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise はコールバックに渡された型と同じ型で解決されます。

isEnabled()

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

拡張機能のアクションがタブに対して有効になっているかどうか（tabId が指定されていない場合はグローバルに有効）を示します。declarativeContent のみを使用して有効にしたアクションは常に false を返します。

パラメータ

  • tabId

    数値（省略可）

    有効ステータスを確認するタブの ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (isEnabled: boolean) => void

    • isEnabled

      boolean

      拡張機能のアクションが有効な場合は true。

戻り値

  • Promise<boolean>

    Promise は Manifest V3 以降でサポートされていますが、下位互換性のためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise はコールバックに渡された型と同じ型で解決されます。

openPopup()

Promise 保留中
chrome.action.openPopup(
  options?: OpenPopupOptions,
  callback?: function,
)

拡張機能のポップアップを開きます。Chrome 118 ～ Chrome 126 では、このポリシーはインストール済みの拡張機能に対してのみ有効です。

パラメータ

  • オプション

    OpenPopupOptions（省略可）

    ポップアップを開くオプションを指定します。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • Promise<void>

    Promise は Manifest V3 以降でサポートされていますが、下位互換性のためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise はコールバックに渡された型と同じ型で解決されます。

setBadgeBackgroundColor()

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

バッジの背景色を設定します。

パラメータ

  • 詳細

    オブジェクト

    • color

      文字列 | ColorArray

      バッジの RGBA カラーを構成する [0,255] の範囲の 4 つの整数の配列。たとえば、不透明な赤は [255, 0, 0, 255] です。CSS 値を含む文字列にすることもできます（不透明な赤は #FF0000 または #F00）。

    • tabId

      数値（省略可）

      特定のタブが選択されている場合のみ変更を制限します。タブを閉じると、自動的にリセットされます。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • Promise<void>

    Promise は Manifest V3 以降でサポートされていますが、下位互換性のためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise はコールバックに渡された型と同じ型で解決されます。

setBadgeText()

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

アクションのバッジテキストを設定します。バッジはアイコンの上に表示されます。

パラメータ

  • 詳細

    オブジェクト

    • tabId

      数値（省略可）

      特定のタブが選択されている場合のみ変更を制限します。タブを閉じると、自動的にリセットされます。

    • 指定しています

      文字列（省略可）

      任意の数の文字を渡すことができますが、スペースに収まるのは約 4 文字のみです。空の文字列（''）が渡されると、バッジのテキストは消去されます。tabId が指定され、text が null の場合、指定したタブのテキストはクリアされ、デフォルトでグローバル バッジテキストに設定されます。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • Promise<void>

    Promise は Manifest V3 以降でサポートされていますが、下位互換性のためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise はコールバックに渡された型と同じ型で解決されます。

setBadgeTextColor()

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

バッジのテキストの色を設定します。

パラメータ

  • 詳細

    オブジェクト

    • color

      文字列 | ColorArray

      バッジの RGBA カラーを構成する [0,255] の範囲の 4 つの整数の配列。たとえば、不透明な赤は [255, 0, 0, 255] です。CSS 値を含む文字列にすることもできます（不透明な赤は #FF0000 または #F00）。この値を設定しない場合、バッジの背景色と対照的な色が自動的に選択され、テキストが見えます。アルファ値が 0 に相当する色は設定されず、エラーが返されます。

    • tabId

      数値（省略可）

      特定のタブが選択されている場合のみ変更を制限します。タブを閉じると、自動的にリセットされます。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • Promise<void>

    Promise は Manifest V3 以降でサポートされていますが、下位互換性のためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise はコールバックに渡された型と同じ型で解決されます。

setIcon()

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

アクションのアイコンを設定します。アイコンは、画像ファイルへのパス、キャンバス要素のピクセルデータ、またはいずれかの辞書として指定できます。path プロパティまたは imageData プロパティのいずれかを指定する必要があります。

パラメータ

  • 詳細

    オブジェクト

    • imageData

      ImageData | オブジェクト（省略可）

      ImageData オブジェクトまたは設定するアイコンを表す辞書 {size -> ImageData} のいずれか。アイコンを辞書として指定すると、画面のピクセル密度に応じて実際に使用される画像が選択されます。1 つの画面スペース ユニットに収まる画像ピクセル数が scale の場合、scale × n のサイズの画像が選択されます。n は UI のアイコンのサイズです。画像を少なくとも 1 つ指定する必要があります。'details.imageData = foo' は 'details.imageData = {'16': foo}' と同等です。

    • パス

      文字列 | オブジェクト 省略可

      相対画像パスまたは設定するアイコンを指す辞書 {size ->相対画像パス} のいずれかです。アイコンを辞書として指定すると、画面のピクセル密度に応じて実際に使用される画像が選択されます。1 つの画面スペース ユニットに収まる画像ピクセル数が scale の場合、scale × n のサイズの画像が選択されます。n は UI のアイコンのサイズです。画像を少なくとも 1 つ指定する必要があります。'details.path = foo' は 'details.path = {'16': foo}' と同等です。

    • tabId

      数値（省略可）

      特定のタブが選択されている場合のみ変更を制限します。タブを閉じると、自動的にリセットされます。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • Promise<void>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、下位互換性のためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise はコールバックに渡された型と同じ型で解決されます。

setPopup()

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

ユーザーがアクションのアイコンをクリックしたときにポップアップとして開くよう HTML ドキュメントを設定します。

パラメータ

  • 詳細

    オブジェクト

    • ポップアップ

      string

      ポップアップに表示する HTML ファイルへの相対パス。空の文字列（''）に設定すると、ポップアップは表示されません。

    • tabId

      数値（省略可）

      特定のタブが選択されている場合のみ変更を制限します。タブを閉じると、自動的にリセットされます。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • Promise<void>

    Promise は Manifest V3 以降でサポートされていますが、下位互換性のためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise はコールバックに渡された型と同じ型で解決されます。

setTitle()

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

アクションのタイトルを設定します。これはツールチップに表示されます。

パラメータ

  • 詳細

    オブジェクト

    • tabId

      数値（省略可）

      特定のタブが選択されている場合のみ変更を制限します。タブを閉じると、自動的にリセットされます。

    • 役職

      string

      マウスオーバー時にアクションが表示する文字列。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • Promise<void>

    Promise は Manifest V3 以降でサポートされていますが、下位互換性のためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise はコールバックに渡された型と同じ型で解決されます。

イベント

onClicked

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

アクション アイコンがクリックされたときに呼び出されます。アクションにポップアップがある場合、このイベントは起動しません。

パラメータ

  • callback

    機能

    callback パラメータは次のようになります。 

    (tab: tabs.Tab) => void