gerenuk/filament-utc-dts

This package adds a UTC time indicator to your filament panel.

v1.0.1 2024-06-24 00:48 UTC

This package is auto-updated.

Last update: 2024-10-08 23:21:04 UTC


README

Project banner

Filament UTC DTS

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

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

Table of Contents

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

Version Compatibility

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',
];

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
            // ...
            ->plugin(FilamentUtcDtsPlugin::make());
    }
}

Testing

composer test

Screenshots

UTC Indicator

UTC Indicator UTC Indicator

UTC Indicator & Date

UTC Indicator & Date 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

License

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