chrome.app.window

Deskripsi

Gunakan chrome.app.window API untuk membuat jendela. Windows memiliki bingkai opsional dengan bilah judul dan kontrol ukuran. Jendela tersebut tidak dikaitkan dengan jendela browser Chrome apa pun. Lihat Contoh Status Jendela untuk demonstrasi opsi ini.

Jenis

AppWindow

Properti

  • contentWindow

    Jendela

    Objek 'window' JavaScript untuk turunan yang dibuat.

  • id

    string

    ID yang digunakan untuk membuat jendela.

  • innerBounds

    Batas

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

  • outerBounds

    Batas

    Posisi, ukuran, dan batasan jendela, yang termasuk dekorasi jendela, seperti bilah judul dan bingkai. Properti ini baru di Chrome 36.

  • clearAttention

    void

    Hapus perhatian ke jendela.

    Fungsi clearAttention terlihat seperti: 

    ()=> {...}

  • tutup

    void

    Tutup jendela.

    Fungsi close terlihat seperti: 

    ()=> {...}

  • drawAttention

    void

    Tarik perhatian ke jendela.

    Fungsi drawAttention terlihat seperti: 

    ()=> {...}

  • focus

    void

    Memfokuskan jendela.

    Fungsi focus terlihat seperti: 

    ()=> {...}

  • layar penuh

    void

    Jendela layar penuh.

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

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

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

    Fungsi fullscreen terlihat seperti: 

    ()=> {...}

  • getBounds

    void

    Tidak digunakan lagi

    Menggunakan innerBounds atau outerBounds.

    Mendapatkan batas dalam jendela sebagai objek ContentBounds.

    Fungsi getBounds terlihat seperti: 

    ()=> {...}

  • sembunyikan

    void

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

    Fungsi hide terlihat seperti: 

    ()=> {...}

  • isAlwaysOnTop

    void

    Apakah jendela selalu di atas?

    Fungsi isAlwaysOnTop terlihat seperti: 

    ()=> {...}

    • akan menampilkan

      boolean

  • isFullscreen

    void

    Apakah jendelanya layar penuh? Hal ini akan berlaku jika jendela dibuat dalam mode layar penuh atau dibuat menjadi layar penuh melalui API layar penuh AppWindow atau HTML5.

    Fungsi isFullscreen terlihat seperti: 

    ()=> {...}

    • akan menampilkan

      boolean

  • isMaximized

    void

    Apakah jendela sudah dimaksimalkan?

    Fungsi isMaximized terlihat seperti: 

    ()=> {...}

    • akan menampilkan

      boolean

  • isMinimized

    void

    Apakah jendelanya diminimalkan?

    Fungsi isMinimized terlihat seperti: 

    ()=> {...}

    • akan menampilkan

      boolean

  • perbesar

    void

    Maksimalkan jendela.

    Fungsi maximize terlihat seperti: 

    ()=> {...}

  • minimalkan

    void

    Minimalkan jendela.

    Fungsi minimize terlihat seperti: 

    ()=> {...}

  • moveTo

    void

    Tidak digunakan lagi sejak Chrome 43

    Gunakan outerBounds.

    Pindahkan jendela ke posisi (left, top).

    Fungsi moveTo terlihat seperti: 

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

    • left

      angka

    • paruh pertama inning

      angka

  • resizeTo

    void

    Tidak digunakan lagi sejak Chrome 43

    Gunakan outerBounds.

    Ubah ukuran jendela menjadi widthxheight piksel.

    Fungsi resizeTo terlihat seperti: 

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

    • lebar

      angka

    • tinggi

      angka

  • pulihkan

    void

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

    Fungsi restore terlihat seperti: 

    ()=> {...}

  • setAlwaysOnTop

    void

    Tetapkan apakah jendela harus tetap berada di atas sebagian besar jendela lain. Memerlukan izin alwaysOnTopWindows.

    Fungsi setAlwaysOnTop terlihat seperti: 

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

    • alwaysOnTop

      boolean

  • setBounds

    void

    Tidak digunakan lagi

    Menggunakan innerBounds atau outerBounds.

    Menetapkan batas dalam jendela.

    Fungsi setBounds terlihat seperti: 

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

  • setVisibleOnAllWorkspaces

    void

    Tetapkan apakah jendela terlihat di semua ruang kerja. (Hanya untuk platform yang mendukung fitur ini).

    Fungsi setVisibleOnAllWorkspaces terlihat seperti: 

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

    • alwaysVisible

      boolean

  • tunjukkan

    void

    Menampilkan jendela. Tidak melakukan apa-apa jika jendela sudah terlihat. Memfokuskan jendela jika focused disetel ke benar (true) atau dihilangkan.

    Fungsi show terlihat seperti: 

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

    • terfokus

      boolean opsional

Bounds

Properti

  • tinggi

    angka

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

  • left

    angka

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

  • maxHeight

    nomor opsional

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

  • maxWidth

    nomor opsional

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

  • minHeight

    nomor opsional

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

  • minWidth

    nomor opsional

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

  • paruh pertama inning

    angka

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

  • 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 terlihat seperti: 

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

    • maxWidth

      angka

    • maxHeight

      angka

  • setMinimumSize

    void

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

    Fungsi setMinimumSize terlihat seperti: 

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

    • minWidth

      angka

    • minHeight

      angka

  • setPosition

    void

    Tetapkan posisi kiri dan atas konten atau jendela.

    Fungsi setPosition terlihat seperti: 

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

    • left

      angka

    • paruh pertama inning

      angka

  • setSize

    void

    Setel lebar dan tinggi konten atau jendela.

    Fungsi setSize terlihat seperti: 

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

    • lebar

      angka

    • tinggi

      angka

