Download the PHP package heimrichhannot/contao-pwa-bundle without Composer
On this page you can find all versions of the php package heimrichhannot/contao-pwa-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download heimrichhannot/contao-pwa-bundle
More information about heimrichhannot/contao-pwa-bundle
Files in heimrichhannot/contao-pwa-bundle
Package contao-pwa-bundle
Short Description A bundle to provide progressive web app support for contao.
License LGPL-3.0-or-later
Informations about the package contao-pwa-bundle
Contao Progressive Web App Bundle
A bundle to provide progressive web app support for contao.
This bundle is still in beta. Please provide feedback if you use it!
This bundle is using PHP Web Push lib to provide push notifications.
Features
- Create and register manifest file for each page root
- Create and register service worker for each page root
- send custom push notifications from backend
- set an offline fallback page
- Frontend module and content element to subscribe to push notifications
- Install PWA button content element
- Encore Bundle support, including asset precaching
- expandable architecture
Setup
Requirements
- PHP >= 7.4
- Contao >=4.9
- Contao Head Bundle
For web push notifications:
- Composer package
"minishlink/web-push": "^8.0"
(version 5 to 8 are supported) - PHP extensions:
- gmp
- mbstring
- curl
- openssl
Install
-
Install via composer or contao manager
composer require heimrichhannot/contao-pwa-bundle
- Update your database
First Steps
- Your page template (typically
fe_page.html5
) must support Head Bundle. This means it must output at least$this->meta()
in head section. See Head Bundle readme for more information - If you want to use push notifications, add vapid keys to your config (see Setup -> Vapidkeys)
- Create an PWA Configuration(Backend -> System -> PWA Configuration)
- Add the configuration to a page root (in page settings you find a new section "Progressive Web App", select yes and choose your configuration)
- On saving the page the page manifest and the serviceworker will be generated
- To provide an option to register to your push notifications, add the Push Subscription Button content element or the push notification popup frontend module to your page.
Push Notifications
VAPID keys
You need to add your server vapid keys to your config file, typical in your project config.yml. If you haven't already vapid keys, you can generate in the PWA Bundle backend (Contao Backend -> System -> PWA Configuration -> Control -> Authentication)
Usage
Regenerate files
You can regenerate all your manifest and service worker files at once from the Pwa Control (Contao Backend -> System -> PWA Configuration -> Control -> Files -> Rebuild files)
There is also an command available: huh:pwa:build
Developers
JS Event
To support custom controls, there are events and event listeners that can be used. All events are dispatched and listen to on document
.
Events
Event | Description |
---|---|
huh_pwa_sw_not_supported | Fired if browser not supports serviceworker or no service worker found. |
huh_pwa_push_not_supported | Fired if browser not supports push notifications |
huh_pwa_push_permission_denied | Fired if browser has push notifications blocked |
huh_pwa_push_isSubscribed | Fired when subscribed to push notifications (on page load or when subscribe) |
huh_pwa_push_isUnsubscribed | Fired when unsubscribed from push notification (on page load or when unsubscribe) |
huh_pwa_push_subscription_failed | Fired when subscription to push notifications failed. Error reason can be found in event.detail.reason. |
huh_pwa_push_unsubscription_failed | Fired when unsubscribe from push notifications failed. Error reason can be found in event.detail.reason. |
Listener
Event type | Usage | Description |
---|---|---|
huh_pwa_push_changeSubscriptionState | new CustomEvent( 'huh_pwa_push_changeSubscriptionState', {detail: ['subscribe'\|'unsubscribe']} ) |
Fire this event when the user interacts with your control to change his subscription state. Use a CustomEvent with detail parameter set to subscribe or unsubscrive. |
Complete configuration
Commands
Command | Description |
---|---|
huh:pwa:build | (Re)Build config specific files like service worker and manifest |
huh:pwa:sendpush | Send unsent push notifications |
Add additional head scripts
It is possible to add additional js code to the head section by using the PwaHeadScriptTags
object available available as huh.head.tag.pwa.script
service. Code added with addScript
will be outputted in header section of your page within <script type='text/javascript'>
tags.
Polyfills
Funtion | Example Polyfill | Description |
---|---|---|
CustomEvent | custom-event-polyfill | Custom events are needed to update the subscribe button (to inform the user that the browser not supporting push notifications). Also an error is thrown if the browser not supporting CustomEvents. |
Todo
- image size config
- support svg icons
- select pages to precache
- customize add to homescreen and push notification notifications
All versions of contao-pwa-bundle with dependencies
ext-json Version *
ext-fileinfo Version *
contao/core-bundle Version ^4.9
heimrichhannot/contao-encore-contracts Version ^1.0.2
heimrichhannot/contao-head-bundle Version ^1.2
heimrichhannot/contao-utils-bundle Version ^2.215
heimrichhannot/contao-twig-support-bundle Version ^0.2.16|^1.0
menatwork/contao-multicolumnwizard Version ^3.3
symfony/framework-bundle Version ^4.4 || ^5.4
symfony/string Version ^5.4 || ^6.0
symfony/translation-contracts Version ^1.0 || ^2.0 || ^3.0
twig/twig Version ^1.44 || ^2.14 || ^3.0