Web-Application-Manifest

Ein Web-Application-Manifest, definiert in der Web Application Manifest Spezifikation, ist eine JSON Textdatei, die Informationen über eine Webanwendung bereitstellt.

Die häufigste Verwendung eines Web-Application-Manifests ist die Bereitstellung von Informationen, die der Browser benötigt, um eine Progressive Web App (PWA) auf einem Gerät zu installieren, wie z.B. den Namen und das Symbol der App.

Ein Web-Application-Manifest enthält ein einzelnes JSON-Objekt, bei dem die Schlüssel der obersten Ebene Mitglieder genannt werden.

Mitglieder

Dieser Abschnitt listet die Mitglieder auf, die im Manifest erscheinen können.

Alle Mitglieder sind in der Spezifikation optional, aber einige Anwendungen erfordern, dass bestimmte Mitglieder vorhanden sind. Zum Beispiel müssen PWAs bestimmte Manifestmitglieder bereitstellen.

Hinweis: Die Mitglieder dir, lang und iarc_rating_id sind nicht implementiert.

Beispielmanifest

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": "#000000",
  "background_color": "#ffffff"
}

Bereitstellen eines Manifests

Web-App-Manifeste werden in Ihren HTML-Seiten unter Verwendung eines <link>-Elements im <head> eines Dokuments bereitgestellt:

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

Die Erweiterung .webmanifest wird im Abschnitt Medientyp-Registrierung der Spezifikation spezifiziert (die Antwort der Manifestdatei sollte Content-Type: application/manifest+json zurückgeben). Browser unterstützen im Allgemeinen Manifeste mit anderen geeigneten Erweiterungen wie .json (Content-Type: application/json).

Wenn für das Manifest zum Abrufen Anmeldeinformationen erforderlich sind, muss das crossorigin-Attribut auf use-credentials gesetzt werden, selbst wenn die Manifestdatei im gleichen Ursprung wie die aktuelle Seite ist.

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

Begrüßungsbildschirm

In einigen Browsern und Betriebssystemen wird ein Begrüßungsbildschirm angezeigt, wenn eine installierte PWA gestartet wird. Dieser Bildschirm wird automatisch generiert und sein Erscheinungsbild wird durch Mitglieder im Web-App-Manifest definiert, insbesondere durch:

Browser-Kompatibilität

Siehe auch