Web-App-Manifeste
Ein Web-Anwendungsmanifest, definiert in der Web Application Manifest-Spezifikation, ist eine JSON-Textdatei, die Informationen über eine Web-Anwendung bereitstellt.
Der gebräuchlichste Einsatz eines Web-Anwendungsmanifests besteht darin, Informationen bereitzustellen, 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-Anwendungsmanifest enthält ein einzelnes JSON-Objekt, in dem die obersten Schlüssel Mitglieder genannt werden.
Mitglieder
Dieser Abschnitt listet die Mitglieder auf, die im Manifest erscheinen können.
In der Spezifikation sind alle Mitglieder optional, aber einige Anwendungen erfordern, dass bestimmte Mitglieder vorhanden sind. Zum Beispiel müssen PWAs bestimmte Manifestmitglieder bereitstellen.
- Beschreibung
- Kategorien
- Shortcuts
- background_color
- display
- display_override Experimentell
- file_handlers Experimentell
- icons
- id
- launch_handler Experimentell
- name
- note_taking Experimentell
- orientation
- prefer_related_applications Experimentell
- protocol_handlers Experimentell
- related_applications Experimentell
- scope
- screenshots
- serviceworker Experimentell Nicht standardisiert
- share_target Experimentell
- short_name
- start_url
- theme_color
Hinweis:
Die Mitglieder dir, lang und iarc_rating_id sind nicht implementiert.
Beispielmanifest
{
"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 mithilfe eines <link>-Elements im <head> eines Dokuments bereitgestellt:
<link rel="manifest" href="manifest.json" />
Die .webmanifest-Erweiterung ist im Abschnitt Media type registration der Spezifikation angegeben (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 das Manifest Anmeldeinformationen zum Abrufen erfordert, muss das crossorigin-Attribut auf use-credentials gesetzt werden, selbst wenn sich die Manifestdatei im selben Ursprung wie die aktuelle Seite befindet.
<link rel="manifest" href="/app.webmanifest" crossorigin="use-credentials" />
Startbildschirme
In einigen Browsern und Betriebssystemen wird ein Startbildschirm angezeigt, wenn eine installierte PWA gestartet wird. Dieser Startbildschirm wird automatisch generiert und sein Erscheinungsbild wird durch Mitglieder im Web-App-Manifest bestimmt, insbesondere: