chrome.pageAction

Açıklama

Simgeleri, adres çubuğunun sağındaki ana Google Chrome araç çubuğuna yerleştirmek için chrome.pageAction API'sini kullanın. Sayfa işlemleri, geçerli sayfada yapılabilecek ancak tüm sayfalar için geçerli olmayan işlemleri temsil eder. Sayfa işlemleri, etkin olmadığında devre dışı görünür.

Kullanılabilirlik

≤ MV2

Bazı örnekler:

  • Bu sayfanın RSS yayınına abone olun
  • Bu sayfanın fotoğraflarından slayt gösterisi oluştur

Aşağıdaki ekran görüntüsündeki RSS simgesi, geçerli sayfanın RSS özet akışına abone olmanıza olanak tanıyan bir sayfa işlemini temsil eder.

Gizli sayfa işlemleri devre dışı görünür. Örneğin, geçerli sayfanın özet akışına abone olamayacağınız için aşağıdaki RSS özet akışı devre dışıdır:

Kullanıcıların her zaman uzantınızla etkileşimde bulunabilmeleri için lütfen bunun yerine bir tarayıcı işlemi kullanmayı düşünün.

Manifest

Sayfa işleminizi uzantı manifestine aşağıdaki şekilde kaydedin:

{
  "name": "My extension",
  ...
  "page_action": {
    "default_icon": {                    // optional
      "16": "images/icon16.png",           // optional
      "24": "images/icon24.png",           // optional
      "32": "images/icon32.png"            // optional
    },
    "default_title": "Google Mail",      // optional; shown in tooltip
    "default_popup": "popup.html"        // optional
  },
  ...
}

1,5x veya 1,2x gibi daha az kullanılan ölçek faktörlerine sahip cihazlar giderek yaygınlaştığından, simgeleriniz için birden fazla boyut sağlamanız teşvik edilir. Chrome en yakın olanı seçer ve bunu, 16'lık alanı dolduracak şekilde ölçeklendirir. Bu sayede, simge görüntü boyutu değişirse farklı simgeler sağlamak için başka bir işlem yapmanız gerekmez. Bununla birlikte, boyut farkı çok aşırı olursa bu ölçeklendirme, simgenin ayrıntıları kaybetmesine veya belirsiz görünmesine neden olabilir.

Varsayılan simgeyi kaydetmek için eski söz dizimi hâlâ desteklenmektedir:

{
  "name": "My extension",
  ...
  "page_action": {
    ...
    "default_icon": "images/icon32.png"  // optional
    // equivalent to "default_icon": { "32": "images/icon32.png" }
  },
  ...
}

Kullanıcı arayüzünün bölümleri

Tarayıcı eylemlerinde olduğu gibi, sayfa işlemlerinde de bir simge, ipucu ve pop-up bulunabilir. Ancak, rozetleri olamaz. Ayrıca, sayfa işlemleri de gri renkli olabilir. Simgeler, ipuçları ve pop-up'larla ilgili bilgileri, tarayıcı işlemi kullanıcı arayüzü hakkındaki bilgileri okuyarak bulabilirsiniz.

pageAction.show ve pageAction.hide yöntemlerini kullanarak bir sayfa işleminin gösterilmesini ve devre dışı bırakılmasını sağlarsınız. Varsayılan olarak, sayfa işlemleri gri renkte gösterilir. Simgeyi gösterdiğinizde simgenin görüneceği sekmeyi belirtirsiniz. Simge, sekme kapatılana veya farklı bir URL görüntülemeye başlayana kadar (örneğin, kullanıcı bir bağlantıyı tıkladığında) görünür durumda kalır.

İpuçları

En iyi görsel etki için şu yönergeleri uygulayın:

  • Yalnızca birkaç sayfa için anlamlı olan özellikler için sayfa işlemlerini kullanın.
  • Çoğu sayfada işe yarayan özellikler için sayfa işlemlerini kullanmayın. Bunun yerine tarayıcı işlemlerini kullanın.
  • Simgeniz için sürekli animasyon yapmayın. Bu çok sinir bozucu.

Türler

ImageDataType

Bir resmin piksel verileri. Bir ImageData nesnesi olmalıdır (örneğin, bir canvas öğesinden).

Tür

ImageData

TabDetails

Chrome 88 ve sonraki sürümler

Özellikler

  • tabId

    numara isteğe bağlı

    Durumun sorgulanacağı sekmenin kimliği. Herhangi bir sekme belirtilmezse sekmeye özgü olmayan durum döndürülür.

Yöntemler

getPopup()

Söz
chrome.pageAction.getPopup(
  details: TabDetails,
  callback?: function,
)

Bu sayfa işlemi için pop-up olarak ayarlanan HTML dokümanını alır.

Parametreler

  • ayrıntılar
  • geri çağırma

    Functions (isteğe bağlı)

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

    (result: string)=>void

    • sonuç

      dize

İlerlemeler

  • Söz<dize>

    Chrome 101 ve sonraki sürümler

    Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.

getTitle()

Söz
chrome.pageAction.getTitle(
  details: TabDetails,
  callback?: function,
)

Sayfa işleminin başlığını alır.

Parametreler

  • ayrıntılar
  • geri çağırma

    Functions (isteğe bağlı)

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

    (result: string)=>void

    • sonuç

      dize

