Manifest 中的清单成员
description 清单成员
发布于 更新于
description 清单成员用字符串说明 Web 应用做什么。W3C Application Information 注册表把它
定义为商店列表元数据;Chromium 还会在增强安装对话框里把它和 screenshots 一起展示给用户,并把它
作为已安装应用的无障碍描述。
Chrome 88、Edge 88、Samsung Internet 15.0 与 Android WebView 88 读取该成员(BCD
manifests.webapp.description)。兼容性数据记录 Firefox 与 Safari 不支持该成员;在
Firefox for Android 上该属性能被解析,但没有效果。
| 属性 | 值 |
|---|---|
| 类型 | 字符串。纯文本;安装对话框不解析 HTML,并会合并换行。 |
| 默认值 | 缺省。没有 description 时,Chrome 的安装对话框只显示名称、来源与图标,商店列表 则退回打包工具另行索取的文字。 |
| 示例值 | "Track your habits and build streaks, even offline."。 |
值不是字符串时,解析器用通用提示 property 'description' ignored, type string expected. 丢弃它。
格式本身没有长度上限,但 Chrome 的安装界面会截断,字符串超过 300 个字符时 DevTools 会给出警告。
把第一句写成能独立成立的话。
这个成员提供默认语言的文本。description_localized(见本地化条目)按 BCP 47 语言标签携带各语言
版本;没有与界面语言匹配的版本时,Chromium 回退到 description。
两个示例使用同一段文字,区别在于谁来读它。
写一段经得起截断的描述
链接到“写一段经得起截断的描述”一节第一句先写应用有什么特点,整段控制在 300 字符以内并留出余量。第二句丢掉也不影响理解。
{ "name": "Habit Ledger", "short_name": "Habits", "description": "Track daily habits and build streaks, fully offline. Export to CSV, sync when you are back online, no account needed.", "screenshots": [ { "src": "/shots/narrow-1.png", "sizes": "1080x1920", "type": "image/png", "form_factor": "narrow" } ]}Android 上的 Chrome 94 与桌面端的 Chrome 108 只有在至少存在一张截图时才会在增强安装对话框里
渲染这段文字;没有 screenshots 的普通对话框不显示描述。
在部署测试里检查上线的描述
链接到“在部署测试里检查上线的描述”一节没有 API 能报告浏览器或商店是否使用了这段文字。测试能做的是断言已部署的清单带有非空字符串且在 截断预算之内。回退分支处理没有 document 的环境(例如 Node 测试运行器)。
export async function describedManifest(manifestUrl = '/manifest.webmanifest') { const manifest = await fetch(manifestUrl).then((r) => r.json()); const text = manifest.description; if (typeof text !== 'string' || text.trim() === '') { return { ok: false, reason: 'description missing' }; } if (text.length > 300) { return { ok: false, reason: `description is ${text.length} chars; Chrome truncates past 300` }; } return { ok: true, text };}每次部署后对生产地址跑一遍。CDN 若删除或改写了清单,测试就能在安装对话框出现问题前发现。
另请参阅
链接到“另请参阅”一节- categories 清单成员
- screenshots 清单成员
- lang、dir 与 *_localized 清单成员
- 更丰富的安装 UI:用描述和截图增强安装提示
- Web App Manifest - Application Information: description member(w3c.github.io)
- Provide a custom install experience(web.dev)
规范
| 规范 | 状态 |
|---|---|
| Web 应用清单:description | W3C 草案 |
- 图例
- 支持
- 部分支持
- 需开启标志
- 不支持
- 未知
| 浏览器 / 平台 | 支持 | 版本 | 置信度 | 来源 | 备注 |
|---|---|---|---|---|---|
| Chrome (Desktop)# | 支持 | 88 | 高 | 来源 | — |
| Chrome (Android)# | 支持 | 88 | 高 | 来源 | 1 |
| Edge (Desktop)# | 支持 | 88 | 高 | 来源 | 2 |
| Firefox (Desktop)# | 不支持 | — | 高 | 来源 | 3 |
| Firefox (Android)# | 不支持 | — | 高 | 来源 | 4 |
| Safari (macOS)# | 不支持 | — | 高 | 来源 | 5 |
| Safari (iOS)# | 不支持 | — | 高 | 来源 | 67 |
| Samsung Internet# | 支持 | 15.0 | 高 | 来源 | 8 |
| WebView (Android)# | 支持 | 88 | 高 | 来源 | 9 |
- 由 browser-compat-data 镜像自 Chrome 的数据推导。
- 由 browser-compat-data 镜像自 Chrome 的数据推导。
- browser-compat-data 未记录 Firefox 的支持。
- 该属性可以解析,但没有任何效果。
- browser-compat-data 未记录 Safari 的支持。
- browser-compat-data 未记录 iOS 版 Safari 的支持。
- 由 browser-compat-data 镜像自 Safari 的数据推导。
- 由 browser-compat-data 镜像自 Chrome Android 的数据推导。
- 由 browser-compat-data 镜像自 Chrome Android 的数据推导。