chrome.tabs

Catatan: Tabs API dapat digunakan oleh pekerja layanan dan halaman ekstensi, tetapi tidak untuk skrip konten.

Deskripsi

Gunakan chrome.tabs API untuk berinteraksi dengan sistem tab browser. Anda dapat menggunakan API ini untuk membuat, mengubah, dan mengatur ulang tab di browser.

Tabs API tidak hanya menawarkan fitur untuk memanipulasi dan mengelola tab, tetapi juga dapat mendeteksi bahasa tab, mengambil screenshot, dan berkomunikasi dengan skrip konten tab.

Izin

Sebagian besar fitur tidak memerlukan izin apa pun untuk digunakan. Misalnya: membuat tab baru, memuat ulang tab, membuka URL lain, dll.

Ada tiga izin yang harus diketahui developer saat menggunakan Tabs API.

Izin "tab"

Izin ini tidak memberikan akses ke namespace chrome.tabs. Sebagai gantinya, ekstensi ini memberikan kemampuan kepada ekstensi untuk memanggil tabs.query() terhadap empat properti sensitif pada instance tabs.Tab: url, pendingUrl, title, dan favIconUrl.

{
  "name": "My extension",
  ...
  "permissions": [
    "tabs"
  ],
  ...
}

Izin host

Izin host memungkinkan ekstensi membaca dan membuat kueri empat properti tabs.Tab sensitif tab yang cocok. Metode ini juga dapat berinteraksi langsung dengan tab yang cocok menggunakan metode seperti tabs.captureVisibleTab(), tabs.executeScript(), tabs.insertCSS(), dan tabs.removeCSS().

{
  "name": "My extension",
  ...
  "host_permissions": [
    "http://*/*",
    "https://*/*"
  ],
  ...
}

Izin "activeTab"

activeTab memberikan izin host sementara ekstensi untuk tab saat ini sebagai respons terhadap pemanggilan pengguna. Tidak seperti izin host, activeTab tidak memicu peringatan apa pun.

{
  "name": "My extension",
  ...
  "permissions": [
    "activeTab"
  ],
  ...
}

Kasus penggunaan

Bagian berikut menunjukkan beberapa kasus penggunaan umum.

Membuka halaman ekstensi di tab baru

Pola umum untuk ekstensi adalah membuka halaman orientasi di tab baru saat ekstensi diinstal. Contoh berikut menunjukkan cara melakukannya.

background.js:

chrome.runtime.onInstalled.addListener(({reason}) => {
  if (reason === 'install') {
    chrome.tabs.create({
      url: "onboarding.html"
    });
  }
});

Catatan: Contoh ini tidak memerlukan izin apa pun.

Mendapatkan tab saat ini

Contoh ini menunjukkan cara pekerja layanan ekstensi mengambil tab aktif dari jendela yang saat ini difokuskan (atau jendela yang terakhir difokuskan, jika tidak ada jendela Chrome yang difokuskan). Hal ini biasanya dapat dianggap sebagai tab pengguna saat ini.

  async function getCurrentTab() {
    let queryOptions = { active: true, lastFocusedWindow: true };
    // `tab` will either be a `tabs.Tab` instance or `undefined`.
    let [tab] = await chrome.tabs.query(queryOptions);
    return tab;
  }

  function getCurrentTab(callback) {
    let queryOptions = { active: true, lastFocusedWindow: true };
    chrome.tabs.query(queryOptions, ([tab]) => {
      if (chrome.runtime.lastError)
      console.error(chrome.runtime.lastError);
      // `tab` will either be a `tabs.Tab` instance or `undefined`.
      callback(tab);
    });
  }

Membisukan tab yang ditentukan

Contoh ini menunjukkan cara ekstensi dapat mengalihkan status bisu untuk tab tertentu.

  async function toggleMuteState(tabId) {
    const tab = await chrome.tabs.get(tabId);
    const muted = !tab.mutedInfo.muted;
    await chrome.tabs.update(tabId, {muted});
    console.log(`Tab ${tab.id} is ${muted ? "muted" : "unmuted"}`);
  }

  function toggleMuteState(tabId) {
    chrome.tabs.get(tabId, async (tab) => {
      let muted = !tab.mutedInfo.muted;
      await chrome.tabs.update(tabId, { muted });
      console.log(`Tab ${tab.id} is ${ muted ? "muted" : "unmuted" }`);
    });
  }

Memindahkan tab saat ini ke posisi pertama saat diklik

Contoh ini menunjukkan cara memindahkan tab saat operasi tarik mungkin sedang berlangsung atau tidak. Meskipun contoh ini menggunakan chrome.tabs.move, Anda dapat menggunakan pola tunggu yang sama untuk panggilan lain yang mengubah tab saat penarikan sedang berlangsung.

  chrome.tabs.onActivated.addListener(moveToFirstPosition);

  async function moveToFirstPosition(activeInfo) {
    try {
      await chrome.tabs.move(activeInfo.tabId, {index: 0});
      console.log("Success.");
    } catch (error) {
      if (error == "Error: Tabs cannot be edited right now (user may be dragging a tab).") {
        setTimeout(() => moveToFirstPosition(activeInfo), 50);
      } else {
        console.error(error);
      }
    }
  }

