README

A Filament plugin displaying a notice when you're offline.

Installation

You can install the package via composer:

composer require charlieetienne/filament-offline-notice

Important

If you have not set up a custom theme and are using Filament Panels follow the instructions in the Filament Docs first.

After setting up a custom theme add the plugin's views to your theme css file or your app's css file if using the standalone packages.

@source '../../../../vendor/charlieetienne/filament-offline-notice/resources/**/*.blade.php';

Optionally, you can publish the views using

php artisan vendor:publish --tag="filament-offline-notice-views"

Usage

Register the plugin in your Panel Provider, for example in app/Providers/Filament/AdminPanelProvider.php:

use CharlieEtienne\FilamentOfflineNotice\FilamentOfflineNoticePlugin;

return $panel
    ->plugins([
        FilamentOfflineNoticePlugin::make(),
    ]);

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Charlie Etienne
• All Contributors

License

The MIT License (MIT). Please see License File for more information.