Filament PWA

https://github.com/jeffersongoncalves/filament-pwa

Admin

Filament PWA is a Filament plugin that turns admin panels into installable Progressive Web Apps by...

Tokens:898

Snippets:9

Trust Score:9.8

License:MIT

Update:1 month ago

Show doc for...

Tokens:

Raw

### Install Filament PWA with Composer

Source: https://github.com/jeffersongoncalves/filament-pwa/blob/3.x/README.md

Install the Filament PWA plugin via Composer. The laravel-pwa-favicon package is installed as a dependency; follow its README to publish favicon assets and enable manifest/favicon routes, otherwise the manifest link will point to a non-existent route.

```bash
composer require jeffersongoncalves/filament-pwa:^1.0
```

--------------------------------

### Run Tests with Composer

Source: https://github.com/jeffersongoncalves/filament-pwa/blob/3.x/README.md

Run the package test suite.

```bash
composer test
```

--------------------------------

### Customize themeColor and manifestUrl

Source: https://github.com/jeffersongoncalves/filament-pwa/blob/3.x/README.md

Customize the PWA head markup. themeColor sets the theme-color meta tag (default #ffffff) and manifestUrl sets the manifest link href (default /manifest.json). The render hook is scoped to the panel it is registered on.

```php
FilamentPwaPlugin::make()
    ->themeColor('#0ea5e9')          // <meta name="theme-color">, defaults to #ffffff
    ->manifestUrl('/manifest.json'), // <link rel="manifest"> href, defaults to /manifest.json
```

--------------------------------

### Register FilamentPwaPlugin in PanelProvider

Source: https://github.com/jeffersongoncalves/filament-pwa/blob/3.x/README.md

Register the FilamentPwaPlugin in your PanelProvider. This injects the manifest link, theme-color meta tag, and Apple touch icon links into the panel's <head>.

```php
use JeffersonGoncalves\Filament\Pwa\FilamentPwaPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            FilamentPwaPlugin::make(),
        ]);
}
```

Tokens:

Raw