Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joaopaulolndev/filament-world-clock
A filamentphp card to display world clocks
https://github.com/joaopaulolndev/filament-world-clock
Last synced: 1 day ago
JSON representation
A filamentphp card to display world clocks
- Host: GitHub
- URL: https://github.com/joaopaulolndev/filament-world-clock
- Owner: joaopaulolndev
- License: mit
- Created: 2024-06-16T16:45:05.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-07-11T14:10:52.000Z (6 months ago)
- Last Synced: 2024-12-14T19:48:01.934Z (27 days ago)
- Language: PHP
- Size: 151 KB
- Stars: 26
- Watchers: 2
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Filament widget to show hours around the world by timezone
[](https://packagist.org/packages/joaopaulolndev/filament-world-clock)
[](https://github.com/joaopaulolndev/filament-world-clock/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/joaopaulolndev/filament-world-clock/actions?query=workflow%3A"Fix+PHP+code+styling"+branch%3Amain)
[](https://packagist.org/packages/joaopaulolndev/filament-world-clock)
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:
```bash
composer require joaopaulolndev/filament-world-clock
```
>[!NOTE]
> to publish the assets is necessary to run the command below:
```bash
php artisan vendor:publish --tag=filament-world-clock-assets --force
```
Optionally, you can publish the views using
```bash
php artisan vendor:publish --tag="filament-world-clock-views"
```
Optionally, you can publish the translations using
```bash
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:
```bash
php artisan vendor:publish --tag=blade-flags --force
```
## Usage
Add in AdminPanelProvider.php
```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:
```php
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
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [João Paulo Leite Nascimento](https://github.com/joaopaulolndev)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.