Penting: Menggunakan catch(error) dalam Promise adalah cara untuk memastikan bahwa error yang mengisi `chrome.runtime.lastError` tidak dicentang.

  chrome.tabs.onActivated.addListener(moveToFirstPositionMV2);

  function moveToFirstPositionMV2(activeInfo) {
    chrome.tabs.move(activeInfo.tabId, { index: 0 }, () => {
      if (chrome.runtime.lastError) {
        const error = chrome.runtime.lastError;
        if (error == "Error: Tabs cannot be edited right now (user may be dragging a tab).") {
          setTimeout(() => moveToFirstPositionMV2(activeInfo), 50);
        } else {
          console.error(error);
        }
      } else {
        console.log("Success.");
      }
    });
  }

Meneruskan pesan ke skrip konten tab yang dipilih

Contoh ini menunjukkan cara pekerja layanan ekstensi dapat berkomunikasi dengan skrip konten di tab browser tertentu menggunakan tabs.sendMessage().

function sendMessageToActiveTab(message) {
  const [tab] = await chrome.tabs.query({ active: true, lastFocusedWindow: true });
  const response = await chrome.tabs.sendMessage(tab.id, message);
  // TODO: Do something with the response.
}

Contoh ekstensi

Untuk demo ekstensi Tabs API lainnya, jelajahi salah satu dari berikut ini:

• Manifes V2 - Ekstensi Tabs API.
• Manifes V3 - Pengelola Tab.

Jenis

MutedInfo

Chrome 46+

Status bisu tab dan alasan perubahan status terakhir.

Properti

• extensionId

  string opsional

  ID ekstensi yang mengubah status bisukan. Tidak ditetapkan jika ekstensi bukan alasan status bisukan terakhir kali diubah.

• dibisukan

  boolean

  Apakah tab dibisukan (dicegah untuk memutar suara). Tab mungkin dibisukan meskipun belum diputar atau saat ini tidak memutar suara. Setara dengan apakah indikator audio 'dinonaktifkan' ditampilkan.

• alasan

  MutedInfoReason opsional

  Alasan tab dibisukan atau dibisukan. Tidak ditetapkan jika status bisu tab belum pernah diubah.

MutedInfoReason

Chrome 46+

Peristiwa yang menyebabkan perubahan status bisu.

Enum

"user"
Tindakan input pengguna menetapkan status bisu.

"capture"
Perekaman tab dimulai, yang memaksa perubahan status bisu.

"extension"
Ekstensi, yang diidentifikasi oleh kolom extensionId, menetapkan status bisu.

Tab

Properti

• aktif

  boolean

  Apakah tab aktif di jendelanya. Tidak selalu berarti jendela difokuskan.

• audible

  boolean opsional

  Chrome 45+

  Apakah tab telah menghasilkan suara selama beberapa detik terakhir (tetapi mungkin tidak terdengar jika juga dibisukan). Setara dengan apakah indikator 'audio speaker' ditampilkan.

• autoDiscardable

  boolean

  Chrome 54+

  Apakah tab dapat dihapus secara otomatis oleh browser saat resource hampir habis.

• dihapus

  boolean

  Chrome 54+

  Apakah tab dihapus. Tab yang dihapus adalah tab yang kontennya telah dihapus dari memori, tetapi masih terlihat di strip tab. Kontennya dimuat ulang saat diaktifkan lagi.

• favIconUrl

  string opsional

  URL favicon tab. Properti ini hanya ada jika manifes ekstensi menyertakan izin "tabs". String ini juga dapat berupa string kosong jika tab sedang dimuat.

• beku

  boolean

  Tertunda

  Apakah tab berhenti berfungsi. Tab yang dibekukan tidak dapat menjalankan tugas, termasuk pengendali peristiwa atau timer. Tab ini terlihat di strip tab dan kontennya dimuat dalam memori. Akun akan diaktifkan kembali saat diaktifkan.

• groupId

  angka

  Chrome 88+

  ID grup tempat tab berada.

• tinggi

  number opsional

  Tinggi tab dalam piksel.

• disorot

  boolean

  Apakah tab ditandai.

• id

  number opsional

  ID tab. ID tab bersifat unik dalam sesi browser. Dalam beberapa situasi, tab mungkin tidak diberi ID; misalnya, saat membuat kueri tab asing menggunakan sessions API, dalam hal ini ID sesi mungkin ada. ID tab juga dapat ditetapkan ke chrome.tabs.TAB_ID_NONE untuk aplikasi dan jendela devtools.

• samaran

  boolean

  Apakah tab berada di jendela Samaran.

• indeks

  angka

  Indeks tab berbasis nol dalam jendelanya.

