README.md

Filament UTC DTS

This package adds a UTC indicator badge to your Filament panel.

Table of Contents

1. Introduction
2. Version Compatibility
3. Installation
4. Usage
   • Registering the Plugin
5. Testing
6. Screenshots
   • UTC Indicator
7. Changelog
8. Contributing
9. Security Vulnerabilities
10. Credits
11. License

Version Compatibility

Plugin	Filament	Laravel	PHP
1.x	3.x	10.x	8.x
1.x	3.x	11.x	8.2|8.3
1.x	3.x	12.x	8.4

Installation

You can install the package via composer:

composer require gerenuk/filament-utc-dts

You can publish the config file with:

php artisan vendor:publish --tag="filament-utc-dts-config"

Optionally, you can publish the views using

php artisan vendor:publish --tag="filament-utc-dts-views"

This is the contents of the published config file:

return [
    /*
     * The Carbon format which should be used to display the UTC timestamp.
     */
    'format' => 'd M Hi\Z',
    
    /*
     * Whether the component should poll every second to keep the time synced.
     */
    'should_poll' => true,
];

Usage

You first need to register the plugin with Filament. This can be done inside of your PanelProvider, e.g. AdminPanelProvider.

<?php

namespace App\Providers\Filament;

use Filament\Panel;
use Filament\PanelProvider;
use Gerenuk\FilamentUtcDts\FilamentUtcDtsPlugin;

class AdminPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // ...
            ->plugins([FilamentUtcDtsPlugin::make()]);
    }
}

Testing

composer test

Screenshots

UTC Indicator

UTC Indicator & Date

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

• Kieran Proctor
• All Contributors

License

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