joaopaulolndev/filament-world-clock

Show hours around the world by timezone

v1.0.9 2024-07-11 14:09 UTC

Requires

• php: ^8.1
• filament/filament: ^3.0
• outhebox/blade-flags: ^1.5
• spatie/laravel-package-tools: ^1.15.0

Requires (Dev)

• laravel/pint: ^1.0
• nunomaduro/collision: ^7.9
• orchestra/testbench: ^8.0
• pestphp/pest: ^2.1
• pestphp/pest-plugin-arch: ^2.0
• pestphp/pest-plugin-laravel: ^2.0

MIT

• João Paulo Leite Nascimento

• laravel
• joaopaulolndev
• filament-world-clock

README

The Filament World Clock plugin designed to showcase global timezones in a card format is a user-friendly tool that allows users to effortlessly display current times across various regions worldwide.

Installation

You can install the package via composer:

composer require joaopaulolndev/filament-world-clock

Note

to publish the assets is necessary to run the command below:

php artisan vendor:publish --tag=filament-world-clock-assets --force

Optionally, you can publish the views using

php artisan vendor:publish --tag="filament-world-clock-views"

Optionally, you can publish the translations using

php artisan vendor:publish --tag="filament-world-clock-translations"

You can publish the flags

Note

to publish the flags is necessary to run the command below:

php artisan vendor:publish --tag=blade-flags --force

Usage

Add in AdminPanelProvider.php

use Joaopaulolndev\FilamentWorldClock\FilamentWorldClockPlugin;

->plugins([
    FilamentWorldClockPlugin::make()
        ->timezones([
            'America/New_York',
            'America/Sao_Paulo',
            'Asia/Tokyo',
        ])
])

Optionally, you can add more configs as example below:

use Joaopaulolndev\FilamentWorldClock\FilamentWorldClockPlugin;

FilamentWorldClockPlugin::make()
    ->timezones([
        'America/New_York',
        'America/Sao_Paulo',
        'Asia/Tokyo',
    ])
    ->setTimeFormat('H:i') //Optional time format default is: 'H:i'
    ->shouldShowTitle(false) //Optional show title default is: true
    ->setTitle('Hours') //Optional title default is: 'World Clock'
    ->setDescription('Different description') //Optional description default is: 'Show hours around the world by timezone'
    ->setQuantityPerRow(1) //Optional quantity per row default is: 1
    ->setColumnSpan('full') //Optional column span default is: '1/2' 
    ->setSort(10)

Note

if missing some flag, the default value will be used. But you can open a pr to add more flags.

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

• João Paulo Leite Nascimento
• All Contributors

License

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