---
title: Web App Manifest
slug: Web/Manifest
tags:
  - Manifest
  - manifest.json
  - web app manifest
translation_of: Web/Manifest
---
<p><a href="web app manifest" id="web app manifest" name="web app manifest" title="web app manifest">Web应用程序清单</a>在一个JSON文本文件中提供有关应用程序的信息（如名称，作者，图标和描述）。manifest 的目的是将Web应用程序安装到设备的主屏幕，为用户提供更快的访问和更丰富的体验。</p>

<p>Web应用程序清单是被称为<a href="/en-US/docs/Web/Apps/Progressive">渐进式Web应用程序(PWA)</a>的Web技术集合的一部分, 它们是可以安装到设备的主屏幕的网络应用程序，而不需要用户通过应用商店，伴随着其他功能, 比如离线可用和接收推送通知。</p>

<h2 id="Deploying_a_manifest_with_the_link_tag" name="Deploying_a_manifest_with_the_link_tag">部署一个 manifest</h2>

<p>Web应用程序清单部署在您的HTML页面中，使用在你的文件的头部的一个链接标记：</p>

<div class="highlight">
<pre><code class="language-html"><span class="nt">&lt;link</span> <span class="na">rel=</span><span class="s">"manifest"</span> <span class="na">href=</span><span class="s">"/manifest.json"</span><span class="nt">&gt;</span></code></pre>
</div>

<h2 id="manifest_范例">manifest 范例 </h2>

<pre class="brush: json">{
  "name": "HackerWeb",
  "short_name": "HackerWeb",
  "start_url": ".",
  "display": "standalone",
<span class="pl-s"><span class="pl-pds">  "</span>background_color<span class="pl-pds">"</span></span>: <span class="pl-s"><span class="pl-pds">"</span>#fff<span class="pl-pds">"</span></span>,
  "description": "A simply readable Hacker News app.",
  "icons": [{
    "src": "images/touch/homescreen48.png",
    "sizes": "48x48",
    "type": "image/png"
  }, {
    "src": "images/touch/homescreen72.png",
    "sizes": "72x72",
    "type": "image/png"
  }, {
    "src": "images/touch/homescreen96.png",
    "sizes": "96x96",
    "type": "image/png"
  }, {
    "src": "images/touch/homescreen144.png",
    "sizes": "144x144",
    "type": "image/png"
  }, {
    "src": "images/touch/homescreen168.png",
    "sizes": "168x168",
    "type": "image/png"
  }, {
    "src": "images/touch/homescreen192.png",
    "sizes": "192x192",
    "type": "image/png"
  }],
  "related_applications": [{
    "platform": "web"
  }, {
    "platform": "play",
    "url": "https://play.google.com/store/apps/details?id=cheeaun.hackerweb"
  }]
}</pre>

<h2 id="成员">成员</h2>

<h3 id="background_color"><code>background_color</code></h3>

<p>为web应用程序预定义的背景颜色。此值在应用程序样式表中可以再次声明。它主要用于在样式表加载之前，当加载manifest，浏览器可以用来绘制web应用程序的背景颜色。在启动web应用程序和加载应用程序的内容之间创建了一个平滑的过渡。</p>

<pre class="brush: json">"background_color": "red"</pre>

<div class="note">
<p>注意：background_color只是在web应用程序加载时提高用户体验，而当web应用程序的样式表可用时，不能替代作为背景颜色使用。</p>
</div>

<h3 id="description"><code>description</code></h3>

<p>提供有关Web应用程序的一般描述。</p>

<pre class="brush: json">"description": "The app that helps you find the best food in town!"</pre>

<h3 id="dir"><code>dir</code></h3>

<p>指定名称、短名称和描述成员的主文本方向。与lang一起配置，可以帮助正确显示右到左文本。</p>

<pre class="brush: json" dir="rtl">"dir": "rtl",
"lang": "ar",
"short_name": "أنا من التطبيق!"</pre>

<p>可选值:</p>

