chrome.omnibox

説明

アドレスバー API を使用すると、Google Chrome のアドレスバーにキーワードを登録できます。アドレスバーはアドレスバーとも呼ばれます。

キーワード「Chromium 検索」に関連する候補を示すスクリーンショット

ユーザーが拡張機能のキーワードを入力すると、拡張機能のみの操作を開始する。 あります。キー入力はそれぞれ拡張機能に送信され、ユーザーはそれに対する候補を提示できます。

候補は、さまざまな方法で豊富な形式にできます。ユーザーが候補を承認すると 拡張機能が通知を受け、処理される可能性があります。

マニフェスト

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

"omnibox"

アドレスバー API を使用するには、マニフェストに "omnibox.keyword" フィールドを含める必要があります。マイページ では、16×16 ピクセルのアイコンも指定する必要があります。このアイコンは、提案時にアドレスバーに表示されます。 キーワードモードに移行できます

例:

{
  "name": "Aaron's omnibox extension",
  "version": "1.0",
  "omnibox": { "keyword" : "aaron" },
  "icons": {
    "16": "16-full-color.png"
  },
  "background": {
    "persistent": false,
    "scripts": ["background.js"]
  }
}

例

この API を試すには、chrome-extension-samples から omnibox API の例をインストールしてください。 できます。

型

DefaultSuggestResult

候補の結果。

プロパティ

  • description

    文字列

    URL のプルダウンに表示されるテキスト。スタイル設定用の XML スタイルのマークアップを含めることができます。サポートされているタグは「url」です。（リテラル URL の場合）、'match'（ユーザーのクエリに一致するテキストをハイライト表示）、「dim」（薄いヘルプテキストの場合）を使用します。スタイルはネストできます（例:グレー表示になります。

DescriptionStyleType

Chrome 44 以降

スタイルタイプ。

列挙型

"url"

"match"

「暗め」

OnInputEnteredDisposition

Chrome 44 以降

アドレスバー クエリのウィンドウ処理。結果を表示する際に推奨されるコンテキストです。たとえば、アドレスバー コマンドで特定の URL に移動する場合、「newForegroundTab」の処理はは、ナビゲーションが新しく選択されたタブで行われることを意味します。

列挙型

"currentTab"

"newForegroundTab"

"newBackgroundTab"

SuggestResult

候補の結果。

プロパティ

  • コンテンツ

    文字列

    ユーザーがこのエントリを選択したときに拡張機能に送信される、URL バーに表示されるテキスト。

  • 削除可能

    ブール値（省略可）

    Chrome 63 以降

    ユーザーが提案結果を削除できるかどうか。

  • description

    文字列

    URL のプルダウンに表示されるテキスト。スタイル設定用の XML スタイルのマークアップを含めることができます。サポートされているタグは「url」です。（リテラル URL の場合）、'match'（ユーザーのクエリに一致するテキストをハイライト表示）、「dim」（薄いヘルプテキストの場合）を使用します。スタイルはネストできます（例:グレー表示になります。テキストとして表示するには、事前定義された 5 つのエンティティをエスケープする必要があります。stackoverflow.com/a/1091953/89484

メソッド

setDefaultSuggestion()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.omnibox.setDefaultSuggestion(
  suggestion: DefaultSuggestResult,
  callback?: function,
)

デフォルトの候補の説明とスタイルを設定します。デフォルトの候補は、URL バーの下の最初の候補行に表示されるテキストです。

パラメータ

  • 「content」のない部分的な SuggestedResult オブジェクトパラメータを指定します。

  • callback

    関数（省略可）

    Chrome 100 以降

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

    () => void

戻り値

  • 約束 <void>

    Chrome 100 以降

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

イベント

onDeleteSuggestion

Chrome 63 以降 
chrome.omnibox.onDeleteSuggestion.addListener(
  callback: function,
)

ユーザーが候補の結果を削除しました。

パラメータ

  • callback

    関数

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

    (text: string) => void

    • テキスト

      文字列

onInputCancelled

chrome.omnibox.onInputCancelled.addListener(
  callback: function,
)

ユーザーが入力を承認せずに、キーワード入力セッションを終了しました。

パラメータ

  • callback

    関数

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

    () => void

onInputChanged

chrome.omnibox.onInputChanged.addListener(
  callback: function,
)

ユーザーがアドレスバーに入力する内容を変更しました。

パラメータ

  • callback

    関数

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

    (text: string, suggest: function) => void

    • テキスト

      文字列

    • suggest

      関数

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

      (suggestResults: SuggestResult[]) => void

onInputEntered

chrome.omnibox.onInputEntered.addListener(
  callback: function,
)

ユーザーがアドレスバーに入力された内容を承認しました。

パラメータ

onInputStarted

chrome.omnibox.onInputStarted.addListener(
  callback: function,
)

ユーザーが拡張機能のキーワードを入力して、キーワード入力セッションを開始しました。これは、入力セッションごとに 1 回だけ、onInputChanged イベントの前に送信されることが保証されます。

パラメータ

  • callback

    関数

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

    () => void