chrome.app.window

Deskripsi

Gunakan chrome.app.window API untuk membuat jendela. Jendela memiliki frame opsional dengan panel judul dan kontrol ukuran. Cookie ini tidak dikaitkan dengan jendela browser Chrome mana pun. Lihat Contoh Status Jendela untuk melihat demonstrasi opsi ini.

Jenis

AppWindow

Properti

  • contentWindow

    Jendela

    Objek 'window' JavaScript untuk anak yang dibuat.

  • id

    string

    ID yang digunakan untuk membuat jendela.

  • innerBounds

    Batas

    Posisi, ukuran, dan batasan konten jendela, yang tidak mencakup dekorasi jendela. Properti ini baru di Chrome 36.

  • outerBounds

    Batas

    Posisi, ukuran, dan batasan jendela, yang mencakup dekorasi jendela, seperti kolom judul dan frame. Properti ini baru di Chrome 36.

  • clearAttention

    void

    Perhatian yang jelas pada jendela.

    Fungsi clearAttention akan terlihat seperti: 

    () => {...}

  • tutup

    void

    Tutup jendela.

    Fungsi close akan terlihat seperti: 

    () => {...}

  • drawAttention

    void

    Tarik perhatian ke jendela.

    Fungsi drawAttention akan terlihat seperti: 

    () => {...}

  • fokus

    void

    Fokuskan jendela.

    Fungsi focus akan terlihat seperti: 

    () => {...}

  • layar penuh

    void

    Membuat jendela menjadi layar penuh.

    Pengguna akan dapat memulihkan jendela dengan menekan ESC. Aplikasi dapat mencegah keluar dari status layar penuh saat ESC ditekan dengan meminta izin app.window.fullscreen.overrideEsc dan membatalkan peristiwa dengan memanggil .preventDefault(), di handler keydown dan keyup, seperti ini:

    window.onkeydown = window.onkeyup = function(e) { if (e.keyCode == 27 /* ESC *\/) { e.preventDefault(); } };

    Catatan window.fullscreen() akan menyebabkan seluruh jendela menjadi layar penuh dan tidak memerlukan gestur pengguna. HTML5 fullscreen API juga dapat digunakan untuk memasuki mode layar penuh (lihat Web API untuk mengetahui detail selengkapnya).

    Fungsi fullscreen akan terlihat seperti: 

    () => {...}

  • getBounds

    void

    Tidak digunakan lagi

    Gunakan innerBounds atau outerBounds.

    Mendapatkan batas dalam jendela sebagai objek ContentBounds.

    Fungsi getBounds akan terlihat seperti: 

    () => {...}

  • sembunyikan

    void

    Sembunyikan jendela. Tidak melakukan apa pun jika jendela sudah disembunyikan.

    Fungsi hide akan terlihat seperti: 

    () => {...}

  • isAlwaysOnTop

    void

    Apakah jendela selalu berada di atas?

    Fungsi isAlwaysOnTop akan terlihat seperti: 

    () => {...}

    • return

      boolean

  • isFullscreen

    void

    Apakah jendela dalam layar penuh? Nilai ini akan benar jika jendela telah dibuat dalam layar penuh atau dibuat dalam layar penuh melalui AppWindow atau API layar penuh HTML5.

    Fungsi isFullscreen akan terlihat seperti: 

    () => {...}

    • return

      boolean

  • isMaximized

    void

    Apakah jendela dimaksimalkan?

    Fungsi isMaximized akan terlihat seperti: 

    () => {...}

    • return

      boolean

  • isMinimized

    void

    Apakah jendela diminimalkan?

    Fungsi isMinimized akan terlihat seperti: 

    () => {...}

    • return

      boolean

  • memaksimalkan

    void

    Maksimalkan jendela.

    Fungsi maximize akan terlihat seperti: 

    () => {...}

  • meminimalkan

    void

    Minimalkan jendela.

    Fungsi minimize akan terlihat seperti: 

    () => {...}

  • moveTo

    void

    Tidak digunakan lagi sejak Chrome 43

    Gunakan outerBounds.

    Pindahkan jendela ke posisi (left, top).

    Fungsi moveTo akan terlihat seperti: 

    (left: number, top: number) => {...}

    • kiri

      angka

    • atas

      angka

  • resizeTo

    void

    Tidak digunakan lagi sejak Chrome 43

    Gunakan outerBounds.

    Ubah ukuran jendela menjadi widthxheight piksel.

    Fungsi resizeTo akan terlihat seperti: 

    (width: number, height: number) => {...}

    • lebar

      angka

    • tinggi

      angka

  • pulihkan

    void

    Memulihkan jendela, keluar dari status dimaksimalkan, diperkecil, atau layar penuh.

    Fungsi restore akan terlihat seperti: 

    () => {...}

  • setAlwaysOnTop

    void

    Menetapkan apakah jendela harus tetap berada di atas sebagian besar jendela lainnya. Memerlukan izin alwaysOnTopWindows.

    Fungsi setAlwaysOnTop akan terlihat seperti: 

    (alwaysOnTop: boolean) => {...}

    • alwaysOnTop

      boolean

  • setBounds

    void

    Tidak digunakan lagi

    Gunakan innerBounds atau outerBounds.

    Menetapkan batas dalam jendela.

    Fungsi setBounds akan terlihat seperti: 

    (bounds: ContentBounds) => {...}

  • setVisibleOnAllWorkspaces

    void

    Menetapkan apakah jendela terlihat di semua ruang kerja. (Hanya untuk platform yang mendukungnya).

    Fungsi setVisibleOnAllWorkspaces akan terlihat seperti: 

    (alwaysVisible: boolean) => {...}

    • alwaysVisible

      boolean

  • tunjukkan

    void

    Tampilkan jendela. Tidak melakukan apa pun jika jendela sudah terlihat. Fokuskan jendela jika focused disetel ke benar (true) atau dihilangkan.

    Fungsi show akan terlihat seperti: 

    (focused?: boolean) => {...}

    • fokus

      boolean opsional

Bounds

Properti

  • tinggi

    angka

    Properti ini dapat digunakan untuk membaca atau menulis tinggi konten atau jendela saat ini.

  • kiri

    angka

    Properti ini dapat digunakan untuk membaca atau menulis koordinat X konten atau jendela saat ini.

  • maxHeight

    nomor opsional

    Properti ini dapat digunakan untuk membaca atau menulis tinggi maksimum konten atau jendela saat ini. Nilai null menunjukkan 'tidak ditentukan'.

  • maxWidth

    nomor opsional

    Properti ini dapat digunakan untuk membaca atau menulis lebar maksimum konten atau jendela saat ini. Nilai null menunjukkan 'tidak ditentukan'.

  • minHeight

    nomor opsional

    Properti ini dapat digunakan untuk membaca atau menulis tinggi minimum konten atau jendela saat ini. Nilai null menunjukkan 'tidak ditentukan'.

  • minWidth

    nomor opsional

    Properti ini dapat digunakan untuk membaca atau menulis lebar minimum konten atau jendela saat ini. Nilai null menunjukkan 'tidak ditentukan'.

  • atas

    angka

    Properti ini dapat digunakan untuk membaca atau menulis koordinat Y konten atau jendela saat ini.

  • lebar

    angka

    Properti ini dapat digunakan untuk membaca atau menulis lebar konten atau jendela saat ini.

  • setMaximumSize

    void

    Menetapkan batasan ukuran maksimum konten atau jendela. Lebar atau tinggi maksimum dapat disetel ke null untuk menghapus batasan. Nilai undefined tidak akan mengubah batasan.

    Fungsi setMaximumSize akan terlihat seperti: 

    (maxWidth: number, maxHeight: number) => {...}

    • maxWidth

      angka

    • maxHeight

      angka

  • setMinimumSize

    void

    Menetapkan batasan ukuran minimum konten atau jendela. Lebar atau tinggi minimum dapat disetel ke null untuk menghapus batasan. Nilai undefined tidak akan mengubah batasan.

    Fungsi setMinimumSize akan terlihat seperti: 

    (minWidth: number, minHeight: number) => {...}

    • minWidth

      angka

    • minHeight

      angka

  • setPosition

    void

    Menetapkan posisi kiri dan atas konten atau jendela.

    Fungsi setPosition akan terlihat seperti: 

    (left: number, top: number) => {...}

    • kiri

      angka

    • atas

      angka

  • setSize

    void

    Menetapkan lebar dan tinggi konten atau jendela.

    Fungsi setSize akan terlihat seperti: 

    (width: number, height: number) => {...}

    • lebar

      angka

    • tinggi

      angka

BoundsSpecification

Properti

  • tinggi

    nomor opsional

    Tinggi konten atau jendela.

  • kiri

    nomor opsional

    Koordinat X konten atau jendela.

  • maxHeight

    nomor opsional

    Tinggi maksimum konten atau jendela.

  • maxWidth

    nomor opsional

    Lebar maksimum konten atau jendela.

  • minHeight

    nomor opsional

    Tinggi minimum konten atau jendela.

  • minWidth

    nomor opsional

    Lebar minimum konten atau jendela.

  • atas

    nomor opsional

    Koordinat Y konten atau jendela.

  • lebar

    nomor opsional

    Lebar konten atau jendela.

ContentBounds

Properti

  • tinggi

    nomor opsional

  • kiri

    nomor opsional

  • atas

    nomor opsional

  • lebar

    nomor opsional

CreateWindowOptions

Properti

  • alwaysOnTop

    boolean opsional

    Jika benar (true), jendela akan tetap berada di atas sebagian besar jendela lainnya. Jika ada beberapa jendela semacam ini, jendela yang saat ini difokuskan akan berada di latar depan. Memerlukan izin alwaysOnTopWindows. Nilai defaultnya adalah false (salah).

    Panggil setAlwaysOnTop() di jendela untuk mengubah properti ini setelah dibuat.

  • batas

    ContentBounds opsional

    Tidak digunakan lagi

    Gunakan innerBounds atau outerBounds.

    Ukuran dan posisi konten di jendela (tidak termasuk titlebar). Jika ID juga ditentukan dan jendela dengan ID yang cocok telah ditampilkan sebelumnya, batas jendela yang diingat akan digunakan.

  • fokus

    boolean opsional

    Jika benar, jendela akan difokuskan saat dibuat. Nilai defaultnya adalah true (benar).

  • bingkai

    string | FrameOptions opsional

    Jenis frame: none atau chrome (defaultnya chrome). Untuk none, properti CSS -webkit-app-region dapat digunakan untuk menerapkan kemampuan penarikan ke jendela aplikasi. -webkit-app-region: drag dapat digunakan untuk menandai wilayah yang dapat ditarik. no-drag dapat digunakan untuk menonaktifkan gaya ini pada elemen bertingkat.

    Penggunaan FrameOptions baru di M36.

  • tersembunyi

    boolean opsional

    Jika benar, jendela akan dibuat dalam keadaan tersembunyi. Panggil show() di jendela untuk menampilkannya setelah dibuat. Nilai defaultnya adalah false (salah).

  • ikon

    string opsional

    Chrome 54+

    URL ikon jendela. Jendela dapat memiliki ikonnya sendiri jika showInShelf disetel ke benar (true). URL harus berupa URL global atau URL lokal ekstensi.

  • id

    string opsional

    ID untuk mengidentifikasi jendela. ID ini akan digunakan untuk mengingat ukuran dan posisi jendela serta memulihkan geometri tersebut saat jendela dengan ID yang sama dibuka nanti. Jika jendela dengan ID tertentu dibuat saat jendela lain dengan ID yang sama sudah ada, jendela yang saat ini terbuka akan difokuskan, bukan membuat jendela baru.

  • innerBounds

    BoundsSpecification opsional

    Digunakan untuk menentukan posisi awal, ukuran awal, dan batasan konten jendela (tidak termasuk dekorasi jendela). Jika id juga ditentukan dan jendela dengan id yang cocok telah ditampilkan sebelumnya, batas yang diingat akan digunakan.

    Perhatikan bahwa padding antara batas dalam dan luar ditentukan oleh OS. Oleh karena itu, menetapkan properti batas yang sama untuk innerBounds dan outerBounds akan menghasilkan error.

    Properti ini baru di Chrome 36.

  • maxHeight

    nomor opsional

    Tidak digunakan lagi

    Gunakan innerBounds atau outerBounds.

    Tinggi maksimum jendela.

  • maxWidth

    nomor opsional

    Tidak digunakan lagi

    Gunakan innerBounds atau outerBounds.

    Lebar maksimum jendela.

  • minHeight

    nomor opsional

    Tidak digunakan lagi

    Gunakan innerBounds atau outerBounds.

    Tinggi minimum jendela.

  • minWidth

    nomor opsional

    Tidak digunakan lagi

    Gunakan innerBounds atau outerBounds.

    Lebar minimum jendela.

  • outerBounds

    BoundsSpecification opsional

    Digunakan untuk menentukan posisi awal, ukuran awal, dan batasan jendela (termasuk dekorasi jendela seperti kolom judul dan frame). Jika id juga ditentukan dan jendela dengan id yang cocok telah ditampilkan sebelumnya, batas yang diingat akan digunakan.

    Perhatikan bahwa padding antara batas dalam dan luar ditentukan oleh OS. Oleh karena itu, menetapkan properti batas yang sama untuk innerBounds dan outerBounds akan menghasilkan error.

    Properti ini baru di Chrome 36.

  • resizable

    boolean opsional

    Jika benar, jendela dapat diubah ukurannya oleh pengguna. Nilai defaultnya adalah true (benar).

  • showInShelf

    boolean opsional

    Chrome 54+

    Jika benar (true), jendela akan memiliki ikon raknya sendiri. Jika tidak, jendela akan dikelompokkan di panel dengan jendela lain yang terkait dengan aplikasi. Nilai defaultnya adalah salah (false). Jika showInShelf disetel ke benar (true), Anda harus menentukan ID untuk jendela.

  • singleton

    boolean opsional

    Tidak digunakan lagi

    Beberapa jendela dengan ID yang sama tidak lagi didukung.

    Secara default, jika Anda menentukan ID untuk jendela, jendela hanya akan dibuat jika jendela lain dengan ID yang sama belum ada. Jika jendela dengan ID yang sama sudah ada, jendela tersebut akan diaktifkan. Jika ingin membuat beberapa jendela dengan ID yang sama, Anda dapat menyetel properti ini ke false.

  • dengan status tersembunyi akhir

    Negara bagian opsional

    Status awal jendela, yang memungkinkan jendela dibuat dalam layar penuh, dimaksimalkan, atau diminimalkan. Nilai defaultnya adalah 'normal'.

  • jenis

    WindowType opsional

    Chrome 45+ Tidak digunakan lagi sejak Chrome 69

    Semua jendela aplikasi menggunakan jenis jendela 'shell'

    Jenis jendela yang akan dibuat.

  • visibleOnAllWorkspaces

    boolean opsional

    Jika benar, dan didukung oleh platform, jendela akan terlihat di semua ruang kerja.

FrameOptions

Properti

  • activeColor

    string opsional

    Memungkinkan warna bingkai jendela saat aktif ditetapkan. Pewarnaan bingkai hanya tersedia jika jenis bingkai adalah chrome.

    Pewarnaan bingkai hanya tersedia jika jenis bingkai adalah chrome.

    Pewarnaan frame baru di Chrome 36.

  • warna

    string opsional

    Memungkinkan warna frame ditetapkan. Pewarnaan bingkai hanya tersedia jika jenis bingkai adalah chrome.

    Pewarnaan frame baru di Chrome 36.

  • inactiveColor

    string opsional

    Memungkinkan warna bingkai jendela saat tidak aktif disetel berbeda dengan warna aktif. Pewarnaan bingkai hanya tersedia jika jenis bingkai adalah chrome.

    inactiveColor harus digunakan bersama dengan color.

    Pewarnaan frame baru di Chrome 36.

  • jenis

    string opsional

    Jenis frame: none atau chrome (defaultnya chrome).

    Untuk none, properti CSS -webkit-app-region dapat digunakan untuk menerapkan kemampuan ditarik ke jendela aplikasi.

    -webkit-app-region: drag dapat digunakan untuk menandai wilayah yang dapat ditarik. no-drag dapat digunakan untuk menonaktifkan gaya ini pada elemen bertingkat.

State

Status jendela: normal, layar penuh, dimaksimalkan, diminimalkan.

Enum

"normal"

"fullscreen"

"dimaksimalkan"

"diminimalkan"

WindowType

Chrome 45+

Menentukan jenis jendela yang akan dibuat.

Enum

"shell"
Jenis jendela default.

"panel"
Jendela yang dikelola OS (Tidak digunakan lagi).

Metode

canSetVisibleOnAllWorkspaces()

chrome.app.window.canSetVisibleOnAllWorkspaces(): boolean

Apakah platform saat ini mendukung jendela yang terlihat di semua ruang kerja.

Hasil

  • boolean

create()

Janji 
chrome.app.window.create(
  url: string,
  options?: CreateWindowOptions,
  callback?: function,
): Promise<AppWindow>

Ukuran dan posisi jendela dapat ditentukan dengan berbagai cara. Opsi paling sederhana adalah tidak menentukan apa pun, yang dalam hal ini ukuran default dan posisi yang bergantung pada platform akan digunakan.

Untuk menetapkan posisi, ukuran, dan batasan jendela, gunakan properti innerBounds atau outerBounds. Batas dalam tidak menyertakan dekorasi jendela. Batas luar mencakup frame dan panel judul jendela. Perhatikan bahwa padding antara batas dalam dan luar ditentukan oleh OS. Oleh karena itu, menyetel properti yang sama untuk batas dalam dan luar dianggap sebagai error (misalnya, menyetel innerBounds.left dan outerBounds.left).

Untuk mengingat posisi jendela secara otomatis, Anda dapat memberikan ID ke jendela tersebut. Jika jendela memiliki ID, ID ini digunakan untuk mengingat ukuran dan posisi jendela setiap kali jendela dipindahkan atau diubah ukurannya. Ukuran dan posisi ini kemudian digunakan, bukan batas yang ditentukan pada pembukaan jendela berikutnya dengan ID yang sama. Jika Anda perlu membuka jendela dengan ID di lokasi selain default yang diingat, Anda dapat membuatnya tersembunyi, memindahkannya ke lokasi yang diinginkan, lalu menampilkannya.

Parameter

Hasil

  • Promise<AppWindow>

    Chrome 117+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

current()

chrome.app.window.current(): AppWindow | undefined

Menampilkan objek AppWindow untuk konteks skrip saat ini (yaitu objek 'window' JavaScript). Hal ini juga dapat dipanggil pada handle ke konteks skrip untuk halaman lain, misalnya: otherWindow.chrome.app.window.current().

Hasil

get()

chrome.app.window.get(
  id: string,
): AppWindow | undefined

Mendapatkan AppWindow dengan ID yang ditentukan. Jika tidak ada jendela dengan ID yang diberikan, null akan ditampilkan. Metode ini baru di Chrome 33.

Parameter

  • id

    string

Hasil

getAll()

chrome.app.window.getAll(): AppWindow[]

Mendapatkan array dari semua jendela aplikasi yang saat ini dibuat. Metode ini baru di Chrome 33.

Hasil

Acara

onBoundsChanged

chrome.app.window.onBoundsChanged.addListener(
  callback: function,
)

Diaktifkan saat jendela diubah ukurannya.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    () => void

onClosed

chrome.app.window.onClosed.addListener(
  callback: function,
)

Diaktifkan saat jendela ditutup. Perhatikan, peristiwa ini harus didengarkan dari jendela selain jendela yang ditutup, misalnya dari halaman latar belakang. Hal ini karena jendela yang ditutup akan dalam proses penutupan saat peristiwa dipicu, yang berarti tidak semua API dalam konteks skrip jendela akan berfungsi.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    () => void

onFullscreened

chrome.app.window.onFullscreened.addListener(
  callback: function,
)

Diaktifkan saat jendela ditampilkan dalam layar penuh (baik melalui API AppWindow maupun HTML5).

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    () => void

onMaximized

chrome.app.window.onMaximized.addListener(
  callback: function,
)

Diaktifkan saat jendela dimaksimalkan.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    () => void

onMinimized

chrome.app.window.onMinimized.addListener(
  callback: function,
)

Diaktifkan saat jendela diminimalkan.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    () => void

onRestored

chrome.app.window.onRestored.addListener(
  callback: function,
)

Diaktifkan saat jendela dipulihkan dari status diminimalkan atau dimaksimalkan.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    () => void