chrome.omnibox

Açıklama

Çok amaçlı adres çubuğu API'sı, çok amaçlı adres çubuğu olarak da bilinen Google Chrome'un adres çubuğuna anahtar kelimeleri 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ısına sahip olur. Her tuş vuruşu uzantınıza gönderilir ve siz de bunlara yanıt olarak öneriler sunabilirsiniz.

Öneriler çeşitli şekillerde zengin biçimde biçimlendirilebilir. Kullanıcı bir öneriyi kabul ettiğinde Uzantınıza bildirim gönderilir ve işlem yapabilir.

Manifest

Çok amaçlı adres çubuğu API'sini kullanmak için manifest dosyasına bir omnibox keyword alanı eklemeniz gerekir. Siz size öneride bulunurken adres çubuğunda görüntülenecek 16x16 piksel boyutunda bir simge de belirtmelidir anahtar kelime moduna girdiğini gösterir.

Ö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 bölümünden çok amaçlı adres çubuğu API'si örneğini yükleyin. depodur.

Türler

DefaultSuggestResult

Öneri sonucu.

Özellikler

  • açıklama

    dize

    URL açılır listesinde görüntülenen metin. Stil için XML stili işaretleme içerebilir. Desteklenen etiketler: "url" (değişmez URL için), 'match' (kullanıcının sorgusuyla eşleşen metni vurgulamak için) ve 'kararlaştır' (yardımcı metni karartmak için) Stiller iç içe yerleştirilebilir, ör. soluklaştırılmış eşleşme.

DescriptionStyleType

Chrome 44 ve sonraki sürümler 'nı inceleyin.

Stil türü.

Enum

"url"

"match"

"loş"

OnInputEnteredDisposition

Chrome 44 ve sonraki sürümler 'nı inceleyin.

Çok amaçlı adres çubuğu sorgusu için pencere yapısı. 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 gitmek için kullanıldığında "newForegroundTab" komutu kullanılır. gezinmenin yeni seçilen bir sekmede yapılması gerektiği anlamına gelir.

Enum

"currentTab"

"newForegroundTab"

"newbackgroundTab"

SuggestResult

Öneri sonucu.

Özellikler

  • içerik

    dize

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

  • silinebilir

    boole isteğe bağlı

    Chrome 63 ve sonraki sürümler 'nı inceleyin.

    Öneri sonucunun kullanıcı tarafından silinip silinmeyeceği.

  • açıklama

    dize

    URL açılır listesinde görüntülenen metin. Stil için XML stili işaretleme içerebilir. Desteklenen etiketler: "url" (değişmez URL için), 'match' (kullanıcının sorgusuyla eşleşen metni vurgulamak için) ve 'kararlaştır' (yardımcı metni karartmak için) Stiller iç içe yerleştirilebilir, ör. soluklaştırılmış eşleşme. Metin olarak görüntülemek için önceden tanımlanmış beş varlıktan çıkış yapmanız gerekir: stackoverflow.com/a/1091953/89484

Yöntemler

setDefaultSuggestion()

Söz 'nı inceleyin.
chrome.omnibox.setDefaultSuggestion(
  suggestion: DefaultSuggestResult,
  callback?: function,
)

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

  • "content" içermeyen kısmi bir SuggestResult nesnesi parametresinden sonra bir değer girin.

  • geri çağırma

    işlev isteğe bağlı

    Chrome 100 ve sonraki sürümler 'nı inceleyin.

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

    () => void

İadeler

  • Taahhüt<void>

    Chrome 100 ve sonraki sürümler 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

Etkinlikler

onDeleteSuggestion

Chrome 63 ve sonraki sürümler 'nı inceleyin.
chrome.omnibox.onDeleteSuggestion.addListener(
  callback: function,
)

Kullanıcı önerilen bir sonucu sildi.

Parametreler

  • geri çağırma

    işlev

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

    (text: string) => void

    • text (metin)

      dize

onInputCancelled

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

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

Parametreler

  • geri çağırma

    işlev

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

    () => void

onInputChanged

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

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

Parametreler

  • geri çağırma

    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

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

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

Parametreler

onInputStarted

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

Kullanıcı, uzantının anahtar kelimesini yazarak bir anahtar kelime giriş oturumu başlattı. Bunun, giriş oturumu başına tam olarak bir kez ve tüm onInputChanged etkinliklerinden önce gönderileceği garanti edilir.

Parametreler

  • geri çağırma

    işlev

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

    () => void