Webanwendungsmanifest
Ein Webanwendungsmanifest, definiert in der Web Application Manifest Spezifikation, ist eine JSON-Textdatei, die Informationen über eine Webanwendung bereitstellt.
Der häufigste Anwendungsfall für ein Webanwendungsmanifest 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 Webanwendungsmanifest enthält ein einzelnes JSON-Objekt, bei dem die obersten Schlüssel als Mitglieder bezeichnet werden.
Mitglieder
Dieser Abschnitt listet Referenzseiten für Manifestmitglieder auf, die auf MDN dokumentiert sind. Alle Mitglieder sind in der Spezifikation optional, aber einige Anwendungen erfordern, dass bestimmte Mitglieder vorhanden sind. Zum Beispiel müssen PWAs bestimmte Manifestmitglieder bereitstellen.
- Beschreibung
- Kategorien
- Notizen Experimentell
- background_color
- display
- display_override Experimentell
- file_handlers Experimentell
- icons
- id
- launch_handler Experimentell
- name
- orientation
- prefer_related_applications Experimentell
- protocol_handlers Experimentell
- related_applications Experimentell
- scope
- screenshots
- serviceworker Experimentell Nicht standardisiert
- share_target Experimentell
- short_name
- shortcuts
- 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"
}
Bereitstellung eines Manifests
Web-App-Manifestdateien werden in Ihren HTML-Seiten mit einem <link>-Element im <head> eines Dokuments eingebettet:
<link rel="manifest" href="manifest.json" />
Die .webmanifest-Erweiterung wird im Abschnitt Medientyp-Registrierung der Spezifikation angegeben (die Antwort der Manifestdatei sollte Content-Type: application/manifest+json zurückgeben). Browser unterstützen im Allgemeinen auch Manifeste mit anderen geeigneten Erweiterungen wie .json (Content-Type: application/json).
Wenn das Manifest Anmeldeinformationen zum Abrufen benötigt, muss das crossorigin-Attribut auf use-credentials gesetzt werden, selbst wenn die Manifestdatei im gleichen Ursprung wie die aktuelle Seite liegt.
<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 Aussehen wird durch Mitglieder im Web-App-Manifest definiert, insbesondere: