chrome.action

Deskripsi

Ketersediaan

Manifes

Untuk menggunakan chrome.action API, tentukan "manifest_version" dari 3 dan sertakan kunci "action" dalam file manifes Anda.

{
  "name": "Action Extension",
  ...
  "action": {
    "default_icon": {              // optional
      "16": "images/icon16.png",   // optional
      "24": "images/icon24.png",   // optional
      "32": "images/icon32.png"    // optional
    },
    "default_title": "Click Me",   // optional, shown in tooltip
    "default_popup": "popup.html"  // optional
  },
  ...
}

Kunci "action" (beserta turunannya) bersifat opsional. Jika tidak disertakan, ekstensi Anda tetap ditampilkan di toolbar untuk memberikan akses ke menu ekstensi. Karena itu, sebaiknya Anda selalu menyertakan setidaknya kunci "action" dan "default_icon".

Konsep dan penggunaan

Bagian-bagian UI

Ikon

Ikon adalah gambar utama di toolbar untuk ekstensi Anda, dan ditetapkan oleh kunci "default_icon" dalam kunci "action" manifes Anda. Ikon harus memiliki panjang dan lebar 16 piksel yang tidak tergantung perangkat (DIP).

Kunci "default_icon" adalah kamus ukuran untuk jalur gambar. Chrome menggunakan ikon ini untuk memilih skala gambar yang akan digunakan. Jika kecocokan persis tidak ditemukan, Chrome akan memilih yang terdekat yang tersedia dan menskalakannya agar sesuai dengan gambar, yang dapat memengaruhi kualitas gambar.

Karena perangkat dengan faktor skala yang kurang umum seperti 1,5x atau 1,2x menjadi lebih umum, sebaiknya sediakan beberapa ukuran untuk ikon Anda. Cara ini juga mempertahankan ekstensi Anda terhadap potensi perubahan ukuran tampilan ikon. Namun, jika hanya memberikan ukuran tunggal, kunci "default_icon" juga dapat ditetapkan ke string dengan jalur ke ikon tunggal, bukan kamus.

Anda juga dapat memanggil action.setIcon() untuk menyetel ikon ekstensi secara terprogram dengan menentukan jalur gambar yang berbeda atau memberikan ikon yang dibuat secara dinamis menggunakan elemen kanvas HTML, atau, jika menyetel dari pekerja layanan ekstensi, API kanvas offscreen.

const canvas = new OffscreenCanvas(16, 16);
const context = canvas.getContext('2d');
context.clearRect(0, 0, 16, 16);
context.fillStyle = '#00FF00';  // Green
context.fillRect(0, 0, 16, 16);
const imageData = context.getImageData(0, 0, 16, 16);
chrome.action.setIcon({imageData: imageData}, () => { /* ... */ });

Untuk paket ekstensi (yang diinstal dari file .crx), gambar dapat berupa sebagian besar format yang dapat ditampilkan oleh mesin rendering Blink, termasuk PNG, JPEG, BMP, ICO, dan lainnya. SVG tidak didukung. Ekstensi yang tidak diekstrak harus menggunakan gambar PNG.

Tooltip (judul)

Tooltip, atau judul, muncul saat pengguna mengarahkan kursor mouse ke ikon ekstensi di toolbar. Lokasi juga disertakan dalam teks yang dapat diakses yang diucapkan oleh pembaca layar saat tombol difokus.

Tooltip default ditetapkan menggunakan kolom "default_title" dari kunci "action" di manifest.json. Anda juga dapat menetapkannya secara terprogram dengan memanggil action.setTitle().

Badge

Secara opsional, tindakan dapat menampilkan "badge" — sedikit teks yang menutupi ikon. Hal ini memungkinkan Anda memperbarui tindakan untuk menampilkan sejumlah kecil informasi tentang status ekstensi, seperti penghitung. Badge memiliki komponen teks dan warna latar belakang. Karena ruang terbatas, sebaiknya teks badge menggunakan empat karakter atau kurang.

Untuk membuat badge, tetapkan secara terprogram dengan memanggil action.setBadgeBackgroundColor() dan action.setBadgeText(). Tidak ada setelan badge default dalam manifes. Nilai warna badge dapat berupa array yang terdiri dari empat bilangan bulat antara 0 dan 255 yang membentuk warna RGBA badge atau string dengan nilai warna CSS.

chrome.action.setBadgeBackgroundColor(
  {color: [0, 255, 0, 0]},  // Green
  () => { /* ... */ },
);

chrome.action.setBadgeBackgroundColor(
  {color: '#00FF00'},  // Also green
  () => { /* ... */ },
);

chrome.action.setBadgeBackgroundColor(
  {color: 'green'},  // Also, also green
  () => { /* ... */ },
);

Pop-up

Pop-up tindakan akan ditampilkan saat pengguna mengklik tombol tindakan ekstensi di toolbar. Pop-up dapat berisi konten HTML apa pun yang Anda sukai, dan akan disesuaikan ukurannya secara otomatis agar sesuai dengan kontennya. Ukuran pop-up harus antara 25x25 dan 800x600 piksel.

Pop-up awalnya ditetapkan oleh properti "default_popup" di kunci "action" dalam file manifest.json. Jika ada, properti ini harus mengarah ke jalur relatif dalam direktori ekstensi. Kolom ini juga dapat diperbarui secara dinamis untuk mengarah ke jalur relatif yang berbeda menggunakan metode action.setPopup().