• lastAccessed

  angka

  Chrome 121+

  Terakhir kali tab diakses sebagai jumlah milidetik sejak epoch.

• mutedInfo

  MutedInfo opsional

  Chrome 46+

  Status bisu tab dan alasan perubahan status terakhir.

• openerTabId

  number opsional

  ID tab yang membuka tab ini, jika ada. Properti ini hanya ada jika tab pembuka masih ada.

• pendingUrl

  string opsional

  Chrome 79+

  URL yang dituju tab, sebelum di-commit. Properti ini hanya ada jika manifes ekstensi menyertakan izin "tabs" dan ada navigasi yang tertunda.

• dipasang pin

  boolean

  Apakah tab disematkan.

• dipilih

  boolean

  Tidak digunakan lagi

  Gunakan tabs.Tab.highlighted.

  Apakah tab dipilih.

• sessionId

  string opsional

  ID sesi yang digunakan untuk mengidentifikasi tab secara unik yang diperoleh dari sessions API.

• status

  TabStatus opsional

  Status pemuatan tab.

• judul

  string opsional

  Judul tab. Properti ini hanya ada jika manifes ekstensi menyertakan izin "tabs".

• url

  string opsional

  URL terakhir yang di-commit dari frame utama tab. Properti ini hanya ada jika manifes ekstensi menyertakan izin "tabs" dan dapat berupa string kosong jika tab belum di-commit. Lihat juga Tab.pendingUrl.

• lebar

  number opsional

  Lebar tab dalam piksel.

• windowId

  angka

  ID jendela yang berisi tab.

TabStatus

Chrome 44+

Status pemuatan tab.

Enum

"unloaded"

"loading"

"complete"

WindowType

Chrome 44+

Jenis jendela.

Enum

"normal"

"popup"

"panel"

"app"

"devtools"

ZoomSettings

Menentukan cara perubahan zoom di tab ditangani dan pada cakupan apa.

Properti

• defaultZoomFactor

  number opsional

  Chrome 43+

  Digunakan untuk menampilkan tingkat zoom default untuk tab saat ini dalam panggilan ke tabs.getZoomSettings.

• mode

  ZoomSettingsMode opsional

  Menentukan cara perubahan zoom ditangani, yaitu entitas mana yang bertanggung jawab atas penskalaan halaman yang sebenarnya; defaultnya adalah automatic.

• cakupan

  ZoomSettingsScope opsional

  Menentukan apakah perubahan zoom tetap ada untuk asal halaman, atau hanya berlaku di tab ini; defaultnya adalah per-origin saat dalam mode automatic, dan per-tab jika tidak.

ZoomSettingsMode

Chrome 44+

Menentukan cara perubahan zoom ditangani, yaitu entitas mana yang bertanggung jawab atas penskalaan halaman yang sebenarnya; defaultnya adalah automatic.

Enum

"otomatis"
Perubahan zoom ditangani secara otomatis oleh browser.

"manual"
Mengganti penanganan otomatis perubahan zoom. Peristiwa onZoomChange akan tetap dikirim, dan ekstensi bertanggung jawab untuk memproses peristiwa ini dan menskalakan halaman secara manual. Mode ini tidak mendukung zoom per-origin, sehingga mengabaikan setelan zoom scope dan mengasumsikan per-tab.

"disabled"
Menonaktifkan semua zoom di tab. Tab akan kembali ke tingkat zoom default, dan semua upaya perubahan zoom akan diabaikan.

ZoomSettingsScope

Chrome 44+

Menentukan apakah perubahan zoom tetap ada untuk asal halaman, atau hanya berlaku di tab ini; defaultnya adalah per-origin saat dalam mode automatic, dan per-tab jika tidak.

Enum

"per-origin"
Perubahan zoom tetap ada di origin halaman yang di-zoom, yaitu, semua tab lain yang diarahkan ke origin yang sama juga di-zoom. Selain itu, perubahan zoom per-origin disimpan dengan origin, yang berarti bahwa saat membuka halaman lain di origin yang sama, semua halaman akan di-zoom ke faktor zoom yang sama. Cakupan per-origin hanya tersedia dalam mode automatic.

"per tab"
Perubahan zoom hanya berlaku di tab ini, dan perubahan zoom di tab lain tidak memengaruhi zoom tab ini. Selain itu, perubahan zoom per-tab direset saat navigasi; membuka tab akan selalu memuat halaman dengan faktor zoom per-origin.

Properti

MAX_CAPTURE_VISIBLE_TAB_CALLS_PER_SECOND

Chrome 92+

Frekuensi maksimum captureVisibleTab dapat dipanggil per detik. captureVisibleTab mahal dan tidak boleh terlalu sering dipanggil.

Nilai

2

TAB_ID_NONE

Chrome 46+

ID yang mewakili tidak adanya tab browser.

Nilai

-1

TAB_INDEX_NONE

Chrome 123+

Indeks yang mewakili tidak adanya indeks tab di tab_strip.

