pwa — module reference
Rendered from the module's own manifest, and from nothing written by hand. What the module does is its own page.
| Module id | pwa |
| Name | Progressive Web App |
| Version | 1.0.0 |
| Ships from | @endora-commerce/mod-pwa |
| Licence | MIT |
Activation
An operator switches this module on and off on /platform/modules. The choice is the setting pwa.enabled, and it defaults to on.
Dependencies
| Module | Binding | What it means |
|---|---|---|
_i18n | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
_lifecycle | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
assets_library | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
auth | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
customer_accounts | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
orders | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
organizations | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
sales_channels | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
settings | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
Permissions
| Code | Label | Also needs |
|---|---|---|
pwa:read | View PWA settings | — |
pwa:send_push | Send push notifications | — |
pwa:write | Configure PWA | — |
Command palette
None.
Settings
| Code | Name | Type |
|---|---|---|
pwa.app_name | App name | string |
pwa.background_color | Background color | string |
pwa.caching_enabled | Static-asset caching enabled | boolean |
pwa.display_mode | Display mode | string |
pwa.enabled | Progressive Web App enabled | boolean |
pwa.fcm_service_account | FCM service account (JSON) | secret |
pwa.icon_asset_id | Icon source asset id | string |
pwa.push_enabled | Push notifications enabled | boolean |
pwa.short_name | Short name | string |
pwa.theme_color | Theme color | string |
pwa.vapid_private_key | VAPID private key | secret |
pwa.vapid_public_key | VAPID public key | string |
Translations
Bundles at i18n inside the module, one file per shipped language.
Operator commands
None.