Badge untuk ikon aplikasi

App Badging API memungkinkan aplikasi web terinstal menyetel badge di seluruh aplikasi pada ikon aplikasi.

Pete LePage

Apa itu App Badging API?

Contoh Twitter dengan delapan notifikasi dan aplikasi lainnya menampilkan badge jenis bendera.
Contoh Twitter dengan delapan notifikasi dan aplikasi lain yang menampilkan badge jenis tanda.

App Badging API memungkinkan aplikasi web yang diinstal untuk menetapkan badge seluruh aplikasi, yang ditampilkan di tempat khusus sistem operasi yang terkait dengan aplikasi (seperti galeri atau layar utama).

Badge memudahkan pengguna memberi tahu pengguna bahwa ada aktivitas baru yang mungkin memerlukan perhatian mereka, atau untuk menunjukkan sejumlah kecil informasi, seperti jumlah belum dibaca.

Badge cenderung lebih mudah digunakan daripada notifikasi, dan dapat diperbarui dengan frekuensi yang jauh lebih tinggi, karena tidak mengganggu pengguna. Selain itu, karena tidak mengganggu pengguna, snackbar tidak memerlukan izin pengguna.

Kemungkinan kasus penggunaan

Contoh aplikasi yang mungkin menggunakan API ini antara lain:

  • Aplikasi chat, email, dan media sosial, untuk memberi sinyal bahwa pesan baru telah masuk, atau untuk menampilkan jumlah item yang belum dibaca.
  • Aplikasi produktivitas, untuk memberi sinyal bahwa tugas latar belakang yang berjalan lama (seperti merender gambar atau video) telah selesai.
  • Game, untuk memberi sinyal bahwa tindakan pemain diperlukan (misalnya, dalam Catur, saat giliran pemain).

Dukungan

App Badging API berfungsi di Windows dan macOS, di Chrome 81 dan Edge 81 atau yang lebih baru. Dukungan untuk ChromeOS sedang dalam pengembangan dan akan tersedia di rilis mendatang. Di Android, Badging API tidak didukung. Sebagai gantinya, Android akan otomatis menampilkan badge pada ikon aplikasi untuk aplikasi web yang diinstal saat ada notifikasi yang belum dibaca, seperti untuk aplikasi Android.

Coba

  1. Buka demo App Badging API.
  2. Saat diminta, klik Instal untuk menginstal aplikasi, atau gunakan menu Chrome untuk menginstalnya.
  3. Buka sebagai PWA yang diinstal. Perlu diperhatikan bahwa aplikasi harus berjalan sebagai PWA yang terinstal (di taskbar atau dok Anda).
  4. Klik tombol Set atau Clear untuk menetapkan atau menghapus badge dari ikon aplikasi. Anda juga dapat memberikan angka untuk Nilai badge.

Cara menggunakan App Badging API

Untuk menggunakan App Badging API, aplikasi web Anda harus memenuhi kriteria kemampuan penginstalan Chrome, dan pengguna harus menambahkannya ke layar utama mereka.

Badge API terdiri dari dua metode di navigator:

  • setAppBadge(number): Menetapkan badge aplikasi. Jika nilai diberikan, tetapkan badge ke nilai yang diberikan. Jika tidak, tampilkan titik putih biasa (atau tanda lainnya yang sesuai dengan platform). Menetapkan number ke 0 sama dengan memanggil clearAppBadge().
  • clearAppBadge(): Menghapus badge aplikasi.

Keduanya menampilkan promise kosong yang dapat Anda gunakan untuk penanganan error.

Badge dapat ditetapkan dari halaman saat ini, atau dari pekerja layanan yang terdaftar. Untuk menetapkan atau menghapus badge (di halaman latar depan atau pekerja layanan), panggil:

// Set the badge
const unreadCount = 24;
navigator.setAppBadge(unreadCount).catch((error) => {
  //Do something with the error.
});

// Clear the badge
navigator.clearAppBadge().catch((error) => {
  // Do something with the error.
});

Dalam beberapa kasus, sistem operasi mungkin tidak mengizinkan representasi badge yang tepat. Dalam kasus tersebut, browser akan berupaya memberikan representasi terbaik untuk perangkat tersebut. Misalnya, karena Badging API tidak didukung di Android, Android hanya akan menampilkan titik, bukan nilai numerik.