Nilai

-1

Metode

captureVisibleTab()

Promise

chrome.tabs.captureVisibleTab(
  windowId?: number,
  options?: ImageDetails,
  callback?: function,
)

Mengambil area yang terlihat dari tab yang saat ini aktif di jendela yang ditentukan. Untuk memanggil metode ini, ekstensi harus memiliki izin <all_urls> atau izin activeTab. Selain situs yang biasanya dapat diakses oleh ekstensi, metode ini memungkinkan ekstensi mengambil situs sensitif yang dibatasi, termasuk halaman chrome:-scheme, halaman ekstensi lainnya, dan URL data:. Situs sensitif ini hanya dapat diambil dengan izin activeTab. URL file hanya dapat diambil jika ekstensi telah diberi akses file.

Parameter

• windowId

  number opsional

  Jendela target. Default-nya adalah jendela saat ini.

• opsi

  ImageDetails opsional

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (dataUrl: string) => void

  • dataUrl

    string

    URL data yang mengenkode gambar area yang terlihat dari tab yang diambil. Dapat ditetapkan ke properti 'src' elemen img HTML untuk ditampilkan.

Hasil

• Promise<string>

  Chrome 88+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

connect()

chrome.tabs.connect(
  tabId: number,
  connectInfo?: object,
)

Menghubungkan ke skrip konten di tab yang ditentukan. Peristiwa runtime.onConnect diaktifkan di setiap skrip konten yang berjalan di tab yang ditentukan untuk ekstensi saat ini. Untuk mengetahui detail selengkapnya, lihat Pesan Skrip Konten.

Parameter

• tabId

  angka

• connectInfo

  objek opsional

  • documentId

    string opsional

    Chrome 106+

    Buka port ke dokumen tertentu yang diidentifikasi oleh documentId, bukan semua frame di tab.

  • frameId

    number opsional

    Membuka port ke frame tertentu yang diidentifikasi oleh frameId, bukan semua frame di tab.

  • nama

    string opsional

    Diteruskan ke onConnect untuk skrip konten yang memproses peristiwa koneksi.

Hasil

• runtime.Port

  Port yang dapat digunakan untuk berkomunikasi dengan skrip konten yang berjalan di tab yang ditentukan. Peristiwa runtime.Port port diaktifkan jika tab ditutup atau tidak ada.

create()

Promise

chrome.tabs.create(
  createProperties: object,
  callback?: function,
)

Membuat tab baru.

Parameter

• createProperties

  objek

  • aktif

    boolean opsional

    Apakah tab harus menjadi tab aktif di jendela. Tidak memengaruhi apakah jendela difokuskan atau tidak (lihat windows.update). Secara default ditetapkan ke true.

  • indeks

    number opsional

    Posisi yang harus diambil tab di jendela. Nilai yang diberikan dibatasi antara nol dan jumlah tab di jendela.

  • openerTabId

    number opsional

    ID tab yang membuka tab ini. Jika ditentukan, tab pembuka harus berada di jendela yang sama dengan tab yang baru dibuat.

  • dipasang pin

    boolean opsional

    Apakah tab harus disematkan. Default-nya adalah false

  • dipilih

    boolean opsional

    Tidak digunakan lagi

    Gunakan active.

    Apakah tab harus menjadi tab yang dipilih di jendela. Default-nya adalah true

  • url

    string opsional

    URL yang akan dituju tab pada awalnya. URL yang sepenuhnya memenuhi syarat harus menyertakan skema (yaitu, 'http://www.google.com', bukan 'www.google.com'). URL relatif bersifat relatif terhadap halaman saat ini dalam ekstensi. Default-nya adalah Halaman Tab Baru.

  • windowId

    number opsional

    Jendela tempat membuat tab baru. Default-nya adalah jendela saat ini.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (tab: Tab) => void

  • tab

    Tab

    Tab yang dibuat.

Hasil

• Promise<Tab>

  Chrome 88+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

detectLanguage()

Promise

chrome.tabs.detectLanguage(
  tabId?: number,
  callback?: function,
)

Mendeteksi bahasa utama konten di tab.

Parameter

• tabId

  number opsional

  Secara default, tab aktif di jendela saat ini.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (language: string) => void

  • language

    string

    Kode bahasa ISO seperti en atau fr. Untuk mengetahui daftar lengkap bahasa yang didukung oleh metode ini, lihat kLanguageInfoTable. Kolom kedua hingga keempat diperiksa dan nilai non-NULL pertama ditampilkan, kecuali untuk bahasa China Sederhana yang menampilkan zh-CN. Untuk bahasa yang tidak diketahui/tidak ditentukan, und akan ditampilkan.

Hasil

• Promise<string>

  Chrome 88+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

discard()

Promise Chrome 54+

chrome.tabs.discard(
  tabId?: number,
  callback?: function,
)

Menghapus tab dari memori. Tab yang dihapus masih terlihat di kolom tab dan dimuat ulang saat diaktifkan.

