Vernieuwingsdatum: 2026-09-25 robots: noindex
Beschrijving
Met de omnibox API kun je een zoekwoord registreren in de adresbalk van Google Chrome, ook wel bekend als de omnibox.
Wanneer de gebruiker het trefwoord van uw extensie invoert, begint de interactie uitsluitend met uw extensie. Elke toetsaanslag wordt naar uw extensie verzonden en u kunt daarop suggesties geven.
De suggesties kunnen op diverse manieren rijk geformatteerd worden. Wanneer de gebruiker een suggestie accepteert, wordt uw extensie hiervan op de hoogte gesteld en kan deze actie ondernemen.
Manifest
Om de Omnibox API te kunnen gebruiken, moet u een veld keyword omnibox in het manifest opnemen. U dient ook een pictogram van 16x16 pixels op te geven, dat in de adresbalk wordt weergegeven wanneer gebruikers worden aangeraden de trefwoordmodus te openen.
Bijvoorbeeld:
{
"name": "Aaron's omnibox extension",
"version": "1.0",
"omnibox": { "keyword" : "aaron" },
"icons": {
"16": "16-full-color.png"
},
"background": {
"persistent": false,
"scripts": ["background.js"]
}
}
Voorbeelden
Om deze API uit te proberen, installeer je het Omnibox API-voorbeeld uit de chrome-extension-samples repository.
Soorten
DefaultSuggestResult
Een suggestie voor een resultaat.
Eigenschappen
- beschrijving
snaar
De tekst die wordt weergegeven in het URL-dropdownmenu. Kan XML-achtige opmaak bevatten voor styling. De ondersteunde tags zijn 'url' (voor een letterlijke URL), 'match' (voor het markeren van tekst die overeenkomt met de zoekopdracht van de gebruiker) en 'dim' (voor gedimde hulptekst). Stijlen kunnen genest worden, bijvoorbeeld 'dimmed match'.
DescriptionStyleType
Het stijltype.
Enum
"url" "overeenkomst" "zwak"
OnInputEnteredDisposition
De vensterindeling voor de omnibox-query. Dit is de aanbevolen context voor het weergeven van resultaten. Als de omnibox-opdracht bijvoorbeeld is om naar een bepaalde URL te navigeren, betekent de indeling 'newForegroundTab' dat de navigatie in een nieuw geselecteerd tabblad moet plaatsvinden.
Enum
"huidig tabblad" "newForegroundTab" "nieuweAchtergrondTab"
SuggestResult
Een suggestie voor een resultaat.
Eigenschappen
- inhoud
snaar
De tekst die in de adresbalk wordt geplaatst en die naar de extensie wordt verzonden wanneer de gebruiker deze optie selecteert.
- verwijderbaar
boolean optioneel
Chrome 63+Of het voorgestelde resultaat door de gebruiker kan worden verwijderd.
- beschrijving
snaar
De tekst die wordt weergegeven in het URL-dropdownmenu. Kan XML-achtige opmaak bevatten voor styling. De ondersteunde tags zijn 'url' (voor een letterlijke URL), 'match' (voor het markeren van tekst die overeenkomt met de zoekopdracht van de gebruiker) en 'dim' (voor gedempte hulptekst). Stijlen kunnen genest worden, bijvoorbeeld 'dimmed match'. U moet de vijf vooraf gedefinieerde entiteiten escapen om ze als tekst weer te geven: stackoverflow.com/a/1091953/89484
Methoden
setDefaultSuggestion()
chrome.omnibox.setDefaultSuggestion(
suggestion: DefaultSuggestResult,
callback?: function,
): Promise<void>
Hiermee stelt u de beschrijving en opmaak in voor de standaardsuggestie. De standaardsuggestie is de tekst die wordt weergegeven in de eerste suggestieregel onder de URL-balk.
Parameters
- suggestie
Een gedeeltelijk SuggestResult-object, zonder de parameter 'content'.
- terugbelverzoek
functie optioneel
Chrome 100+De
callbackparameter ziet er als volgt uit:() => void
Retourneert
Promise<void>
Chrome 100+Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.
Evenementen
onDeleteSuggestion
chrome.omnibox.onDeleteSuggestion.addListener(
callback: function,
)
De gebruiker heeft een voorgesteld resultaat verwijderd.
Parameters
- terugbelverzoek
functie
De
callbackparameter ziet er als volgt uit:(text: string) => void
- tekst
snaar
onInputCancelled
chrome.omnibox.onInputCancelled.addListener(
callback: function,
)
De gebruiker heeft de sessie voor het invoeren van trefwoorden beëindigd zonder de invoer te accepteren.
Parameters
- terugbelverzoek
functie
De
callbackparameter ziet er als volgt uit:() => void
onInputChanged
chrome.omnibox.onInputChanged.addListener(
callback: function,
)
De gebruiker heeft de tekst in de adresbalk gewijzigd.
Parameters
- terugbelverzoek
functie
De
callbackparameter ziet er als volgt uit:(text: string, suggest: function) => void
- tekst
snaar
- voorstellen
functie
De parameter
suggestziet er als volgt uit:(suggestResults: SuggestResult[]) => void
- suggestiesResultaten
Reeks suggesties
onInputEntered
chrome.omnibox.onInputEntered.addListener(
callback: function,
)
De gebruiker heeft de in het adresveld ingevoerde tekst geaccepteerd.
Parameters
- terugbelverzoek
functie
De
callbackparameter ziet er als volgt uit:(text: string, disposition: OnInputEnteredDisposition) => void
- tekst
snaar
- aanleg
onInputStarted
chrome.omnibox.onInputStarted.addListener(
callback: function,
)
De gebruiker heeft een invoersessie voor trefwoorden gestart door het trefwoord van de extensie in te typen. Dit wordt gegarandeerd precies één keer per invoersessie verzonden, en vóórdat er onInputChanged-gebeurtenissen plaatsvinden.
Parameters
- terugbelverzoek
functie
De
callbackparameter ziet er als volgt uit:() => void