Web-App-Manifeste
Ein Web-App-Manifest, definiert in der Web Application Manifest-Spezifikation, ist eine JSON-Textdatei, die Informationen über eine Webanwendung bereitstellt.
Die häufigste Verwendung eines Web-App-Manifests besteht darin, dem Browser Informationen bereitzustellen, die er 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-App-Manifest enthält ein einzelnes JSON-Objekt, bei dem die obersten Schlüssel als Mitglieder bezeichnet 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. Beispielsweise müssen PWAs bestimmte Manifest-Mitglieder bereitstellen.
- Beschreibung
- Kategorien
- 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
- shortcuts
- start_url
- theme_color
Hinweis:
Die dir, lang und iarc_rating_id Mitglieder sind nicht implementiert.
Beispiel für ein Manifest
{
"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-Manifeste werden in Ihren HTML-Seiten mit einem <link>-Element im <head> eines Dokuments bereitgestellt:
<link rel="manifest" href="manifest.json" />
Die .webmanifest-Erweiterung ist im Abschnitt Medientyp-Registrierung der Spezifikation angegeben (die Antwort der Manifest-Datei sollte Content-Type: application/manifest+json zurückgeben). Browser unterstützen in der Regel auch Manifeste mit anderen geeigneten Erweiterungen wie .json (Content-Type: application/json).
Falls das Manifest Anmeldeinformationen erfordert, um es abzurufen, muss das crossorigin-Attribut auf use-credentials gesetzt werden, selbst wenn die Manifest-Datei im gleichen Ursprung wie die aktuelle Seite ist.
<link rel="manifest" href="/app.webmanifest" crossorigin="use-credentials" />
Startbildschirme
In einigen Browsern und Betriebssystemen wird beim Starten einer installierten PWA ein Startbildschirm angezeigt. Dieser Startbildschirm wird automatisch generiert und sein Erscheinungsbild wird durch Mitglieder im Web-App-Manifest definiert, speziell: