tapp / filament-timezone-field
Filament timezone field.
Installs: 40 192
Dependents: 1
Suggesters: 0
Security: 0
Stars: 31
Watchers: 5
Forks: 6
Open Issues: 3
Requires
- php: ^8.1
- filament/filament: ^3.0-stable
README
A timezone select field for Laravel Filament.
Installation
composer require tapp/filament-timezone-field:"^3.0"
Note For Filament 2.x check the 2.x branch
Usage
Form Field
Add to your Filament resource:
use Tapp\FilamentTimezoneField\Forms\Components\TimezoneSelect; public static function form(Form $form): Form { return $form ->schema([ // ... TimezoneSelect::make('timezone'), // ... ]); }
Appareance
Options
To use GMT instead of UTC (default is UTC), add the ->timezoneType('GMT')
method:
use Tapp\FilamentTimezoneField\Forms\Components\TimezoneSelect; public static function form(Form $form): Form { return $form ->schema([ // ... TimezoneSelect::make('timezone') ->timezoneType('GMT'), // ... ]); }
To list only the timezones for a country, you can pass the country code to ->byCountry()
method. For example, to list only United States timezones:
TimezoneSelect::make('timezone') ->byCountry('US')
It's also possible to list the timezones for a region using ->byRegion()
method. You can specify a region with a Region enum value:
use Tapp\FilamentTimezoneField\Enums\Region; TimezoneSelect::make('timezone') ->byRegion(Region::Australia)
or you can use one of the PHP's DateTimeZone predifined constants:
use DateTimeZone; TimezoneSelect::make('timezone') ->byRegion(DateTimeZone::AUSTRALIA)
Also all Filament select field methods are available to use:
use Tapp\FilamentTimezoneField\Forms\Components\TimezoneSelect; public static function form(Form $form): Form { return $form ->schema([ // ... TimezoneSelect::make('timezone') ->searchable() ->required(), // ... ]); }
Optionally hide either timezone offsets or timezone names, depending on your use case:
use Tapp\FilamentTimezoneField\Forms\Components\TimezoneSelect; public static function form(Form $form): Form { return $form ->schema([ // ... TimezoneSelect::make('timezone') ->hideNames(), // ... ]); }
use Tapp\FilamentTimezoneField\Forms\Components\TimezoneSelect; public static function form(Form $form): Form { return $form ->schema([ // ... TimezoneSelect::make('timezone') ->hideOffset(), // ... ]); }
Table Column
use Tapp\FilamentTimezoneField\Tables\Columns\TimezoneColumn; public static function table(Table $table): Table { return $table ->columns([ //... TimezoneColumn::make('timezone') ->timezoneType('GMT') ->formattedOffsetAndTimezone(), ]) // ... }
Options
Method | Description |
---|---|
->formattedTimezone() | Show formatted timezone name |
->formattedOffsetAndTimezone() | Show formatted offset and timezone name |
->timezoneType('GMT') | Use GMT instead of UTC |
Table Filter
use Tapp\FilamentTimezoneField\Tables\Filters\TimezoneSelectFilter; public static function table(Table $table): Table { return $table //... ->filters([ TimezoneSelectFilter::make('timezone'), // ... ]) }