chrome.omnibox

Açıklama

Çok amaçlı adres çubuğu API'sı, 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şimde bulunmaya başlar. Her tuş vuruşu uzantınıza gönderilir ve siz bunlara yanıt olarak öneriler sunabilirsiniz.

Öneriler çeşitli şekillerde zengin biçimde biçimlendirilebilir. Kullanıcı bir öneriyi kabul ettiğinde uzantınız bilgilendirilir ve işlem yapabilir.

Manifest

Bu API'yi kullanmak için aşağıdaki anahtarların manifest'te beyan edilmesi gerekir.

"omnibox"

çok amaçlı adres çubuğu API'sini kullanmak için manifeste bir "omnibox.keyword" alanı eklemeniz gerekir. Ayrıca, kullanıcılara anahtar kelime moduna girmeleri önerildiğinde adres çubuğunda görüntülenecek 16x16 piksel boyutunda bir simge 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örüntülenen metin. Stil için XML stili işaretleme içerebilir. Desteklenen etiketler şunlardır: "url" (değişmez URL için), "eşleşme" (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 renkte gösterilen eşleşme).

DescriptionStyleType

Chrome 44 ve sonraki sürümler

Stil türü.

Enum

"url"

"match"

OnInputEnteredDisposition

Chrome 44 ve sonraki sürümler

Ç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 gitmekse, "newForegroundTab"ın yapısı, gezinmenin seçilen yeni bir sekmede gerçekleşmesi gerektiği anlamına gelir.

Enum

"currentTab"

"newForegroundTab"

SuggestResult

Öneri sonucu.

Özellikler

  • sayısını artırmak istiyoruz

    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

    Öneri sonucunun kullanıcı tarafından silinip silinemeyeceğ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 şunlardır: "url" (değişmez URL için), "eşleşme" (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 renkte gösterilen eşleşme). Önceden tanımlanmış beş varlığı metin olarak görüntülemek için kod dışına almanız gerekir: stackoverflow.com/a/1091953/89484

Yöntemler

setDefaultSuggestion()

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

Varsayılan öneri için açıklamayı ve stili ayarlar. Varsayılan öneri, URL çubuğunun altındaki ilk öneri satırında gösterilen metindir.

Parametreler

  • "content" parametresi içermeyen kısmi SuggestResult nesnesi.

  • geri çağırma

    Functions (isteğe bağlı)

    Chrome 100 ve sonraki sürümler

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

    ()=>void

İlerlemeler

  • Promise<void>

    Chrome 100 ve sonraki sürümler

    Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

Etkinlikler

onDeleteSuggestion

Chrome 63 ve sonraki sürümler 
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ılanları 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önderilmesi garanti edilir.

Parametreler

  • geri çağırma

    işlev

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

    ()=>void