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 应用清单中的成员定义,具体来说是

浏览器兼容性

另见