# Filament PWA
[](https://packagist.org/packages/jeffersongoncalves/filament-pwa)
[](https://github.com/jeffersongoncalves/filament-pwa/actions?query=workflow%3Arun-tests+branch%3A3.x)
[](https://github.com/jeffersongoncalves/filament-pwa/actions?query=workflow%3A"Fix+PHP+code+styling"+branch%3A3.x)
[](https://packagist.org/packages/jeffersongoncalves/filament-pwa)
[](LICENSE.md)
A thin Filament plugin that turns your panels into installable Progressive Web Apps. It registers a `PanelsRenderHook::HEAD_START` render hook that injects the PWA `` markup into your panels:
- the web app manifest ``,
- the `` tag, and
- the Apple touch icon `` tags produced by [laravel-pwa-favicon](https://github.com/jeffersongoncalves/laravel-pwa-favicon).
This plugin is built on top of the [laravel-pwa-favicon](https://github.com/jeffersongoncalves/laravel-pwa-favicon) package. The favicon/manifest routes (`/manifest.json`, `/browserconfig.xml`, `/favicon.ico`, ...) are registered by that package's service provider — **this plugin only injects the matching `` tags into your Filament panels.**
## Compatibility
| Branch | Filament | PHP | Laravel |
|--------|----------|-----|---------|
| **1.x** | **^3.0** | **^8.2 \| ^8.3** | **11.\*** |
| **2.x** | **^4.0** | **^8.2 \| ^8.3 \| ^8.4** | **11.\* \| 12.\*** |
| **3.x** | **^5.0** | **^8.3** | **12.\* \| 13.\*** |
## Installation
You can install the package via composer:
```bash
composer require jeffersongoncalves/filament-pwa:^3.0
```
The `jeffersongoncalves/laravel-pwa-favicon` package is installed as a dependency. Follow its README to publish the favicon assets and enable the manifest/favicon routes — without it the manifest link will point at a route that does not exist.
## Usage
Register the plugin in your `PanelProvider`:
```php
use JeffersonGoncalves\Filament\Pwa\FilamentPwaPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
FilamentPwaPlugin::make(),
]);
}
```
The plugin will inject the manifest link, the `theme-color` meta tag and the Apple touch icon links into the panel's ``.
### Customisation
```php
FilamentPwaPlugin::make()
->themeColor('#0ea5e9') // , defaults to #ffffff
->manifestUrl('/manifest.json'), // href, defaults to /manifest.json
```
The render hook is scoped to the panel it is registered on, so you can enable the PWA `` markup per panel.
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Jefferson Goncalves](https://github.com/jeffersongoncalves)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.