GeoLeaf Core API - v3.0.0
    Preparing search index...

    Interface PWAConfig

    The modules.pwa configuration block.

    Canonical shape — this is the single declaration of the block. lifecycle.ts and install.ts derive their own narrower views from it with Pick<> rather than redeclaring it (they used to, and the three copies had already drifted apart: neither carried the manifest fields, and this one carried neither enabled nor offlineDetector). The authoritative runtime schema is pwa-capability.ts — keep the two in sync.

    // profiles/geoleaf.config.json
    {
      "modules": {
        "pwa": {
          "enabled": true,
          "name": "My App",
          "short_name": "MyApp",
          "theme_color": "#2d6a4f",
          "background_color": "#ffffff",
          "installPrompt": { "enabled": true },
          "offlineDetector": { "enabled": true }
        }
      }
    }
    interface PWAConfig {
        enabled?: boolean;
        name?: string;
        short_name?: string;
        description?: string;
        theme_color?: string;
        background_color?: string;
        installPrompt?: InstallPromptConfig;
        offlineDetector?: { enabled?: boolean };
    }
    Index

    Properties

    enabled? name? short_name? description? theme_color? background_color? installPrompt? offlineDetector?

    Properties

    enabled?: boolean

    Master gate (opt-in, defaults to false): registers the service worker, enables the install prompt and emits the manifest. Everything below is inert without it.

    name?: string

    Full application name — used in the generated manifest.json.

    short_name?: string

    Short name displayed under the home-screen icon.

    description?: string

    Description of the application.

    theme_color?: string

    Theme color for the browser chrome and splash screen (hex, e.g. "#2d6a4f").

    background_color?: string

    Background color for the PWA splash screen (hex, e.g. "#ffffff").

    installPrompt?: InstallPromptConfig

    Install prompt / iOS banner configuration.

    offlineDetector?: { enabled?: boolean }

    Online/offline connectivity badge.

    Settings

    Member Visibility

    On This Page

    Properties