Manifes aplikasi web

Manifes aplikasi web adalah file yang dibuat yang memberi tahu browser bagaimana Anda ingin konten web ditampilkan sebagai aplikasi dalam sistem operasi. Manifes dapat mencakup informasi dasar seperti nama, ikon, dan warna tema aplikasi; preferensi lanjutan, seperti orientasi yang diinginkan dan pintasan aplikasi; serta metadata katalog, seperti screenshot.

Setiap PWA harus menyertakan satu manifes per aplikasi, biasanya dihosting di folder root, dan ditautkan di semua halaman HTML tempat PWA Anda dapat diinstal. Ekstensi resminya adalah .webmanifest, jadi Anda dapat memberi nama manifes seperti app.webmanifest.

Menambahkan manifes aplikasi web ke PWA

Untuk membuat manifes aplikasi web, pertama-tama buat file teks dengan objek JSON yang berisi setidaknya kolom name dengan nilai string:

app.webmanifest:

{
   "name": "My First Application"
}

Namun, membuat file saja tidak cukup, browser juga perlu mengetahui keberadaan file tersebut.

Menautkan ke manifes Anda

Agar browser mengetahui manifes aplikasi web Anda, Anda perlu menautkannya ke PWA menggunakan elemen HTML <link> dan atribut rel yang disetel ke manifest di semua halaman HTML PWA Anda. Cara ini mirip dengan menautkan stylesheet CSS ke dokumen.

index.html:

<html lang="en">
  <title>This is my first PWA</title>
  <link rel="manifest" href="/app.webmanifest">

Men-debug manifes

Untuk memastikan manifes disiapkan dengan benar, Anda bisa menggunakan Inspector di Firefox dan DevTools di setiap browser berbasis Chromium.

Untuk browser Chromium

Di DevTools

  1. Di panel kiri, pada bagian Application, pilih Manifest.
  2. Periksa kolom manifes sebagaimana diuraikan oleh browser.

Untuk Firefox

  1. Buka Pemeriksa.
  2. Buka tab Application.
  3. Pilih opsi Manifes di panel kiri.
  4. Periksa kolom manifes sebagaimana diuraikan oleh browser.

Mendesain pengalaman PWA Anda

Setelah PWA Anda terhubung ke manifesnya, saatnya mengisi kolom lainnya untuk menentukan pengalaman bagi pengguna Anda.

Kolom dasar

Kumpulan kolom pertama menampilkan informasi inti tentang PWA Anda. Aplikasi ini digunakan untuk membuat ikon dan jendela PWA yang diinstal dan menentukan cara PWA dimulai. Faktor-faktor tersebut adalah:

name
Nama lengkap PWA Anda. Tombol tersebut akan muncul bersama dengan ikon di layar utama, peluncur, dok, atau menu sistem operasi.
short_name
Opsional, nama yang lebih pendek dari PWA Anda, digunakan jika tidak ada cukup ruang untuk menampilkan nilai penuh kolom name. Buat judul kurang dari 12 karakter untuk meminimalkan kemungkinan pemotongan.
icons
Array objek ikon dengan kolom src, type, sizes, dan purpose opsional, yang menjelaskan gambar yang harus mewakili PWA.
start_url
URL yang harus dimuat PWA saat pengguna memulainya dari ikon yang diinstal. Jalur absolut direkomendasikan, jadi jika halaman beranda PWA adalah root situs, Anda dapat menetapkannya ke'/' untuk membukanya saat aplikasi dimulai. Jika Anda tidak memberikan URL mulai, browser dapat menggunakan URL tempat PWA diinstal sebagai awal. Elemen ini dapat berupa deep link, seperti detail produk, bukan layar utama Anda.
display
Salah satu dari fullscreen, standalone, minimal-ui, atau browser, yang menjelaskan cara OS menggambar jendela PWA. Anda dapat membaca selengkapnya tentang berbagai mode tampilan di bab Desain Aplikasi. Sebagian besar kasus penggunaan menerapkan standalone.
id
String yang secara unik mengidentifikasi PWA ini terhadap PWA lain yang mungkin dihosting di origin yang sama. Jika tidak ditetapkan, start_url akan digunakan sebagai nilai penggantian. Perlu diingat bahwa dengan mengubah start_url di masa mendatang (seperti saat mengubah nilai string kueri), Anda dapat menghapus kemampuan browser untuk mendeteksi bahwa PWA sudah diinstal.

Ikon

