chrome.omnibox

Description

L'API omnibox vous permet d'enregistrer un mot clé dans la barre d'adresse de Google Chrome, également appelée "omnibox".

Capture d'écran montrant des suggestions liées au mot clé "Recherche Chromium"

Lorsque l'internaute saisit le mot clé de votre extension, il n'interagit qu'avec votre . Chaque frappe est envoyée à votre extension, et vous pouvez fournir des suggestions en réponse.

Les suggestions peuvent être enrichies de différentes manières. Lorsque l'utilisateur accepte une suggestion, votre extension en est informée et peut prendre des mesures.

Fichier manifeste

Vous devez inclure un champ omnibox keyword dans le fichier manifeste pour utiliser l'API de l'omnibox. Toi doit également spécifier une icône de 16 x 16 pixels, qui s'affichera dans la barre d'adresse lors de la suggestion que les utilisateurs passent en mode mot clé.

Exemple :

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

Exemples

Pour essayer cette API, installez l'exemple d'API omnibox à partir de chrome-extension-samples. un dépôt de clés.

Types

DefaultSuggestResult

Résultat de suggestion.

Propriétés

  • description

    chaîne

    Texte affiché dans le menu déroulant de l'URL. Peut contenir un balisage de style XML pour les styles. Les balises acceptées sont "url" (pour une URL littérale), 'match' (correspondance) (pour mettre en surbrillance le texte correspondant à la requête de l'utilisateur) et "assombrir" (pour le texte d'aide sombre). Les styles peuvent être imbriqués, par exemple est grisée.

DescriptionStyleType

Chrome (version 44 ou ultérieure)

Type de style.

Énumération

"url"

"match"

"dim"

OnInputEnteredDisposition

Chrome (version 44 ou ultérieure)

Disposition de la fenêtre pour la requête de l'omnibox. Il s'agit du contexte recommandé pour afficher les résultats. Par exemple, si la commande de l'omnibox permet d'accéder à une URL spécifique, une disposition de "newForegroundTab" signifie que la navigation doit avoir lieu dans un nouvel onglet sélectionné.

Énumération

"currentTab"

"newForegroundTab"

"newBackgroundTab"

SuggestResult

Résultat de suggestion.

Propriétés

  • contenu

    chaîne

    Texte placé dans la barre d'adresse et envoyé à l'extension lorsque l'utilisateur sélectionne cette entrée.

  • supprimable

    Booléen facultatif

    Chrome (version 63 ou ultérieure)

    Indique si le résultat de la suggestion peut être supprimé par l'utilisateur.

  • description

    chaîne

    Texte affiché dans le menu déroulant de l'URL. Peut contenir un balisage de style XML pour les styles. Les balises acceptées sont "url" (pour une URL littérale), 'match' (correspondance) (pour mettre en surbrillance le texte correspondant à la requête de l'utilisateur) et "assombrir" (pour le texte d'aide sombre). Les styles peuvent être imbriqués, par exemple est grisée. Vous devez échapper les cinq entités prédéfinies pour les afficher sous forme de texte: stackoverflow.com/a/1091953/89484

Méthodes

setDefaultSuggestion()

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

Définit la description et le style de la suggestion par défaut. La suggestion par défaut est le texte qui s'affiche dans la première ligne de suggestion sous la barre d'adresse.

Paramètres

  • Objet SuggérerResult partiel, sans le "contenu" .

  • rappel

    function facultatif

    Chrome 100 et versions ultérieures

    Le paramètre callback se présente comme suit: 

    () => void

Renvoie

  • Promesse<void>

    Chrome 100 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

Événements

onDeleteSuggestion

Chrome (version 63 ou ultérieure) 
chrome.omnibox.onDeleteSuggestion.addListener(
  callback: function,
)

L'utilisateur a supprimé un résultat suggéré.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (text: string) => void

    • texte

      chaîne

onInputCancelled

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

L'utilisateur a mis fin à la session de saisie de mots clés sans accepter la saisie.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    () => void

onInputChanged

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

L'utilisateur a modifié les données saisies dans l'omnibox.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

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

    • texte

      chaîne

    • suggest

      fonction

      Le paramètre suggest se présente comme suit: 

      (suggestResults: SuggestResult[]) => void

      • suggestResults

        SuggestResult[]

        Tableau de résultats suggérés

onInputEntered

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

L'utilisateur a accepté les termes saisis dans l'omnibox.

Paramètres

onInputStarted

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

L'utilisateur a démarré une session de saisie de mots clés en saisissant le mot clé de l'extension. Cet envoi est garanti une fois par session d'entrée et avant tout événement onInputChanged.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    () => void