Parameter

• tabId

  number opsional

  ID tab yang akan dihapus. Jika ditentukan, tab akan dihapus kecuali jika aktif atau sudah dihapus. Jika dihilangkan, browser akan menghapus tab yang paling tidak penting. Tindakan ini dapat gagal jika tidak ada tab yang dapat dihapus.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (tab?: Tab) => void

  • tab

    Tab opsional

    Tab yang dihapus, jika berhasil dihapus; tidak ditentukan jika tidak.

Hasil

• Promise<Tab | undefined>

  Chrome 88+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

duplicate()

Promise

chrome.tabs.duplicate(
  tabId: number,
  callback?: function,
)

Menduplikasi tab.

Parameter

• tabId

  angka

  ID tab yang akan diduplikasi.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (tab?: Tab) => void

  • tab

    Tab opsional

    Detail tentang tab duplikat. Objek tabs.Tab tidak berisi url, pendingUrl, title, dan favIconUrl jika izin "tabs" belum diminta.

Hasil

• Promise<Tab | undefined>

  Chrome 88+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

get()

Promise

chrome.tabs.get(
  tabId: number,
  callback?: function,
)

Mengambil detail tentang tab yang ditentukan.

Parameter

• tabId

  angka

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (tab: Tab) => void

  • tab

    Tab

Hasil

• Promise<Tab>

  Chrome 88+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

getCurrent()

Promise

chrome.tabs.getCurrent(
  callback?: function,
)

Mendapatkan tab tempat panggilan skrip ini dibuat. Menampilkan undefined jika dipanggil dari konteks non-tab (misalnya, halaman latar belakang atau tampilan pop-up).

Parameter

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (tab?: Tab) => void

  • tab

    Tab opsional

Hasil

• Promise<Tab | undefined>

  Chrome 88+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

getZoom()

Promise

chrome.tabs.getZoom(
  tabId?: number,
  callback?: function,
)

Mendapatkan faktor zoom saat ini dari tab yang ditentukan.

Parameter

• tabId

  number opsional

  ID tab untuk mendapatkan faktor zoom saat ini; defaultnya adalah tab aktif dari jendela saat ini.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (zoomFactor: number) => void

  • zoomFactor

    angka

    Faktor zoom tab saat ini.

Hasil

• Promise<number>

  Chrome 88+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

getZoomSettings()

Promise

chrome.tabs.getZoomSettings(
  tabId?: number,
  callback?: function,
)

Mendapatkan setelan zoom saat ini dari tab yang ditentukan.

Parameter

• tabId

  number opsional

  ID tab untuk mendapatkan setelan zoom saat ini; defaultnya adalah tab aktif dari jendela saat ini.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (zoomSettings: ZoomSettings) => void

  • zoomSettings

    ZoomSettings

    Setelan zoom tab saat ini.

Hasil

• Promise<ZoomSettings>

  Chrome 88+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

goBack()

Promise Chrome 72+

chrome.tabs.goBack(
  tabId?: number,
  callback?: function,
)

Kembali ke halaman sebelumnya, jika tersedia.

Parameter

• tabId

  number opsional

  ID tab untuk kembali; secara default ke tab yang dipilih dari jendela saat ini.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  () => void

Hasil

• Promise<void>

  Chrome 88+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

goForward()

Promise Chrome 72+

chrome.tabs.goForward(
  tabId?: number,
  callback?: function,
)

Lanjutkan ke halaman berikutnya, jika tersedia.

Parameter

• tabId

  number opsional

  ID tab untuk menavigasi ke depan; secara default ke tab yang dipilih dari jendela saat ini.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  () => void

Hasil

• Promise<void>

  Chrome 88+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

group()

Promise Chrome 88+

chrome.tabs.group(
  options: object,
  callback?: function,
)

Menambahkan satu atau beberapa tab ke grup yang ditentukan, atau jika tidak ada grup yang ditentukan, menambahkan tab yang diberikan ke grup yang baru dibuat.

Parameter

• opsi

  objek

  • createProperties

    objek opsional

    Konfigurasi untuk membuat grup. Tidak dapat digunakan jika groupId sudah ditentukan.

    • windowId

      number opsional

      Jendela grup baru. Default-nya adalah jendela saat ini.

  • groupId

    number opsional

    ID grup tempat tab akan ditambahkan. Jika tidak ditentukan, grup baru akan dibuat.

  • tabIds

    number | [number, ...number[]]

    ID tab atau daftar ID tab yang akan ditambahkan ke grup yang ditentukan.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (groupId: number) => void

  • groupId

    angka

    ID grup tempat tab ditambahkan.

Hasil

• Promise<number>

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

highlight()

Promise

chrome.tabs.highlight(
  highlightInfo: object,
  callback?: function,
)

Menyoroti tab yang diberikan dan berfokus pada tab pertama dalam grup. Akan tampak tidak melakukan apa pun jika tab yang ditentukan saat ini aktif.

Parameter

