tiddlypwa/plugins/web-app-manifest
2023-07-26 16:53:34 -03:00
..
background-color.tid Initial commit 2023-07-01 14:33:05 -03:00
icon.tid Plugins: add icons 2023-07-23 05:04:58 -03:00
license.tid Initial commit 2023-07-01 14:33:05 -03:00
link-tag.tid Manifest: fix all the data URI generation 2023-07-01 14:33:08 -03:00
macro.js Import typedefs for LSP, add lint skip 2023-07-01 14:33:09 -03:00
main.js Manifest: some var renames, extra thing to skip over 2023-07-26 02:23:38 -03:00
name.tid Initial commit 2023-07-01 14:33:05 -03:00
plugin.info release 0.1.1 2023-07-26 16:53:34 -03:00
readme.tid Manifest: make readme TiddlyPWA-independent 2023-07-01 14:33:09 -03:00
theme-color.tid Manifest: use primary as the theme color 2023-07-24 04:34:32 -03:00

title: $:/plugins/valpackett/web-app-manifest/readme

!! Web App Manifest

This plugin dynamically generates and applies a [[Web App Manifest|https://developer.mozilla.org/en-US/docs/Web/Manifest]]
for the wiki, which is necessary for "add to home screen" style web app installation in browsers.

When saving the wiki, the manifest is also inlined into the `<head>`.
Having the manifest be statically present in the file increases compatibility with [[browser bugs|https://github.com/mozilla-mobile/fenix/issues/16672]].

You can also <$button message="tiddlypwa-get-manifest">download the current manifest as a file</$button>.

!!! Manifest Generation

The `name` is taken from [[$:/plugins/valpackett/web-app-manifest/name]], which by default just includes the wiki's title.

Colors are taken from [[$:/plugins/valpackett/web-app-manifest/background-color]] and
[[$:/plugins/valpackett/web-app-manifest/theme-color]], which by default take the current palette's colors.

Icons are collected from tiddlers tagged with `$:/tags/ManifestIcon`, but if none have that tag, [[$:/favicon.ico]] is chosen if it exists.
(Obviously you can add the tag to [[$:/favicon.ico]] if you want to use it //and// others.)
Icons can be of any image type, including SVG.
For each icon, tiddler fields `sizes` and `purpose` can be used to set these properties for the icon in the manifest.