Halaman ini diterjemahkan oleh Cloud Translation API.

chrome.windows

Deskripsi

Gunakan chrome.windows API untuk berinteraksi dengan jendela browser. Anda dapat menggunakan API ini untuk membuat, mengubah, dan menyusun ulang jendela di browser.

Izin

Jika diminta, windows.Window berisi array objek tabs.Tab. Anda harus mendeklarasikan izin "tabs" dalam manifest jika Anda memerlukan akses ke properti url, pendingUrl, title, atau favIconUrl dari tabs.Tab. Contoh:

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

Konsep dan penggunaan

Jendela saat ini

Banyak fungsi dalam sistem ekstensi menggunakan argumen windowId opsional, yang secara default adalah jendela saat ini.

Jendela saat ini adalah jendela yang berisi kode yang sedang dieksekusi. Penting untuk menyadari bahwa hal ini dapat berbeda dari jendela teratas atau jendela yang difokuskan.

Misalnya, ekstensi membuat beberapa tab atau jendela dari satu file HTML, dan file HTML tersebut berisi panggilan ke tabs.query(). Jendela saat ini adalah jendela yang berisi halaman yang melakukan panggilan, apa pun jendela teratasnya.

Dalam kasus service worker, nilai jendela saat ini akan kembali ke jendela aktif terakhir. Dalam beberapa situasi, mungkin tidak ada jendela saat ini untuk halaman latar belakang.

Contoh

Untuk mencoba API ini, instal contoh API windows dari repositori chrome-extension-samples.

Dua jendela, masing-masing dengan satu tab.

Jenis

CreateType

Chrome 44+

Menentukan jenis jendela browser yang akan dibuat. 'panel' sudah tidak digunakan lagi dan hanya tersedia untuk ekstensi yang sudah ada dalam daftar yang diizinkan di ChromeOS.

Enum

"normal"
Menentukan jendela sebagai jendela standar.

"popup"
Menentukan jendela sebagai jendela pop-up.

"panel"
Menentukan jendela sebagai panel.

QueryOptions

Chrome 88+

Properti

mengisi

boolean opsional

Jika benar, objek windows.Window memiliki properti tabs yang berisi daftar objek tabs.Tab. Objek Tab hanya berisi properti url, pendingUrl, title, dan favIconUrl jika file manifes ekstensi menyertakan izin "tabs".
windowTypes

WindowType[] opsional

Jika disetel, windows.Window yang ditampilkan akan difilter berdasarkan jenisnya. Jika tidak disetel, filter default akan ditetapkan ke ['normal', 'popup'].

Window

Properti

alwaysOnTop

boolean

Apakah jendela disetel agar selalu berada di atas.
fokus

boolean

Apakah jendela saat ini adalah jendela yang difokuskan.
tinggi

nomor opsional

Tinggi jendela, termasuk frame, dalam piksel. Dalam beberapa situasi, jendela mungkin tidak diberi properti height; misalnya, saat mengkueri jendela tertutup dari sessions API.
id

nomor opsional

ID jendela. ID jendela bersifat unik dalam sesi browser. Dalam beberapa keadaan, jendela mungkin tidak diberi properti ID; misalnya, saat mengkueri jendela menggunakan sessions API, dalam hal ini ID sesi mungkin ada.
samaran

boolean

Apakah jendela dalam mode samaran.
kiri

nomor opsional

Offset jendela dari tepi kiri layar dalam piksel. Dalam beberapa situasi, jendela mungkin tidak diberi properti left; misalnya, saat mengkueri jendela tertutup dari sessions API.
sessionId

string opsional

ID sesi yang digunakan untuk mengidentifikasi jendela secara unik, yang diperoleh dari API sessions.
dengan status tersembunyi akhir

WindowState opsional

Status jendela browser ini.
tab

Tab[] opsional

Array objek tabs.Tab yang mewakili tab saat ini di jendela.
atas

nomor opsional

Offset jendela dari tepi atas layar dalam piksel. Dalam beberapa situasi, jendela mungkin tidak diberi properti top; misalnya, saat mengkueri jendela tertutup dari sessions API.
jenis

WindowType opsional

Jenis jendela browser ini.
lebar

nomor opsional

Lebar jendela, termasuk frame, dalam piksel. Dalam beberapa situasi, jendela mungkin tidak diberi properti width; misalnya, saat mengkueri jendela tertutup dari sessions API.

WindowState

Chrome 44+

Status jendela browser ini. Dalam beberapa situasi, jendela mungkin tidak diberi properti state; misalnya, saat mengkueri jendela tertutup dari sessions API.

Enum

"normal"
Status jendela normal (tidak diminimalkan, dimaksimalkan, atau layar penuh).

"minimized"
Status jendela yang diperkecil.

"dimaksimalkan"
Status jendela yang dimaksimalkan.

"fullscreen"
Status jendela layar penuh.

"locked-fullscreen"
Status jendela layar penuh terkunci. Status layar penuh ini tidak dapat dihentikan oleh tindakan pengguna dan hanya tersedia untuk ekstensi yang diizinkan di Chrome OS.

WindowType

Chrome 44+

Jenis jendela browser ini. Dalam beberapa situasi, jendela mungkin tidak diberi properti type; misalnya, saat mengkueri jendela yang tertutup dari sessions API.

Enum

"normal"
Jendela browser normal.

"popup"
Pop-up browser.

"panel"
Tidak digunakan lagi di API ini. Jendela gaya panel Aplikasi Chrome. Ekstensi hanya dapat melihat jendela panelnya sendiri.

"app"
Tidak digunakan lagi di API ini. Jendela Aplikasi Chrome. Ekstensi hanya dapat melihat jendela aplikasinya sendiri.

"devtools"
Jendela Developer Tools.

Properti

WINDOW_ID_CURRENT

Nilai windowId yang merepresentasikan jendela saat ini.

Nilai

-2

WINDOW_ID_NONE

Nilai windowId yang menunjukkan tidak adanya jendela browser Chrome.

Nilai

-1

Metode

create()

chrome.windows.create(
  createData?: object,
): Promise<Window | undefined>

Membuat (membuka) jendela browser baru dengan ukuran, posisi, atau URL default opsional yang diberikan.

Parameter

createData

objek opsional
- fokus
  
  boolean opsional
  
  Jika true, akan membuka jendela aktif. Jika false, membuka jendela yang tidak aktif.
- tinggi
  
  nomor opsional
  
  Tinggi jendela baru dalam piksel, termasuk frame. Jika tidak ditentukan, defaultnya adalah tinggi alami.
- samaran
  
  boolean opsional
  
  Apakah jendela baru harus berupa jendela samaran.
- kiri
  
  nomor opsional
  
  Jumlah piksel untuk memosisikan jendela baru dari tepi kiri layar. Jika tidak ditentukan, jendela baru akan diimbangi secara alami dari jendela terakhir yang difokuskan. Nilai ini diabaikan untuk panel.
- setSelfAsOpener
  
  boolean opsional
  
  Chrome 64+
  
  Jika true, 'window.opener' jendela yang baru dibuat disetel ke pemanggil dan berada di unit konteks penjelajahan terkait yang sama dengan pemanggil.
- dengan status tersembunyi akhir
  
  WindowState opsional
  
  Chrome 44+
  
  Status awal jendela. Status minimized, maximized, dan fullscreen tidak dapat digabungkan dengan left, top, width, atau height.
- tabId
  
  nomor opsional
  
  ID tab yang akan ditambahkan ke jendela baru.
- atas
  
  nomor opsional
  
  Jumlah piksel untuk memosisikan jendela baru dari tepi atas layar. Jika tidak ditentukan, jendela baru akan diimbangi secara alami dari jendela terakhir yang difokuskan. Nilai ini diabaikan untuk panel.
- jenis
  
  CreateType opsional
  
  Menentukan jenis jendela browser yang akan dibuat.
- url
  
  string | string[] opsional
  
  URL atau array URL yang akan dibuka sebagai tab di jendela. URL yang sepenuhnya memenuhi syarat harus menyertakan skema, misalnya, 'http://www.google.com', bukan 'www.google.com'. URL yang tidak sepenuhnya memenuhi syarat dianggap relatif dalam ekstensi. Default-nya adalah Halaman Tab Baru.
- lebar
  
  nomor opsional
  
  Lebar jendela baru dalam piksel, termasuk frame. Jika tidak ditentukan, defaultnya adalah lebar alami.

Hasil

Promise<Window | undefined>

Chrome 88+

get()

chrome.windows.get(
  windowId: number,
  queryOptions?: QueryOptions,
): Promise<Window>

Mendapatkan detail tentang jendela.

Parameter

windowId

angka
queryOptions

QueryOptions opsional

Chrome 88+

Hasil

Promise<Window>

Chrome 88+

getAll()

chrome.windows.getAll(
  queryOptions?: QueryOptions,
): Promise<Window[]>

Mendapatkan semua jendela.

Parameter

queryOptions

QueryOptions opsional

Chrome 88+

Hasil

Promise<Window[]>

Chrome 88+

getCurrent()

chrome.windows.getCurrent(
  queryOptions?: QueryOptions,
): Promise<Window>

Mendapatkan jendela saat ini.

Parameter

queryOptions

QueryOptions opsional

Chrome 88+

Hasil

Promise<Window>

Chrome 88+

getLastFocused()

chrome.windows.getLastFocused(
  queryOptions?: QueryOptions,
): Promise<Window>

Mendapatkan jendela yang terakhir kali difokuskan — biasanya jendela 'di atas'.

Parameter

queryOptions

QueryOptions opsional

Chrome 88+

Hasil

Promise<Window>

Chrome 88+

remove()

chrome.windows.remove(
  windowId: number,
): Promise<void>

Menghapus (menutup) jendela dan semua tab di dalamnya.

Parameter

windowId

angka

Hasil

Promise<void>

Chrome 88+

update()

chrome.windows.update(
  windowId: number,
  updateInfo: object,
): Promise<Window>

Memperbarui properti jendela. Tentukan hanya properti yang akan diubah; properti yang tidak ditentukan tidak akan berubah.

Parameter

windowId

angka
updateInfo

objek
- drawAttention
  
  boolean opsional
  
  Jika true, menyebabkan jendela ditampilkan dengan cara yang menarik perhatian pengguna ke jendela, tanpa mengubah jendela yang difokuskan. Efek ini berlangsung hingga pengguna mengubah fokus ke jendela. Opsi ini tidak berpengaruh jika jendela sudah memiliki fokus. Setel ke false untuk membatalkan permintaan drawAttention sebelumnya.
- fokus
  
  boolean opsional
  
  Jika true, akan menampilkan jendela ke depan; tidak dapat digabungkan dengan status 'dikecilkan'. Jika false, akan memunculkan jendela berikutnya dalam urutan z ke depan; tidak dapat digabungkan dengan status 'fullscreen' atau 'maximized'.
- tinggi
  
  nomor opsional
  
  Tinggi untuk mengubah ukuran jendela dalam piksel. Nilai ini diabaikan untuk panel.
- kiri
  
  nomor opsional
  
  Offset dari tepi kiri layar untuk memindahkan jendela ke dalam piksel. Nilai ini diabaikan untuk panel.
- dengan status tersembunyi akhir
  
  WindowState opsional
  
  Status baru jendela. Status 'dikecilkan', 'dimaksimalkan', dan 'layar penuh' tidak dapat digabungkan dengan 'kiri', 'atas', 'lebar', atau 'tinggi'.
- atas
  
  nomor opsional
  
  Offset dari tepi atas layar untuk memindahkan jendela ke dalam piksel. Nilai ini diabaikan untuk panel.
- lebar
  
  nomor opsional
  
  Lebar untuk mengubah ukuran jendela dalam piksel. Nilai ini diabaikan untuk panel.

Hasil

Promise<Window>

Chrome 88+

Acara

onBoundsChanged

Chrome 86+

chrome.windows.onBoundsChanged.addListener(
  callback: function,
)

Diaktifkan saat jendela diubah ukurannya; peristiwa ini hanya dikirim saat batas baru diterapkan, dan bukan untuk perubahan yang sedang berlangsung.

Parameter

callback

fungsi

Parameter callback terlihat seperti:
```
(window: Window) => void
```
- jendela
  
  Window

onCreated

chrome.windows.onCreated.addListener(
  callback: function,
  filters?: object,
)

Diaktifkan saat jendela dibuat.

Parameter

callback

fungsi

Chrome 46+

Parameter callback terlihat seperti:
```
(window: Window) => void
```
- jendela
  
  Window
  
  Detail jendela yang dibuat.
filter

objek opsional
- windowTypes
  
  WindowType[]
  
  Kondisi yang harus dipenuhi oleh jenis jendela yang dibuat. Secara default, nilai ini memenuhi ['normal', 'popup'].

onFocusChanged

chrome.windows.onFocusChanged.addListener(
  callback: function,
  filters?: object,
)

Diaktifkan saat jendela yang saat ini difokuskan berubah. Menampilkan chrome.windows.WINDOW_ID_NONE jika semua jendela Chrome kehilangan fokus. Catatan: Di beberapa pengelola jendela Linux, WINDOW_ID_NONE selalu dikirimkan tepat sebelum peralihan dari satu jendela Chrome ke jendela Chrome lainnya.

Parameter

callback

fungsi

Chrome 46+

Parameter callback terlihat seperti:
```
(windowId: number) => void
```
- windowId
  
  angka
  
  ID jendela yang baru difokuskan.
filter

objek opsional
- windowTypes
  
  WindowType[]
  
  Kondisi yang harus dipenuhi oleh jenis jendela yang dihapus. Secara default, nilai ini memenuhi ['normal', 'popup'].

onRemoved

chrome.windows.onRemoved.addListener(
  callback: function,
  filters?: object,
)

Diaktifkan saat jendela dihapus (ditutup).

Parameter

callback

fungsi

Chrome 46+

Parameter callback terlihat seperti:
```
(windowId: number) => void
```
- windowId
  
  angka
  
  ID jendela yang dihapus.
filter

objek opsional
- windowTypes
  
  WindowType[]
  
  Kondisi yang harus dipenuhi oleh jenis jendela yang dihapus. Secara default, nilai ini memenuhi ['normal', 'popup'].

chrome.windows Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Deskripsi

Izin

Konsep dan penggunaan

Jendela saat ini

Contoh

Jenis

CreateType

Enum

QueryOptions

Properti

Window

Properti

WindowState

Enum

WindowType

Enum

Properti

WINDOW_ID_CURRENT

Nilai

WINDOW_ID_NONE

Nilai

Metode

create()

Parameter

Hasil

get()

Parameter

Hasil

getAll()

Parameter

Hasil

getCurrent()

Parameter

Hasil

getLastFocused()

Parameter

Hasil

remove()

Parameter

Hasil

update()

Parameter

Hasil

Acara

onBoundsChanged

Parameter

onCreated

Parameter

onFocusChanged

Parameter

onRemoved

Parameter

chrome.windows