Kontrol penuh dengan VirtualKeyboard API

Thomas Steiner

Perangkat seperti tablet atau ponsel biasanya memiliki keyboard virtual untuk mengetik teks. Tidak seperti keyboard fisik yang selalu ada dan selalu sama, keyboard virtual muncul dan menghilang, bergantung pada tindakan pengguna, yang juga dapat beradaptasi secara dinamis, misalnya, berdasarkan atribut inputmode.

Fleksibilitas ini memiliki konsekuensi bahwa mesin tata letak browser harus diberi tahu tentang kehadiran keyboard virtual dan berpotensi perlu menyesuaikan tata letak dokumen untuk mengkompensasi. Misalnya, kolom input yang akan diketik pengguna mungkin terhalang oleh keyboard virtual, sehingga browser harus men-scroll ke tampilan.

Secara tradisional, browser telah menangani tantangan ini sendiri, tetapi aplikasi yang lebih kompleks mungkin memerlukan lebih banyak kontrol atas perilaku browser. Contohnya mencakup perangkat seluler multilayar dengan pendekatan tradisional yang akan menghasilkan ruang layar yang "terbuang" jika keyboard virtual hanya ditampilkan di satu segmen layar, tetapi jika area pandang yang tersedia diperkecil di kedua layar tersebut. Gambar di bawah menunjukkan cara VirtualKeyboard API dapat digunakan untuk mengoptimalkan tata letak dokumen secara dinamis untuk mengimbangi kehadiran keyboard virtual.

Dalam situasi seperti ini, VirtualKeyboard API dapat digunakan. Ini terdiri dari tiga bagian:

• Antarmuka VirtualKeyboard pada objek navigator untuk akses terprogram ke keyboard virtual dari JavaScript.
• Kumpulan variabel lingkungan CSS yang memberikan informasi tentang tampilan keyboard virtual.
• Kebijakan keyboard virtual yang menentukan apakah keyboard virtual harus ditampilkan.

Status saat ini

VirtualKeyboard API tersedia dari Chromium 94 di desktop dan perangkat seluler.

Deteksi fitur dan dukungan browser

Untuk mendeteksi apakah VirtualKeyboard API didukung di browser saat ini, gunakan cuplikan berikut:

if ('virtualKeyboard' in navigator) {
  // The VirtualKeyboard API is supported!
}

Menggunakan VirtualKeyboard API

VirtualKeyboard API menambahkan antarmuka baru VirtualKeyboard ke objek navigator.

Memilih untuk menggunakan perilaku keyboard virtual baru

Untuk memberi tahu browser bahwa Anda menangani oklusi keyboard virtual sendiri, Anda harus mengaktifkan perilaku keyboard virtual baru terlebih dahulu dengan menetapkan properti boolean overlaysContent ke true.

navigator.virtualKeyboard.overlaysContent = true;

Menampilkan dan menyembunyikan keyboard virtual

Anda dapat menampilkan keyboard virtual secara terprogram dengan memanggil metode show()-nya. Agar berfungsi, elemen yang difokuskan harus berupa kontrol formulir (seperti elemen textarea), atau menjadi host pengeditan (misalnya, dengan menggunakan atribut contenteditable). Metode ini selalu menampilkan undefined, tetapi memicu peristiwa geometrychange jika keyboard virtual sebelumnya tidak ditampilkan.

navigator.virtualKeyboard.show();

Untuk menyembunyikan keyboard virtual, panggil metode hide(). Metode ini selalu menampilkan undefined, tetapi memicu peristiwa geometrychange jika keyboard virtual sebelumnya ditampilkan.

navigator.virtualKeyboard.hide();

Mendapatkan geometri saat ini

Anda bisa mendapatkan geometri keyboard virtual saat ini dengan melihat properti boundingRect. Fungsi ini mengekspos dimensi keyboard virtual saat ini sebagai objek DOMRect. Inset sesuai dengan properti atas, kanan, bawah, dan/atau kiri.