Jangan berasumsi apa pun tentang cara agen pengguna menampilkan badge. Beberapa agen pengguna mungkin mengambil angka seperti "4000" dan menulis ulang sebagai "99+". Jika Anda sendiri mengisi badge (misalnya dengan menyetelnya ke "99"), "+" tidak akan muncul. Apa pun jumlahnya, cukup panggil setAppBadge(unreadCount) dan biarkan agen pengguna menangani penayangannya sebagaimana mestinya.

Meskipun App Badging API di Chrome memerlukan aplikasi terinstal, Anda tidak boleh melakukan panggilan ke Badging API yang bergantung pada status penginstalan. Cukup panggil API jika ada, karena browser lain mungkin menampilkan badge di tempat lain. Jika berhasil, berarti berhasil. Jika tidak, halaman tersebut tidak akan diindeks.

Menetapkan dan menghapus badge di latar belakang dari pekerja layanan

Anda juga dapat menetapkan badge aplikasi di latar belakang menggunakan pekerja layanan. Lakukan hal ini melalui sinkronisasi latar belakang berkala, Push API, atau kombinasi keduanya.

Sinkronisasi berkala latar belakang

Sinkronisasi berkala di latar belakang memungkinkan pekerja layanan melakukan polling pada server secara berkala, yang dapat digunakan untuk mendapatkan status terbaru, dan memanggil navigator.setAppBadge().

Namun, frekuensi pemanggilan sinkronisasi tidak sepenuhnya dapat diandalkan, dan dipanggil atas pertimbangan browser.

Web Push API

Push API memungkinkan server mengirim pesan ke pekerja layanan, yang dapat menjalankan kode JavaScript meskipun tidak ada halaman latar depan yang berjalan. Dengan demikian, push server dapat memperbarui badge dengan memanggil navigator.setAppBadge().

Namun, sebagian besar browser, termasuk Chrome, mewajibkan notifikasi untuk ditampilkan setiap kali pesan push diterima. Hal ini tidak masalah untuk beberapa kasus penggunaan (misalnya menampilkan notifikasi saat memperbarui badge), tetapi tidak memungkinkan untuk memperbarui badge secara halus tanpa menampilkan notifikasi.

Selain itu, pengguna harus memberikan izin notifikasi situs Anda agar dapat menerima pesan push.

Kombinasi keduanya

Meskipun tidak sempurna, penggunaan Push API dan sinkronisasi latar belakang berkala secara bersamaan dapat memberikan solusi yang baik. Informasi prioritas tinggi dikirim melalui Push API, yang menampilkan notifikasi dan memperbarui badge. Dan informasi dengan prioritas yang lebih rendah dikirim dengan memperbarui badge, baik saat halaman terbuka, maupun melalui sinkronisasi latar belakang berkala.

Masukan

Tim Chrome ingin mengetahui pengalaman Anda saat menggunakan App Badging API.

Ceritakan kepada kami tentang desain API

Apakah ada sesuatu di API yang tidak berfungsi seperti yang Anda harapkan? Atau, apakah ada metode atau properti yang hilang yang diperlukan untuk menerapkan ide Anda? Apakah Anda memiliki pertanyaan atau komentar mengenai model keamanan?

Melaporkan masalah terkait penerapan

Apakah Anda menemukan bug pada penerapan Chrome? Atau apakah implementasinya berbeda dengan spesifikasi?

  • Laporkan bug di https://new.crbug.com. Pastikan untuk menyertakan detail sebanyak mungkin, petunjuk sederhana untuk mereproduksi, dan tetapkan Komponen ke UI>Browser>WebAppInstalls. Glitch sangat cocok untuk membagikan reproduksi yang cepat dan mudah.

Menunjukkan dukungan untuk API

Berencana untuk menggunakan App Badging API di situs Anda? Dukungan publik Anda membantu tim Chrome memprioritaskan fitur, dan menunjukkan kepada vendor browser lain betapa penting dukungan untuk mereka.

  • Kirim tweet ke @ChromiumDev menggunakan hashtag #BadgingAPI dan beri tahu kami tempat dan cara Anda menggunakannya.

Link bermanfaat

Foto hero oleh Prateek Katyal di Unsplash