İlerlemeler

  • Söz<dize>

    Chrome 101 ve sonraki sürümler

    Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.

hide()

Söz
chrome.pageAction.hide(
  tabId: number,
  callback?: function,
)

Sayfa işlemini gizler. Gizli sayfa işlemleri Chrome araç çubuğunda görünmeye devam eder, ancak devre dışıdır.

Parametreler

  • tabId

    sayı

    Sayfa işlemini değiştirmek istediğiniz sekmenin kimliği.

  • geri çağırma

    Functions (isteğe bağlı)

    Chrome 67 ve sonraki sürümler

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

    ()=>void

İlerlemeler

  • Promise<void>

    Chrome 101 ve sonraki sürümler

    Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.

setIcon()

Söz
chrome.pageAction.setIcon(
  details: object,
  callback?: function,
)

Sayfa işlemi için simgeyi ayarlar. Simge, bir resim dosyasının yolu, tuval öğesindeki piksel verileri veya bunlardan birinin sözlüğü olarak belirtilebilir. path veya imageData özelliği belirtilmelidir.

Parametreler

  • ayrıntılar

    nesne

    • iconIndex

      numara isteğe bağlı

      Kullanımdan kaldırıldı. Bu bağımsız değişken yoksayılır.

    • imageData

      ImageData|nesne isteğe bağlı

      Ayarlanacak simgeyi temsil eden bir ImageData nesnesi veya sözlük {size -> ImageData}. Simge bir sözlük olarak belirtilmişse, kullanılacak gerçek resim, ekranın piksel yoğunluğuna bağlı olarak seçilir. Bir ekran alanı birimine sığan resim piksellerinin sayısı scale değerine eşitse scale * n boyutlu resim seçilir. Burada n, kullanıcı arayüzündeki simgenin boyutudur. En az bir resim belirtilmelidir. 'details.imageData = foo' öğesinin 'details.imageData = {'16': foo}' değerine eşdeğer olduğunu unutmayın.

    • yol

      string|object isteğe bağlı

      Ayarlanacak simgeye işaret eden göreli bir resim yolu veya sözlük {boyut -> göreli resim yolu}. Simge bir sözlük olarak belirtilmişse, kullanılacak gerçek resim, ekranın piksel yoğunluğuna bağlı olarak seçilir. Bir ekran alanı birimine sığan resim piksellerinin sayısı scale değerine eşitse scale * n boyutlu resim seçilir. Burada n, kullanıcı arayüzündeki simgenin boyutudur. En az bir resim belirtilmelidir. 'details.path = foo', 'details.path = {'16': foo}' ile eşdeğerdir

    • tabId

      sayı

      Sayfa işlemini değiştirmek istediğiniz sekmenin kimliği.

  • geri çağırma

    Functions (isteğe bağlı)

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

    ()=>void

İlerlemeler

  • Promise<void>

    Chrome 101 ve sonraki sürümler

    Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.

setPopup()

Söz
chrome.pageAction.setPopup(
  details: object,
  callback?: function,
)

Kullanıcı, sayfa işleminin simgesini tıkladığında pop-up olarak açılacak HTML dokümanını ayarlar.

Parametreler

  • ayrıntılar

    nesne

    • pop-up

      dize

      Pop-up'ta gösterilecek HTML dosyasının göreli yolu. Boş dizeye ('') ayarlanırsa pop-up gösterilmez.

    • tabId

      sayı

      Sayfa işlemini değiştirmek istediğiniz sekmenin kimliği.

  • geri çağırma

    Functions (isteğe bağlı)

    Chrome 67 ve sonraki sürümler

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

    ()=>void

İlerlemeler

  • Promise<void>

    Chrome 101 ve sonraki sürümler

    Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.

setTitle()

Söz
chrome.pageAction.setTitle(
  details: object,
  callback?: function,
)

Sayfa işleminin başlığını ayarlar. Bu bilgi, sayfa işlemi üzerindeki bir ipucu olarak gösterilir.

Parametreler

  • ayrıntılar

    nesne

    • tabId

      sayı

      Sayfa işlemini değiştirmek istediğiniz sekmenin kimliği.

    • title

      dize

      İpucu dizesi.

  • geri çağırma

    Functions (isteğe bağlı)

    Chrome 67 ve sonraki sürümler

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

    ()=>void

İlerlemeler

  • Promise<void>

    Chrome 101 ve sonraki sürümler

    Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.

show()

Söz
chrome.pageAction.show(
  tabId: number,
  callback?: function,
)

Sayfa işlemini gösterir. Sekme seçildiğinde sayfa işlemi gösterilir.

Parametreler

  • tabId

    sayı

    Sayfa işlemini değiştirmek istediğiniz sekmenin kimliği.

  • geri çağırma

    Functions (isteğe bağlı)

    Chrome 67 ve sonraki sürümler

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

    ()=>void

İlerlemeler

  • Promise<void>

    Chrome 101 ve sonraki sürümler

    Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.

Etkinlikler

onClicked

chrome.pageAction.onClicked.addListener(
  callback: function,
)

Bir sayfa işlem simgesi tıklandığında tetiklenir. Sayfa işleminde pop-up varsa bu etkinlik tetiklenmez.

Parametreler

  • geri çağırma

    işlev

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

    (tab: tabs.Tab)=>void