Ikon PWA Anda adalah identitas visualnya di seluruh perangkat pengguna Anda saat diinstal, jadi penting untuk menentukan setidaknya satu ikon. Karena properti icons adalah kumpulan objek ikon, Anda dapat menentukan beberapa ikon dalam berbagai format untuk memberikan pengalaman ikon terbaik bagi pengguna. Setiap browser akan memilih satu atau beberapa ikon berdasarkan kebutuhan dan sistem operasi tempatnya diinstal, ikon yang lebih dekat dengan spesifikasi yang dibutuhkan.

Jika Anda hanya perlu memilih satu ukuran ikon, maka harus 512 x 512 piksel. Namun, sebaiknya berikan lebih banyak ukuran, termasuk gambar berukuran 192 x 192, 384 x 384, dan 1024 x 1024.

"icons": [
   {
      "src": "icons/512.png",
      "type": "image/png",
      "sizes": "512x512"
   },
   {
      "src": "icons/1024.png",
      "type": "image/png",
      "sizes": "1024x1024"
   }
]

Jika Anda tidak memberikan ikon atau ikon tidak dalam ukuran yang direkomendasikan, pada beberapa platform Anda tidak akan lulus kriteria penginstalan. Di platform lain, ikon akan dibuat secara otomatis, misalnya dari screenshot PWA atau dengan menggunakan ikon umum.

Ikon yang dapat disamarkan

Beberapa sistem operasi, seperti Android, menyesuaikan ikon dengan berbagai ukuran dan bentuk. Misalnya, di Android 12, berbagai produsen atau setelan dapat mengubah bentuk ikon dari lingkaran, kotak, menjadi persegi dengan sudut membulat. Untuk mendukung jenis ikon adaptif ini, Anda dapat menyediakan ikon maskable menggunakan kolom purpose.

Untuk melakukannya, sediakan file gambar persegi yang ikon utamanya terdapat dalam "zona aman", yaitu lingkaran yang berpusat pada ikon dengan radius 40 persen dari lebar ikon. (Lihat gambar di bawah.) Perangkat yang mendukung ikon yang dapat disamarkan akan menyamarkan ikon Anda sesuai kebutuhan.

Area aman ditandai sebagai lingkaran di tengah radius 40 persen dalam ikon persegi

Berikut adalah contoh ikon maskable yang dirender dalam sejumlah bentuk yang biasa digunakan:

Dalam gambar berikut, jika Anda menggunakan ikon di sebelah kiri sebagai ikon maskable, Anda akan mendapatkan hasil yang buruk pada perangkat saat mask bentuk diterapkan.

Ikon yang tidak cocok untuk ikon maskable.

Gambar ini dapat digunakan dengan lebih banyak padding.

Ikon dengan lebih banyak padding cocok untuk mask.

Ikon yang dapat disamarkan harus berukuran minimal 512 x 512. Setelah dibuat, Anda dapat menambahkannya ke koleksi icons guna meningkatkan pengalaman untuk perangkat yang didukung:

"icons": [
   {
      "src": "/icons/512.png",
      "type": "image/png",
      "sizes": "512x512"
   },
   {
      "src": "/icons/1024.png",
      "type": "image/png",
      "sizes": "1024x1024"
   },
   {
      "src": "/icons/512-maskable.png",
      "type": "image/png",
      "sizes": "512x512",
      "purpose": "maskable"
   },
]

Pada umumnya, jika ikon maskable tidak ditampilkan dengan baik, Anda dapat meningkatkannya dengan menambahkan lebih banyak padding. Maskable.app adalah alat online gratis untuk menguji dan membuat versi ikon yang dapat disamarkan.

Kumpulan kolom berikutnya yang akan disertakan adalah kolom yang akan meningkatkan pengalaman pengguna, meskipun kolom tersebut tidak diperlukan untuk kemampuan penginstalan.

theme_color
Warna default untuk aplikasi, terkadang memengaruhi cara OS menampilkan situs (misalnya, warna jendela dan panel judul di desktop, atau warna status bar di perangkat seluler). Warna ini dapat diganti oleh elemen <meta> theme-color HTML.
background_color
Warna placeholder yang akan ditampilkan di latar belakang aplikasi sebelum stylesheetnya dimuat. Safari di iOS, iPadOS serta sebagian besar browser desktop saat ini mengabaikan kolom ini.
scope
Mengubah cakupan navigasi PWA, sehingga Anda dapat menentukan apa yang ditampilkan dan tidak ditampilkan di dalam jendela aplikasi terinstal. Misalnya, jika Anda menautkan ke halaman di luar cakupan, halaman tersebut akan dirender di browser dalam aplikasi, bukan di dalam jendela PWA Anda. Namun, ini tidak akan mengubah cakupan pekerja layanan Anda.