• highlightInfo

  objek

  • tab

    number | number[]

    Satu atau beberapa indeks tab yang akan ditandai.

  • windowId

    number opsional

    Jendela yang berisi tab.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (window: Window) => void

  • jendela

    Jendela

    Berisi detail tentang jendela yang tab-nya ditandai.

Hasil

• Promise<windows.Window>

  Chrome 88+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

move()

Promise

chrome.tabs.move(
  tabIds: number | number[],
  moveProperties: object,
  callback?: function,
)

Memindahkan satu atau beberapa tab ke posisi baru dalam jendelanya, atau ke jendela baru. Perhatikan bahwa tab hanya dapat dipindahkan ke dan dari jendela normal (window.type === "normal").

Parameter

• tabIds

  number | number[]

  ID tab atau daftar ID tab yang akan dipindahkan.

• moveProperties

  objek

  • indeks

    angka

    Posisi untuk memindahkan jendela. Gunakan -1 untuk menempatkan tab di akhir jendela.

  • windowId

    number opsional

    Setelan defaultnya adalah jendela tempat tab saat ini berada.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (tabs: Tab | Tab[]) => void

  • tab

    Tab | Tab[]

    Detail tentang tab yang dipindahkan.

Hasil

• Promise<Tab | Tab[]>

  Chrome 88+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

query()

Promise

chrome.tabs.query(
  queryInfo: object,
  callback?: function,
)

Mendapatkan semua tab yang memiliki properti yang ditentukan, atau semua tab jika tidak ada properti yang ditentukan.

Parameter

• queryInfo

  objek

  • aktif

    boolean opsional

    Apakah tab aktif di jendelanya.

  • audible

    boolean opsional

    Chrome 45+

    Apakah tab dapat didengar.

  • autoDiscardable

    boolean opsional

    Chrome 54+

    Apakah tab dapat dihapus secara otomatis oleh browser saat resource hampir habis.

  • currentWindow

    boolean opsional

    Apakah tab berada di jendela saat ini.

  • dihapus

    boolean opsional

    Chrome 54+

    Apakah tab dihapus. Tab yang dihapus adalah tab yang kontennya telah dihapus dari memori, tetapi masih terlihat di strip tab. Kontennya dimuat ulang saat diaktifkan lagi.

  • beku

    boolean opsional

    Tertunda

    Apakah tab dibekukan. Tab yang dibekukan tidak dapat menjalankan tugas, termasuk pengendali peristiwa atau timer. Tab ini terlihat di strip tab dan kontennya dimuat dalam memori. Akun akan diaktifkan kembali saat diaktifkan.

  • groupId

    number opsional

    Chrome 88+

    ID grup tempat tab berada, atau tabGroups.TAB_GROUP_ID_NONE untuk tab yang tidak dikelompokkan.

  • disorot

    boolean opsional

    Apakah tab ditandai.

  • indeks

    number opsional

    Posisi tab dalam jendelanya.

  • lastFocusedWindow

    boolean opsional

    Apakah tab berada di jendela terakhir yang difokuskan.

  • dibisukan

    boolean opsional

    Chrome 45+

    Apakah tab dibisukan.

  • dipasang pin

    boolean opsional

    Apakah tab disematkan.

  • status

    TabStatus opsional

    Status pemuatan tab.

  • judul

    string opsional

    Mencocokkan judul halaman dengan pola. Properti ini diabaikan jika ekstensi tidak memiliki izin "tabs".

  • url

    string | string[] opsional

    Mencocokkan tab dengan satu atau beberapa pola URL. ID fragmen tidak cocok. Properti ini diabaikan jika ekstensi tidak memiliki izin "tabs".

  • windowId

    number opsional

    ID jendela induk, atau windows.WINDOW_ID_CURRENT untuk jendela saat ini.

  • windowType

    WindowType opsional

    Jenis jendela tempat tab berada.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (result: Tab[]) => void

  • hasil

    Tab[]

Hasil

• Promise<Tab[]>

  Chrome 88+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

reload()

Promise

chrome.tabs.reload(
  tabId?: number,
  reloadProperties?: object,
  callback?: function,
)

Muat ulang tab.

Parameter

• tabId

  number opsional

  ID tab yang akan dimuat ulang; default-nya adalah tab yang dipilih dari jendela saat ini.

• reloadProperties

  objek opsional

  • bypassCache

    boolean opsional

    Apakah akan mengabaikan penyimpanan dalam cache lokal. Default-nya adalah false.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  () => void

Hasil

• Promise<void>

  Chrome 88+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

remove()

Promise

chrome.tabs.remove(
  tabIds: number | number[],
  callback?: function,
)

Menutup satu atau beberapa tab.

Parameter

• tabIds

  number | number[]

  ID tab atau daftar ID tab yang akan ditutup.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  () => void

Hasil

• Promise<void>

  Chrome 88+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

sendMessage()

Promise

chrome.tabs.sendMessage(
  tabId: number,
  message: any,
  options?: object,
  callback?: function,
)