<ul>
 <li><code>ltr</code> (由左到右)</li>
 <li><code>rtl</code> (由右到左)</li>
 <li><code>auto</code> (由浏览器自动判断。</li>
</ul>

<div class="note">
<p><strong>注意：当省略时，默认为auto</strong></p>
</div>

<h3 id="display"><code>display</code></h3>

<p>定义开发人员对Web应用程序的首选显示模式。</p>

<pre class="brush: json">"display": "standalone"</pre>

<p>有效值:</p>

<table class="standard-table">
 <thead>
  <tr>
   <th scope="col">显示模式</th>
   <th scope="col">描述</th>
   <th scope="col">后备显示模式</th>
  </tr>
 </thead>
 <tbody>
  <tr>
   <td><code>fullscreen</code></td>
   <td>全屏显示, 所有可用的显示区域都被使用, 并且不显示状态栏{{Glossary("chrome")}}。</td>
   <td><code>standalone</code></td>
  </tr>
  <tr>
   <td><code>standalone</code></td>
   <td>让这个应用看起来像一个独立的应用程序，包括具有不同的窗口，在应用程序启动器中拥有自己的图标等。这个模式中，用户代理将移除用于控制导航的UI元素，但是可以包括其他UI元素，例如状态栏。</td>
   <td><code>minimal-ui</code></td>
  </tr>
  <tr>
   <td><code>minimal-ui</code></td>
   <td>该应用程序将看起来像一个独立的应用程序，但会有浏览器地址栏。 样式因浏览器而异。</td>
   <td><code>browser</code></td>
  </tr>
  <tr>
   <td><code>browser</code></td>
   <td>该应用程序在传统的浏览器标签或新窗口中打开，具体实现取决于浏览器和平台。 这是默认的设置。</td>
   <td>(None)</td>
  </tr>
 </tbody>
</table>

<div class="note">
<p><strong>Note</strong>: 您可以使用显示模式媒体功能，根据<a href="/docs/Web/CSS/@media/display-mode">显示模式</a>选择性地将CSS应用到您的应用程序。 这可用于在从URL启动网站和从桌面图标启动网站之间提供一致的用户体验。</p>
</div>

<h3 id="icons"><code>icons</code></h3>

<p>指定可在各种环境中用作应用程序图标的图像对象数组。 例如，它们可以用来在其他应用程序列表中表示Web应用程序，或者将Web应用程序与<abbr title="operating system">OS</abbr>的任务切换器和/或系统偏好集成在一起。</p>

<pre class="brush: json">"icons": [
  {
    "src": "icon/lowres.webp",
    "sizes": "48x48",
    "type": "image/webp"
  },
  {
    "src": "icon/lowres",
    "sizes": "48x48"
  },
  {
    "src": "icon/hd_hi.ico",
    "sizes": "72x72 96x96 128x128 256x256"
  },
  {
    "src": "icon/hd_hi.svg",
    "sizes": "72x72"
  }
]</pre>

<p>图像对象可能包含以下值：</p>

<table class="standard-table">
 <thead>
  <tr>
   <th scope="col">字段</th>
   <th scope="col">描述</th>
  </tr>
 </thead>
 <tbody>
  <tr>
   <td><code>sizes</code></td>
   <td>包含空格分隔的图像尺寸的字符串。</td>
  </tr>
  <tr>
   <td><code>src</code></td>
   <td>图像文件的路径。 如果<code>src</code>是一个相对URL，则基本URL将是manifest的URL。</td>
  </tr>
  <tr>
   <td><code>type</code></td>
   <td>提示图像的媒体类型。此字段的目的是允许用户代理快速忽略不支持的媒体类型的图像。</td>
  </tr>
 </tbody>
</table>

<h3 id="lang"><code>lang</code></h3>

<p>指定<code>name</code>和<code>short_name</code>成员中的值的主要语言。 该值是包含单个语言标记的字符串。</p>

<pre class="brush: json">"lang": "en-US"</pre>

<h3 id="name"><code>name</code></h3>

<p>为应用程序提供一个人类可读的名称，例如在其他应用程序的列表中或作为图标的标签显示给用户。</p>

<pre class="brush: json">"name": "Google I/O 2017" </pre>

<h3 id="orientation"><code>orientation</code></h3>

<p>定义所有Web应用程序顶级的默认方向 {{Glossary("Browsing context", "browsing contexts")}}.</p>

<pre class="brush: json"><code>​​"orientation": "portrait-primary"</code></pre>

<p>方向可以是以下值之一：</p>

<ul>
 <li><code>any</code></li>
 <li><code>natural</code></li>
 <li><code>landscape</code></li>
 <li><code>landscape-primary</code></li>
 <li><code>landscape-secondary</code></li>
 <li><code>portrait</code></li>
 <li><code>portrait-primary</code></li>
 <li><code>portrait-secondary</code></li>
</ul>

<h3 id="prefer_related_applications"><code>prefer_related_applications</code></h3>

<p>指定一个布尔值，提示用户代理向用户指示指定的相关应用程序（请参见下文）可用，并建议通过Web应用程序。 只有当相关的本地应用程序确实提供了某些Web应用程序无法做到的事情时，才应该使用它。</p>

<pre class="brush: json">"prefer_related_applications": false</pre>

<div class="note">
<p><strong>Note</strong>: 如果省略,默认设置为 <code>false</code>.</p>
</div>

<h3 id="related_applications"><code>related_applications</code></h3>

<p>指定一个“应用程序对象”数组，代表可由底层平台安装或可访问的本机应用程序 - 例如可通过Google Play Store获取的原生Android应用程序。 这样的应用程序旨在替代提供类似或等同功能的Web应用程序 - 就像Web应用程序的本机应用程序版本一样。</p>

<pre class="brush: json">"related_applications": [
  {
    "platform": "play",
    "url": "https://play.google.com/store/apps/details?id=com.example.app1",
    "id": "com.example.app1"
  }, {
    "platform": "itunes",
    "url": "https://itunes.apple.com/app/example-app1/id123456789"
  }]</pre>

<p>应用程序对象可能包含以下值：</p>

<table class="standard-table">
 <thead>
  <tr>
   <th scope="col">Member</th>
   <th scope="col">Description</th>
  </tr>
 </thead>
 <tbody>
  <tr>
   <td><code>platform</code></td>
   <td>可以找到应用程序的平台。</td>
  </tr>
  <tr>
   <td><code>url</code></td>
   <td>可以找到应用程序的URL。</td>
  </tr>
  <tr>
   <td><code>id</code></td>
   <td>用于表示指定平台上的应用程序的ID。</td>
  </tr>
 </tbody>
</table>

<h3 id="scope"><code>scope</code></h3>

<p>定义此Web应用程序的应用程序上下文的导航范围。 这基本上限制了manifest可以查看的网页。 如果用户在范围之外浏览应用程序，则返回到正常的网页。</p>

<p>如果<code>scope</code>是相对URL，则基本URL将是manifest的URL。</p>

<pre class="brush: json">"scope": "/myapp/"</pre>

<h3 id="short_name"><code>short_name</code></h3>

<p>为应用程序提供简短易读的名称。 这是为了在没有足够空间显示Web应用程序的全名时使用。</p>

<pre class="brush: json">"short_name": "I/O 2017"
</pre>

<h3 id="start_url"><code>start_url</code></h3>

<p>指定用户从设备启动应用程序时加载的URL。 如果以相对URL的形式给出，则基本URL将是manifest的URL。</p>

<pre class="brush: json">"start_url": "./?utm_source=web_app_manifest"</pre>

<h3 id="theme_color"><code>theme_color</code></h3>

<p>定义应用程序的默认主题颜色。 这有时会影响操作系统显示应用程序的方式（例如，在Android的任务切换器上，主题颜色包围应用程序）。</p>

<pre class="brush: json">"theme_color": "aliceblue"</pre>

<h2 id="初始屏幕">初始屏幕</h2>

<p>在Chrome 47及更高版本中，从主屏幕启动的Web应用程序将显示启动画面。 这个启动画面是使用Web应用程序清单中的属性自动生成的，具体来说就是：<code>name</code>，<code>background_color</code>以及<code>icons</code> 中距设备最近128dpi的图标。</p>

<h2 id="Mime类型">Mime类型</h2>

<p>Manifests 应使用 <code>application/manifest+json</code> MIME 类型. 但是, 你不必非得这样做.</p>

<h2 id="规范">规范</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">Specification</th>
   <th scope="col">Status</th>
   <th scope="col">Comment</th>
  </tr>
  <tr>
   <td>{{SpecName('Manifest')}}</td>
   <td>{{Spec2('Manifest')}}</td>
   <td>Initial definition.</td>
  </tr>
 </tbody>
</table>

<h2 id="浏览器兼容性">浏览器兼容性</h2>

{{Compat("html.manifest")}}