Gambar berikutnya menunjukkan cara kolom theme_color digunakan untuk panel judul di perangkat desktop saat Anda menginstal PWA.

PWA yang sama yang diinstal di desktop dengan warna tema yang berbeda.

Saat menentukan warna dalam manifes, seperti dalam theme_color dan background_color, Anda harus menggunakan warna yang dinamai CSS, seperti salmon atau orange, warna RGB seperti #FF5500, atau fungsi warna tanpa transparansi seperti rgb() atau hsl(). Lihat bab Desain aplikasi untuk informasi selengkapnya.

Cobalah

Layar pembuka

Di beberapa perangkat, gambar statis dirender saat PWA Anda dimuat untuk memberikan masukan langsung kepada pengguna.

Android menggunakan nilai theme_color, background_color, dan icon untuk menghasilkan layar pembuka.

Saat Anda menginstal PWA di Android, perangkat akan menghasilkan layar pembuka dengan informasi yang berasal dari manifes seperti yang terlihat dalam diagram berikut.

PWA di layar pembuka Android mengambil nilai yang berbeda dari manifes.

Di sisi lain, Safari di iOS dan iPadOS tidak menggunakan manifes aplikasi web untuk membuat layar pembuka. Sebagai gantinya, desainer tersebut menggunakan gambar yang ditautkan dari elemen <link> eksklusif, yang mirip dengan cara menangani ikon. Lihat bab Peningkatan untuk detail selengkapnya.

Kolom yang diperluas

Kumpulan kolom berikutnya menawarkan informasi tambahan tentang PWA Anda. Semuanya bersifat opsional.

lang
Tag bahasa yang menentukan bahasa utama dari nilai manifes, seperti en untuk bahasa Inggris, pt-BR untuk Portugis Brasil, atau in untuk Hindi.
dir
Arah untuk menampilkan kolom manifes yang mendukung arah (seperti name, short_name, dan description). Nilai yang valid adalah auto, ltr (kiri-ke-kanan), dan rtl (kanan-ke-kiri).
orientation
Orientasi yang diinginkan untuk aplikasi setelah diinstal. Game dapat menetapkannya untuk meminta orientasi khusus lanskap. Beberapa nilai diterima, tetapi jika disertakan, biasanya nilai tersebut adalah portrait atau landscape secara eksplisit.

Kolom promosi

Kumpulan kolom keempat memungkinkan Anda memberikan informasi promosi tentang PWA, misalnya, dalam alur penginstalan, listingan, dan hasil penelusuran.

description
Penjelasan tentang fungsi PWA.
screenshots
Array objek screenshot dengan src, type, dan sizes (mirip dengan objek icons) yang dimaksudkan untuk menampilkan PWA. Tidak ada batasan ukuran.
categories
Array kategori tempat PWA harus digunakan sebagai petunjuk untuk listingan, secara opsional dari daftar kategori yang dikenal. Nilai ini biasanya berupa huruf kecil.
iarc_rating_id
Kode sertifikasi International Age Rating Coalition untuk PWA, jika Anda memilikinya. Hal ini dimaksudkan untuk digunakan guna menentukan usia yang sesuai untuk PWA Anda.

Anda dapat melihat cara kerja kolom promosi ini sekarang. Misalnya, di Android, jika PWA Anda dapat diinstal dan Anda memberikan nilai setidaknya untuk kolom description dan screenshots, pengalaman dialog penginstalan akan berubah dari kolom info sederhana "Tambahkan ke layar utama", ke dialog penginstalan yang lebih kaya yang mirip dengan yang ada di app store.

Di Android, Anda bisa mendapatkan UI penginstalan yang lebih baik jika Anda memberikan nilai untuk kolom promosi, seperti yang dapat Anda lihat di video berikutnya

Lihat penerapan kolom promosi berikut:

Kolom Kemampuan

Terakhir, ada sejumlah kolom yang terkait dengan berbagai kemampuan yang dapat digunakan PWA Anda di browser yang didukung, seperti kolom shortcuts, share_target, display_overrides seperti yang kita bahas di bab Kemampuan. Ada juga kolom, seperti related_apps dan prefer_related_apps (lihat bab Deteksi untuk mengetahui informasi selengkapnya), untuk menghubungkan PWA Anda ke aplikasi terinstal, biasanya dari app store.

Banyak kolom baru dapat muncul di masa mendatang saat browser menambahkan lebih banyak kemampuan ke Progressive Web App.

Referensi