Mengirim satu pesan ke skrip konten di tab yang ditentukan, dengan callback opsional yang akan dijalankan saat respons dikirim kembali. Peristiwa runtime.onMessage diaktifkan di setiap skrip konten yang berjalan di tab yang ditentukan untuk ekstensi saat ini.

Parameter

• tabId

  angka

• pesan

  apa pun

  Pesan yang akan dikirim. Pesan ini harus berupa objek yang dapat di-JSON.

• opsi

  objek opsional

  • documentId

    string opsional

    Chrome 106+

    Kirim pesan ke dokumen tertentu yang diidentifikasi oleh documentId, bukan semua frame di tab.

  • frameId

    number opsional

    Kirim pesan ke frame tertentu yang diidentifikasi oleh frameId, bukan semua frame di tab.

• callback

  fungsi opsional

  Chrome 99+

  Parameter callback terlihat seperti:

  (response: any) => void

  • respons

    apa pun

    Objek respons JSON yang dikirim oleh pengendali pesan. Jika terjadi error saat terhubung ke tab yang ditentukan, callback akan dipanggil tanpa argumen dan runtime.lastError ditetapkan ke pesan error.

Hasil

• Promise<any>

  Chrome 99+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

setZoom()

Promise

chrome.tabs.setZoom(
  tabId?: number,
  zoomFactor: number,
  callback?: function,
)

Memperbesar tab yang ditentukan.

Parameter

• tabId

  number opsional

  ID tab yang akan di-zoom; defaultnya adalah tab aktif di jendela saat ini.

• zoomFactor

  angka

  Faktor zoom baru. Nilai 0 menetapkan tab ke faktor zoom default saat ini. Nilai yang lebih besar dari 0 menentukan faktor zoom (mungkin non-default) untuk tab.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  () => void

Hasil

• Promise<void>

  Chrome 88+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

setZoomSettings()

Promise

chrome.tabs.setZoomSettings(
  tabId?: number,
  zoomSettings: ZoomSettings,
  callback?: function,
)

Menetapkan setelan zoom untuk tab yang ditentukan, yang menentukan cara perubahan zoom ditangani. Setelan ini akan direset ke setelan default setelah Anda membuka tab.

Parameter

• tabId

  number opsional

  ID tab yang setelan zoom-nya akan diubah; secara default adalah tab aktif di jendela saat ini.

• zoomSettings

  ZoomSettings

  Menentukan cara perubahan zoom ditangani dan pada cakupan apa.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  () => void

Hasil

• Promise<void>

  Chrome 88+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

ungroup()

Promise Chrome 88+

chrome.tabs.ungroup(
  tabIds: number | [number, ...number[]],
  callback?: function,
)

Menghapus satu atau beberapa tab dari grupnya masing-masing. Jika grup menjadi kosong, grup tersebut akan dihapus.

Parameter

• tabIds

  number | [number, ...number[]]

  ID tab atau daftar ID tab yang akan dihapus dari grupnya masing-masing.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  () => void

Hasil

• Promise<void>

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

update()

Promise

chrome.tabs.update(
  tabId?: number,
  updateProperties: object,
  callback?: function,
)

Mengubah properti tab. Properti yang tidak ditentukan di updateProperties tidak akan diubah.

Parameter

• tabId

  number opsional

  Setelan defaultnya adalah tab yang dipilih dari jendela saat ini.

• updateProperties

  objek

  • aktif

    boolean opsional

    Apakah tab harus aktif. Tidak memengaruhi apakah jendela difokuskan (lihat windows.update).

  • autoDiscardable

    boolean opsional

    Chrome 54+

    Apakah tab harus dihapus secara otomatis oleh browser saat resource rendah.

  • disorot

    boolean opsional

    Menambahkan atau menghapus tab dari pilihan saat ini.

  • dibisukan

    boolean opsional

    Chrome 45+

    Apakah tab harus dibisukan.

  • openerTabId

    number opsional

    ID tab yang membuka tab ini. Jika ditentukan, tab pembuka harus berada di jendela yang sama dengan tab ini.

  • dipasang pin

    boolean opsional

    Apakah tab harus disematkan.

  • dipilih

    boolean opsional

    Tidak digunakan lagi

    Gunakan ditandai.

    Apakah tab harus dipilih.

  • url

    string opsional

    URL yang akan dibuka tab. URL JavaScript tidak didukung; gunakan scripting.executeScript.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (tab?: Tab) => void

  • tab

    Tab opsional

    Detail tentang tab yang diperbarui. Objek tabs.Tab tidak berisi url, pendingUrl, title, dan favIconUrl jika izin "tabs" belum diminta.

Hasil

• Promise<Tab | undefined>

  Chrome 88+

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

Acara

onActivated

chrome.tabs.onActivated.addListener(
  callback: function,
)