Kasus penggunaan

Status per tab

Tindakan ekstensi dapat memiliki status yang berbeda untuk setiap tab. Untuk menetapkan nilai bagi setiap tab, gunakan properti tabId dalam metode setelan action API. Misalnya, untuk menetapkan teks badge di tab tertentu, lakukan hal seperti berikut:

function getTabId() { /* ... */}
function getTabBadge() { /* ... */}

chrome.action.setBadgeText(
  {
    text: getTabBadge(tabId),
    tabId: getTabId(),
  },
  () => { ... }
);

Jika properti tabId tidak diisi, setelan akan diperlakukan sebagai setelan global. Setelan khusus tab akan lebih diprioritaskan daripada setelan global.

Status diaktifkan

Secara default, tindakan toolbar diaktifkan (dapat diklik) pada setiap tab. Anda dapat mengontrolnya menggunakan metode action.enable() dan action.disable(). Hal ini hanya memengaruhi apakah pop-up (jika ada) atau peristiwa action.onClicked dikirim ke ekstensi Anda; hal ini tidak memengaruhi keberadaan tindakan di toolbar.

Contoh

Contoh berikut menunjukkan beberapa cara umum penggunaan tindakan dalam ekstensi. Untuk mencoba API ini, instal contoh Action API dari repositori chrome-extension-samples.

Menampilkan pop-up

Sangat umum bagi ekstensi untuk menampilkan pop-up saat pengguna mengklik tindakan ekstensi. Untuk mengimplementasikannya di ekstensi Anda sendiri, deklarasikan pop-up di manifest.json dan tentukan konten yang akan ditampilkan Chrome dalam pop-up.

// manifest.json
{
  "name": "Action popup demo",
  "version": "1.0",
  "manifest_version": 3,
  "action": {
    "default_title": "Click to view a popup",
    "default_popup": "popup.html"
  }
}

<!-- popup.html -->
<!DOCTYPE html>
<html>
<head>
  <style>
    html {
      min-height: 5em;
      min-width: 10em;
      background: salmon;
    }
  </style>
</head>
<body>
  <p>Hello, world!</p>
</body>
</html>

Memasukkan skrip konten saat diklik

Pola umum untuk ekstensi adalah menampilkan fitur utamanya menggunakan tindakan ekstensi. Contoh berikut menunjukkan pola ini. Saat pengguna mengklik tindakan, ekstensi akan memasukkan skrip konten ke halaman saat ini. Skrip konten kemudian menampilkan peringatan untuk memverifikasi bahwa semuanya berfungsi seperti yang diharapkan.

// manifest.json
{
  "name": "Action script injection demo",
  "version": "1.0",
  "manifest_version": 3,
  "action": {
    "default_title": "Click to show an alert"
  },
  "permissions": ["activeTab", "scripting"],
  "background": {
    "service_worker": "background.js"
  }
}

// background.js
chrome.action.onClicked.addListener((tab) => {
  chrome.scripting.executeScript({
    target: {tabId: tab.id},
    files: ['content.js']
  });
});

// content.js
alert('Hello, world!');

Mengemulasi tindakan dengan declarativeContent

Contoh ini menunjukkan cara logika latar belakang ekstensi dapat (a) menonaktifkan tindakan secara default dan (b) menggunakan declarativeContent untuk mengaktifkan tindakan di situs tertentu.

// service-worker.js

// Wrap in an onInstalled callback to avoid unnecessary work
// every time the service worker is run
chrome.runtime.onInstalled.addListener(() => {
  // Page actions are disabled by default and enabled on select tabs
  chrome.action.disable();

  // Clear all rules to ensure only our expected rules are set
  chrome.declarativeContent.onPageChanged.removeRules(undefined, () => {
    // Declare a rule to enable the action on example.com pages
    let exampleRule = {
      conditions: [
        new chrome.declarativeContent.PageStateMatcher({
          pageUrl: {hostSuffix: '.example.com'},
        })
      ],
      actions: [new chrome.declarativeContent.ShowAction()],
    };

    // Finally, apply our new array of rules
    let rules = [exampleRule];
    chrome.declarativeContent.onPageChanged.addRules(rules);
  });
});

chrome.action.disable(
  tabId?: number,
  callback?: function,
)

chrome.action.enable(
  tabId?: number,
  callback?: function,
)

chrome.action.getBadgeBackgroundColor(
  details: TabDetails,
  callback?: function,
)

chrome.action.getBadgeText(
  details: TabDetails,
  callback?: function,
)

chrome.action.getBadgeTextColor(
  details: TabDetails,
  callback?: function,
)

chrome.action.getPopup(
  details: TabDetails,
  callback?: function,
)

chrome.action.getTitle(
  details: TabDetails,
  callback?: function,
)

chrome.action.getUserSettings(
  callback?: function,
)

chrome.action.isEnabled(
  tabId?: number,
  callback?: function,
)

chrome.action.openPopup(
  options?: OpenPopupOptions,
  callback?: function,
)

chrome.action.setBadgeBackgroundColor(
  details: object,
  callback?: function,
)

chrome.action.setBadgeText(
  details: object,
  callback?: function,
)

chrome.action.setBadgeTextColor(
  details: object,
  callback?: function,
)

chrome.action.setIcon(
  details: object,
  callback?: function,
)

chrome.action.setPopup(
  details: object,
  callback?: function,
)

chrome.action.setTitle(
  details: object,
  callback?: function,
)

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