Web 应用清单是一个 JSON 文件,用于告知浏览器您的渐进式 Web 应用 (PWA) 在安装在用户的桌面设备或移动设备上时的行为。典型的清单文件至少包含:
- 应用名称
- 应用应使用的图标
- 应用启动时应打开的网址
创建清单文件
清单文件可以使用任何名称,但通常命名为 manifest.json
,并从根目录(网站的顶级目录)提供。该规范建议扩展名应为 .webmanifest
,但您可能需要使用 JSON 文件,以使清单更清晰易读。
典型的清单如下所示:
{
"short_name": "Weather",
"name": "Weather: Do I need an umbrella?",
"icons": [
{
"src": "/images/icons-vector.svg",
"type": "image/svg+xml",
"sizes": "512x512"
},
{
"src": "/images/icons-192.png",
"type": "image/png",
"sizes": "192x192"
},
{
"src": "/images/icons-512.png",
"type": "image/png",
"sizes": "512x512"
}
],
"id": "/?source=pwa",
"start_url": "/?source=pwa",
"background_color": "#3367D6",
"display": "standalone",
"scope": "/",
"theme_color": "#3367D6",
"shortcuts": [
{
"name": "How's the weather today?",
"short_name": "Today",
"description": "View weather information for today",
"url": "/today?source=pwa",
"icons": [{ "src": "/images/today.png", "sizes": "192x192" }]
},
{
"name": "How's the weather tomorrow?",
"short_name": "Tomorrow",
"description": "View weather information for tomorrow",
"url": "/tomorrow?source=pwa",
"icons": [{ "src": "/images/tomorrow.png", "sizes": "192x192" }]
}
],
"description": "Weather forecast information",
"screenshots": [
{
"src": "/images/screenshot1.png",
"type": "image/png",
"sizes": "540x720",
"form_factor": "narrow"
},
{
"src": "/images/screenshot2.jpg",
"type": "image/jpg",
"sizes": "720x540",
"form_factor": "wide"
}
]
}
关键清单属性
short_name
和name
您必须在清单中至少提供 short_name
和 name
中的一个。如果您同时提供这两者,系统会在用户安装应用时使用 name
,并在用户的主屏幕、启动器或空间有限的其他位置使用 short_name
。
icons
当用户安装您的 PWA 时,您可以定义一组图标,以供浏览器在主屏幕、应用启动器、任务切换器、启动画面等位置使用。
icons
属性是图片对象的数组。每个对象都必须包含 src
、sizes
属性和图片的 type
。如需使用可遮盖图标(在 Android 中有时称为自适应图标),请将 "purpose": "any maskable"
添加到 icon
属性。
对于 Chromium,您必须提供一个至少 192x192 像素的图标和一个 512x512 像素的图标。如果仅提供这两种图标大小,Chrome 会自动缩放图标以适应设备大小。如果您希望缩放自己的图标,并调整图标以实现像素完美,请以 48dp 为增量提供图标。
id
借助 id
属性,您可以明确定义用于应用的标识符。向清单添加 id
属性会移除对 start_url
或清单位置的依赖,以便将来可以更新这些属性。如需了解详情,请参阅使用 Web 应用清单 ID 属性唯一标识 PWA。
start_url
start_url
是必需属性。它会告知浏览器,您的应用在启动时应从何处启动,并阻止应用在用户将应用添加到主屏幕时所在的任何页面启动。
您的 start_url
应将用户直接定向到您的应用,而不是商品着陆页。想一想用户在打开您的应用后想立即做什么,并将他们放在那里。
background_color
应用首次在移动设备上启动时,启动画面会使用 background_color
属性。
display
您可以自定义应用启动时显示的浏览器界面。例如,您可以隐藏地址栏和浏览器界面元素。游戏甚至可以以全屏模式启动。display
属性采用以下值之一:
媒体资源 | 行为 |
---|---|
fullscreen |
打开没有任何浏览器界面的 Web 应用,并占据所有可用的显示区域。 |
standalone |
打开 Web 应用,使其看起来和感觉像是一个独立应用。应用在其单独的窗口中运行,与浏览器分开,并隐藏地址栏等标准浏览器界面元素。 |
minimal-ui |
此模式与 standalone 类似,但只为用户提供了一组最少量用于控制导航的界面元素,例如“返回”和“重新加载”按钮。
|
browser |
标准的浏览器体验。 |
display_override
如需选择 Web 应用的显示方式,请按照如前所述在其清单中设置 display
模式。浏览器无需支持所有显示模式,但需要支持规范定义的回退链 ("fullscreen"
→ "standalone"
→ "minimal-ui"
→ "browser"
)。如果它们不支持某种模式,则会回退到链中的下一个显示模式。在极少数情况下,这些回退可能会导致问题。例如,当 "minimal-ui"
不受支持时,开发者必须重新进入 "browser"
显示模式才能请求 "minimal-ui"
。当前行为还会导致无法以向后兼容的方式引入新的显示模式,因为它们在回退链中没有位置。
您可以使用 display_override
属性设置自己的回退序列,浏览器会在 display
属性之前考虑该属性。它的值是按列出顺序考虑的一系列字符串,并应用第一个支持的显示模式。如果两者都不受支持,浏览器会回退到评估 display
字段。如果没有 display
字段,浏览器会忽略 display_override
。
以下示例展示了如何使用 display_override
。"window-control-overlay"
的详细信息不在本页讨论范围内。
{
"display_override": ["window-control-overlay", "minimal-ui"],
"display": "standalone",
}
加载此应用时,浏览器会先尝试使用 "window-control-overlay"
。如果不可用,则回退到 "minimal-ui"
,然后从 display
属性切换到 "standalone"
。如果这些都不可用,浏览器就会返回到标准回退链。
scope
应用的 scope
是浏览器视为应用一部分的一组网址。scope
控制网址结构(包括指向应用的所有进入和退出点),浏览器利用它来确定用户何时离开应用。
关于 scope
的一些其他说明:
- 如果您未在清单中添加
scope
,则默认的隐含scope
是起始网址,但移除了其文件名、查询和片段。 scope
属性可以是相对路径 (../
),也可以是能够扩大 Web 应用中导航覆盖范围的任何更高级别的路径 (/
)。start_url
必须在范围内。start_url
相对于scope
属性中定义的路径。- 以
/
开头的start_url
将始终是原点的根。
theme_color
theme_color
用于设置工具栏的颜色,并且可以在任务切换器中的应用预览中反映。theme_color
应与文档标头中指定的 meta
主题颜色一致。
媒体查询中的 theme_color
您可以使用 meta
主题颜色元素的 media
属性调整媒体查询中的 theme_color
。例如,通过这种方式,您可以为浅色模式定义一种颜色,并为深色模式定义另一种颜色。不过,您无法在清单中定义这些偏好设置。如需了解详情,请参阅 w3c/manifest#975 GitHub 问题。
<meta name="theme-color" media="(prefers-color-scheme: light)" content="white">
<meta name="theme-color" media="(prefers-color-scheme: dark)" content="black">
shortcuts
shortcuts
属性是一组应用快捷方式对象,可让您快速访问应用内的关键任务。每个成员都是一个至少包含一个 name
和一个 url
的字典。
description
description
属性描述了应用的用途。
Chrome 在所有平台上的说明长度不得超过 300 个字符。 如果说明超过该长度,浏览器会使用省略号字符将其截断。在 Android 上,说明也不得超过七行文字。
screenshots
screenshots
属性是一组图片对象,用于在常见使用场景中代表您的应用。每个对象都必须包含 src
、sizes
属性和图片的 type
。form_factor
属性是可选的。
您可以将它设置为 "wide"
(对于仅适用于宽屏的屏幕截图)或 "narrow"
(仅适用于较窄的屏幕截图)。
在 Chrome 中,图片必须满足以下条件:
- 宽度和高度必须介于 320 像素到 3840 像素之间。
- 最大尺寸不能超过最小尺寸长度的 2.3 倍。
- 与相应设备规格匹配的所有屏幕截图都必须具有相同的宽高比。
- 从 Chrome 109 开始,桌面设备上只会显示
form_factor
设置为"wide"
的屏幕截图。
- 从 Chrome 109 开始,桌面设备上只会显示
- 从 Chrome 109 开始,在 Android 设备上将忽略
form_factor
设置为"wide"
的屏幕截图。为了向后兼容,系统仍会显示不含form_factor
的屏幕截图。
桌面版 Chrome 至少会显示一张(最多八张)符合这些条件的屏幕截图。其余部分会被忽略。
Android 版 Chrome 至少会显示一张且最多五张符合这些条件的屏幕截图。其余部分会被忽略。
将 Web 应用清单添加到您的网页
创建清单后,将 <link>
标记添加到渐进式 Web 应用的所有页面。例如:
<link rel="manifest" href="/manifest.json">
测试清单
如需验证您的清单是否已正确设置,请使用 Chrome DevTools 的 Application 面板中的 Manifest 窗格。
此窗格提供人类可读版本的许多清单属性,可让您验证所有图片是否均已正确加载。
移动设备上的启动画面
当您的应用首次在移动设备上启动时,浏览器可能需要一些时间才能启动并呈现初始内容。浏览器会在首次渲染之前显示启动画面,而不是显示可能会让用户以为应用无法正常运行的白色屏幕。
Chrome 会根据清单中指定的 name
、background_color
和 icons
自动创建启动画面。为了实现从启动画面到应用的平滑过渡,请使用与加载页面相同的颜色 background_color
。
Chrome 会选择与启动画面的设备分辨率最匹配的图标。在大多数情况下,提供 192 像素和 512 像素的图标就足够了,但您可以提供其他图标以获得更好的匹配效果。
深入阅读
如需了解可添加到 Web 应用清单的其他属性,请参阅 MDN Web 应用清单文档。