browser.omnibox

Açıklama

Çok amaçlı adres çubuğu API'si, Google Chrome'un çok amaçlı adres çubuğu olarak da bilinen adres çubuğuna bir anahtar kelime kaydetmenize olanak tanır.

"Chromium Arama" anahtar kelimesiyle ilgili önerileri gösteren ekran görüntüsü

Kullanıcı, uzantınızın anahtar kelimesini girdiğinde yalnızca uzantınızla etkileşime girmeye başlar. Her tuş vuruşu uzantınıza gönderilir ve yanıt olarak öneriler sunabilirsiniz.

Öneriler, çeşitli şekillerde zengin biçimlendirilebilir. Kullanıcı bir öneriyi kabul ettiğinde uzantınız bilgilendirilir ve harekete geçebilir.

Manifest

Bu API'yi kullanmak için aşağıdaki anahtarların manifest dosyasında tanımlanması gerekir.

"omnibox"

Omnibox API'yi kullanmak için manifest dosyasına bir "omnibox.keyword" alanı eklemeniz gerekir. Ayrıca, kullanıcılara anahtar kelime moduna girmeleri önerildiğinde adres çubuğunda gösterilecek 16x16 piksellik bir simge de belirtmeniz gerekir.

Örneğin:

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

Örnekler

Bu API'yi denemek için chrome-extension-samples deposundan omnibox API örneğini yükleyin.

Türler

DefaultSuggestResult

Öneri sonucu.

Özellikler

  • açıklama

    dize

    URL açılır listesinde gösterilen metindir. Stil için XML tarzı işaretleme içerebilir. Desteklenen etiketler şunlardır: "url" (tam URL için), "match" (kullanıcının sorgusuyla eşleşen metni vurgulamak için) ve "dim" (soluk yardımcı metin için). Stiller iç içe yerleştirilebilir (ör. soluk eşleşme).

DescriptionStyleType

Chrome 44 ve sonraki sürümler Chrome 148'den itibaren browser.*

Stil türü.

Enum

"url"

"match"

"dim"

OnInputEnteredDisposition

Chrome 44 ve sonraki sürümler Chrome 148'den itibaren browser.*

Çok amaçlı adres çubuğu sorgusu için pencere düzeni. Sonuçları görüntülemek için önerilen bağlam budur. Örneğin, çok amaçlı adres çubuğu komutu belirli bir URL'ye gitmekse "newForegroundTab" düzeni, gezinmenin yeni seçilen bir sekmede gerçekleşmesi gerektiği anlamına gelir.

Enum

"currentTab"

"newForegroundTab"

"newBackgroundTab"

SuggestResult

Öneri sonucu.

Özellikler

  • içerik

    dize

    Kullanıcı bu girişi seçtiğinde URL çubuğuna yerleştirilen ve uzantıya gönderilen metin.

  • silinebilir

    boole isteğe bağlı

    Chrome 63 ve sonraki sürümler Chrome 148'den itibaren browser.*

    Öneri sonucunun kullanıcı tarafından silinip silinemeyeceğini belirtir.

  • açıklama

    dize

    URL açılır listesinde gösterilen metindir. Stil için XML tarzı işaretleme içerebilir. Desteklenen etiketler şunlardır: "url" (tam URL için), "match" (kullanıcının sorgusuyla eşleşen metni vurgulamak için) ve "dim" (soluk yardımcı metin için). Stiller iç içe yerleştirilebilir (ör. soluk eşleşme). Önceden tanımlanmış beş öğeyi metin olarak görüntülemek için çıkış karakteri kullanmanız gerekir: stackoverflow.com/a/1091953/89484

Yöntemler

setDefaultSuggestion()

browser.omnibox.setDefaultSuggestion(
  suggestion: DefaultSuggestResult,
): Promise<void>

Varsayılan önerinin açıklamasını ve stilini ayarlar. Varsayılan öneri, URL çubuğunun altındaki ilk öneri satırında gösterilen metindir.

Parametreler

İadeler

  • Promise<void>

    Chrome 100 ve sonraki sürümler Chrome 148'den itibaren browser.*

Etkinlikler

onDeleteSuggestion

Chrome 63 ve sonraki sürümler Chrome 148'den itibaren browser.* 
browser.omnibox.onDeleteSuggestion.addListener(
  callback: function,
)

Kullanıcı, önerilen bir sonucu sildi.

Parametreler

  • callback

    işlev

    callback parametresi şu şekilde görünür: 

    (text: string) => void

    • text (metin)

      dize

onInputCancelled

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

Kullanıcı, girişi kabul etmeden anahtar kelime giriş oturumunu sonlandırdı.

Parametreler

  • callback

    işlev

    callback parametresi şu şekilde görünür: 

    () => void

onInputChanged

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

Kullanıcı, çok amaçlı adres çubuğuna yazılanları değiştirdi.

Parametreler

  • callback

    işlev

    callback parametresi şu şekilde görünür: 

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

    • text (metin)

      dize

    • suggest

      işlev

      suggest parametresi şu şekilde görünür: 

      (suggestResults: SuggestResult[]) => void

onInputEntered

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

Kullanıcı, çok amaçlı adres çubuğuna yazılanları kabul etti.

Parametreler

onInputStarted

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

Kullanıcı, uzantının anahtar kelimesini yazarak bir anahtar kelime girişi oturumu başlattı. Bu etkinlik, giriş oturumu başına tam olarak bir kez ve onInputChanged etkinliklerinden önce gönderilir.

Parametreler

  • callback

    işlev

    callback parametresi şu şekilde görünür: 

    () => void