BoundsSpecification

Properti

  • tinggi

    nomor opsional

    Tinggi konten atau jendela.

  • left

    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.

  • paruh pertama inning

    nomor opsional

    Koordinat Y konten atau jendela.

  • lebar

    nomor opsional

    Lebar konten atau jendela.

ContentBounds

Properti

  • tinggi

    nomor opsional

  • left

    nomor opsional

  • paruh pertama inning

    nomor opsional

  • lebar

    nomor opsional

CreateWindowOptions

Properti

  • alwaysOnTop

    boolean opsional

    Jika true (benar), jendela akan tetap berada di atas sebagian besar jendela lain. Jika ada beberapa jendela yang seperti 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

    Menggunakan innerBounds atau outerBounds.

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

  • terfokus

    boolean opsional

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

  • menyesuaikan posisi bingkai

    string|FrameOptions opsional

    Jenis frame: none atau chrome (default-nya adalah chrome). Untuk none, properti CSS -webkit-app-region dapat digunakan untuk menerapkan kemampuan tarik 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 true (benar), jendela akan dibuat dalam status tersembunyi. Panggil show() pada jendela untuk menampilkannya setelah dibuat. Nilai defaultnya adalah false (salah).

  • ikon

    string opsional

    Chrome 54+

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

  • id

    string opsional

    ID untuk mengidentifikasi jendela. Fungsi 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 dibuka 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 di 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

    Menggunakan innerBounds atau outerBounds.

    Tinggi maksimum jendela.

  • maxWidth

    nomor opsional

    Tidak digunakan lagi

    Menggunakan innerBounds atau outerBounds.

    Lebar maksimum jendela.

  • minHeight

    nomor opsional

    Tidak digunakan lagi

    Menggunakan innerBounds atau outerBounds.

    Tinggi minimum jendela.

  • minWidth

    nomor opsional

    Tidak digunakan lagi

    Menggunakan innerBounds atau outerBounds.

    Lebar minimum jendela.

  • outerBounds

    BoundsSpecification opsional

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

    Perhatikan bahwa padding di 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 true (benar), jendela akan dapat diubah ukurannya oleh pengguna. Nilai defaultnya adalah true (benar).

  • showInShelf

    boolean opsional

    Chrome 54+

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

  • 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 menetapkan properti ini ke false.

  • state

    Negara bagian opsional

    Status awal jendela, yang memungkinkannya dibuat dalam mode layar penuh, dimaksimalkan, atau diperkecil. Nilai defaultnya adalah 'normal'.

  • tipe

    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 true (benar), dan didukung oleh platform, jendela akan terlihat di semua ruang kerja.

FrameOptions

Properti

  • activeColor

    string opsional

    Mengizinkan warna bingkai jendela saat aktif untuk disetel. Pewarnaan bingkai hanya tersedia jika jenis frame adalah chrome.

    Pewarnaan bingkai hanya tersedia jika jenis frame adalah chrome.

    Pewarnaan bingkai masih baru di Chrome 36.

  • warna

    string opsional

    Mengizinkan warna bingkai untuk disetel. Pewarnaan bingkai hanya tersedia jika jenis frame adalah chrome.

    Pewarnaan bingkai masih baru di Chrome 36.

  • inactiveColor

    string opsional

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

    inactiveColor harus digunakan bersama dengan color.

    Pewarnaan bingkai masih baru di Chrome 36.

  • tipe

    string opsional

    Jenis frame: none atau chrome (default-nya adalah chrome).

    Untuk none, properti CSS -webkit-app-region dapat digunakan untuk menerapkan kemampuan tarik 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

Keadaan jendela: normal, layar penuh, dimaksimalkan, diperkecil.

Enum

"normal"

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()

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

Hasil

  • boolean

create()

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

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

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

Untuk mengingat posisi jendela secara otomatis, Anda dapat memberikan ID. Jika jendela memiliki ID, ID ini digunakan untuk mengingat ukuran dan posisi jendela setiap kali dipindahkan atau diubah ukurannya. Ukuran dan posisi ini kemudian digunakan, bukan batas yang ditentukan, pada pembukaan jendela berikutnya dengan ID yang sama. Jika 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 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

current()

chrome.app.window.current()

Menampilkan objek AppWindow untuk konteks skrip saat ini (yaitu objek 'window' JavaScript). 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,
)

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

Parameter

  • id

    string

Hasil

getAll()

chrome.app.window.getAll()

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

Hasil

Peristiwa

onBoundsChanged

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

Diaktifkan saat ukuran jendela diubah.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    ()=>void

onClosed

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

Diaktifkan saat jendela ditutup. Perhatikan bahwa ini harus didengarkan dari jendela selain jendela yang ditutup, misalnya dari halaman latar belakang. Hal ini karena jendela yang ditutup akan sedang dalam proses dihapus saat peristiwa diaktifkan, 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 dalam mode layar penuh (baik melalui AppWindow API atau HTML5 API).

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 diperkecil.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    ()=>void

onRestored

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

Diaktifkan saat jendela dipulihkan agar tidak diminimalkan atau dimaksimalkan.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    ()=>void