const { x, y, width, height } = navigator.virtualKeyboard.boundingRect;
console.log('Virtual keyboard geometry:', x, y, width, height);

Diberi tahu tentang perubahan geometri

Setiap kali keyboard virtual muncul atau menghilang, peristiwa geometrychange akan dikirim. Properti target peristiwa berisi objek virtualKeyboard yang (seperti yang dibahas di atas) berisi geometri baru inset keyboard virtual sebagai DOMRect.

navigator.virtualKeyboard.addEventListener('geometrychange', (event) => {
  const { x, y, width, height } = event.target.boundingRect;
  console.log('Virtual keyboard geometry changed:', x, y, width, height);
});

Variabel lingkungan CSS

VirtualKeyboard API mengekspos serangkaian variabel lingkungan CSS yang memberikan informasi tentang tampilan keyboard virtual. Properti tersebut dimodelkan mirip dengan properti CSS inset, yaitu sesuai dengan properti atas, kanan, bawah, dan/atau kiri.

• keyboard-inset-top
• keyboard-inset-right
• keyboard-inset-bottom
• keyboard-inset-left
• keyboard-inset-width
• keyboard-inset-height

Inset keyboard virtual adalah enam variabel lingkungan yang menentukan persegi panjang dengan inset atas, kanan, bawah, dan kiri dari tepi area pandang. Inset lebar dan tinggi dihitung dari inset lain untuk ergonomi developer. Nilai default setiap inset keyboard adalah 0px jika nilai penggantian tidak diberikan.

Anda biasanya akan menggunakan variabel lingkungan seperti dalam contoh di bawah ini:

.some-class {
  /**
   * Use a margin that corresponds to the virtual keyboard's height
   * if the virtual keyboard is shown, else use the fallback value of `50px`.
   */
  margin-block-end: env(keyboard-inset-height, 50px);
}

.some-other-class {
  /**
   * Use a margin that corresponds to the virtual keyboard's height
   * if the virtual keyboard is shown, else use the default fallback value of `0px`.
   */
  margin-block-end: env(keyboard-inset-height);
}

Kebijakan keyboard virtual

Terkadang keyboard virtual tidak akan muncul saat elemen yang dapat diedit difokuskan. Contohnya adalah aplikasi spreadsheet tempat pengguna dapat mengetuk sel agar nilainya disertakan dalam formula sel lain. virtualkeyboardpolicy adalah atribut yang kata kuncinya adalah string auto dan manual. Jika ditentukan pada elemen yang merupakan host contenteditable, auto akan menyebabkan elemen yang dapat diedit yang sesuai otomatis menampilkan keyboard virtual saat difokuskan atau diketuk, dan manual memisahkan fokus dan ketuk pada elemen yang dapat diedit dari perubahan dalam status keyboard virtual saat ini.

<!-- Do nothing on regular focus, but show the virtual keyboard on double-click. -->
<div
  contenteditable
  virtualkeyboardpolicy="manual"
  inputmode="text"
  ondblclick="navigator.virtualKeyboard.show();"
>
  Double-click to edit.
</div>

Demo

Anda dapat melihat cara kerja VirtualKeyboard API dalam demo di Glitch. Pastikan untuk menjelajahi kode sumber untuk melihat cara penerapannya. Meskipun peristiwa geometrychange dapat diamati dalam penyematan iframe, perilaku keyboard virtual yang sebenarnya memerlukan pembukaan demo di tab browsernya sendiri.

Link penting

• Spesifikasi
• Repositori
• Entri ChromeStatus
• Bug Chromium
• Peninjauan TAG W3C
• Permintaan posisi standar Mozilla
• Permintaan posisi standar WebKit

Ucapan terima kasih

VirtualKeyboard API ditentukan oleh Anupam Snigdha dari Microsoft, dengan kontribusi dari mantan editor Grisha Lyukshin, yang juga berasal dari Microsoft.