Web 應用程式清單

根據 Web 應用程式清單 規範定義的Web 應用程式清單是一個 JSON 文字檔案,它提供了有關 Web 應用程式的資訊。

Web 應用程式清單最常見的用途是提供瀏覽器在裝置上安裝 漸進式 Web 應用 (PWA) 所需的資訊,例如應用的名稱和圖示。

Web 應用程式清單包含一個單獨的 JSON 物件,其中頂層鍵稱為成員

成員

本節列出了 MDN 上已記錄的 清單成員的參考頁面。根據規範,所有成員都是可選的,但某些應用程式需要存在某些成員。例如,PWA 必須提供某些清單成員

注意: dirlangiarc_rating_id 成員尚未實現。

清單示例

json
{
  "short_name": "MDN",
  "name": "MDN Web Docs",
  "icons": [
    {
      "src": "/favicon-192x192.png",
      "sizes": "192x192",
      "type": "image/png"
    },
    {
      "src": "/favicon-512x512.png",
      "sizes": "512x512",
      "type": "image/png"
    }
  ],
  "start_url": ".",
  "display": "standalone",
  "theme_color": "black",
  "background_color": "white"
}

部署清單

Web 應用清單透過在文件的 <head> 中使用 <link> 元素來部署到 HTML 頁面。

html
<link rel="manifest" href="manifest.json" />

.webmanifest 副檔名在規範的 媒體型別註冊 部分進行了規定(清單檔案的響應應返回 Content-Type: application/manifest+json)。瀏覽器通常支援具有其他適當副檔名(如 .jsonContent-Type: application/json))的清單。

如果清單需要憑據才能獲取,則必須將 crossorigin 屬性設定為 use-credentials,即使清單檔案與當前頁面在同一源下。

html
<link rel="manifest" href="/app.webmanifest" crossorigin="use-credentials" />

啟動螢幕

在某些瀏覽器和作業系統中,當安裝的 PWA 啟動時會顯示一個啟動螢幕。這個啟動螢幕是自動生成的,其外觀由 Web 應用清單中的成員定義,具體來說是

瀏覽器相容性

另見