Diaktifkan saat tab aktif di jendela berubah. Perhatikan bahwa URL tab mungkin tidak ditetapkan pada saat peristiwa ini diaktifkan, tetapi Anda dapat memproses peristiwa onUpdated agar diberi tahu saat URL ditetapkan.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (activeInfo: object) => void

  • activeInfo

    objek

    • tabId

      angka

      ID tab yang telah aktif.

    • windowId

      angka

      ID jendela tempat tab aktif diubah.

onAttached

chrome.tabs.onAttached.addListener(
  callback: function,
)

Diaktifkan saat tab dilampirkan ke jendela; misalnya, karena dipindahkan antar-jendela.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (tabId: number, attachInfo: object) => void

  • tabId

    angka

  • attachInfo

    objek

    • newPosition

      angka

    • newWindowId

      angka

onCreated

chrome.tabs.onCreated.addListener(
  callback: function,
)

Diaktifkan saat tab dibuat. Perhatikan bahwa URL tab dan keanggotaan grup tab mungkin tidak ditetapkan pada saat peristiwa ini diaktifkan, tetapi Anda dapat memproses peristiwa onUpdated agar diberi tahu saat URL ditetapkan atau tab ditambahkan ke grup tab.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (tab: Tab) => void

  • tab

    Tab

onDetached

chrome.tabs.onDetached.addListener(
  callback: function,
)

Diaktifkan saat tab dilepas dari jendela; misalnya, karena dipindahkan antar-jendela.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (tabId: number, detachInfo: object) => void

  • tabId

    angka

  • detachInfo

    objek

    • oldPosition

      angka

    • oldWindowId

      angka

onHighlighted

chrome.tabs.onHighlighted.addListener(
  callback: function,
)

Diaktifkan saat tab yang ditandai atau dipilih di jendela berubah.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (highlightInfo: object) => void

  • highlightInfo

    objek

    • tabIds

      number[]

      Semua tab yang ditandai di jendela.

    • windowId

      angka

      Jendela yang tab-nya berubah.

onMoved

chrome.tabs.onMoved.addListener(
  callback: function,
)

Diaktifkan saat tab dipindahkan dalam jendela. Hanya satu peristiwa pemindahan yang diaktifkan, yang mewakili tab yang dipindahkan langsung oleh pengguna. Peristiwa pemindahan tidak diaktifkan untuk tab lain yang harus dipindahkan sebagai respons terhadap tab yang dipindahkan secara manual. Peristiwa ini tidak diaktifkan saat tab dipindahkan antar-jendela; untuk mengetahui detailnya, lihat tabs.onDetached.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (tabId: number, moveInfo: object) => void

  • tabId

    angka

  • moveInfo

    objek

    • fromIndex

      angka

    • toIndex

      angka

    • windowId

      angka

onRemoved

chrome.tabs.onRemoved.addListener(
  callback: function,
)

Diaktifkan saat tab ditutup.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (tabId: number, removeInfo: object) => void

  • tabId

    angka

  • removeInfo

    objek

    • isWindowClosing

      boolean

      Benar jika tab ditutup karena jendela induknya ditutup.

    • windowId

      angka

      Jendela yang tab-nya ditutup.

onReplaced

chrome.tabs.onReplaced.addListener(
  callback: function,
)

Diaktifkan saat tab diganti dengan tab lain karena pra-rendering atau instan.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (addedTabId: number, removedTabId: number) => void

  • addedTabId

    angka

  • removedTabId

    angka

onUpdated

chrome.tabs.onUpdated.addListener(
  callback: function,
)

Diaktifkan saat tab diperbarui.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (tabId: number, changeInfo: object, tab: Tab) => void

  • tabId

    angka

  • changeInfo

    objek

    • audible

      boolean opsional

      Chrome 45+

      Status tab yang dapat didengar baru.

    • autoDiscardable

      boolean opsional

      Chrome 54+

      Status baru tab yang dapat dihapus secara otomatis.

    • dihapus

      boolean opsional

      Chrome 54+

      Status baru tab yang dihapus.

    • favIconUrl

      string opsional

      URL favicon baru tab.

    • beku

      boolean opsional

      Tertunda

      Status beku baru tab.

    • groupId

      number opsional

      Chrome 88+

      Grup baru tab.

    • mutedInfo

      MutedInfo opsional

      Chrome 46+

      Status bisu baru tab dan alasan perubahannya.

    • dipasang pin

      boolean opsional

      Status baru tab yang disematkan.

    • status

      TabStatus opsional

      Status pemuatan tab.

    • judul

      string opsional

      Chrome 48+

      Judul baru tab.

    • url

      string opsional

      URL tab jika telah berubah.

  • tab

    Tab

onZoomChange

chrome.tabs.onZoomChange.addListener(
  callback: function,
)

Diaktifkan saat tab diperbesar.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (ZoomChangeInfo: object) => void

  • ZoomChangeInfo

    objek

    • newZoomFactor

      angka

    • oldZoomFactor

      angka

    • tabId

      angka

    • zoomSettings

      ZoomSettings