Filament Jalali

https://github.com/ariaieboy/filament-jalali
Admin
This package adds Jalali/Shamsi date and time support to Filament v4 components like DatePicker,...
Tokens:30,826
Snippets:428
Trust Score:9.3
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Usage examples for jalaliDate

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/macros.md

Examples showing default usage, custom formatting, and timezone application for jalaliDate.

```php
use Filament\Tables\Columns\TextColumn;

TextColumn::make('created_at')
    ->jalaliDate()
    ->label('Created Date')
```

```php
TextColumn::make('birth_date')
    ->jalaliDate(format: 'jY-jm-jd')
    ->label('Birth Date')
```

```php
TextColumn::make('event_date')
    ->jalaliDate(timezone: 'Asia/Tehran')
    ->label('Event Date')
```

--------------------------------

### Usage examples for jalaliDateTime

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/macros.md

Examples showing default usage and custom formatting for jalaliDateTime.

```php
TextColumn::make('updated_at')
    ->jalaliDateTime()
    ->label('Last Updated')
```

```php
TextColumn::make('event_time')
    ->jalaliDateTime(format: 'jY/jm/jd H:i')
    ->label('Event Time')
```

--------------------------------

### Complete Infolist Example

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/usage-examples.md

Demonstrates a full section configuration incorporating multiple Jalali-formatted entries.

```php
use Filament\Infolists\Components\Section;
use Filament\Infolists\Components\TextEntry;

Section::make('Account Information')
    ->schema([
        TextEntry::make('name')
            ->label('Full Name'),
        
        TextEntry::make('email')
            ->label('Email'),
        
        TextEntry::make('birth_date')
            ->jalaliDate()
            ->label('Birth Date'),
        
        TextEntry::make('created_at')
            ->jalaliDateTime()
            ->jalaliDateTimeTooltip()
            ->label('Account Created'),
        
        TextEntry::make('updated_at')
            ->jalaliDateTime()
            ->label('Last Updated'),
    ])
```

--------------------------------

### Jalali Date Formatting Examples

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/configuration.md

Examples showing default and custom date formatting using the jalaliDate macro.

```php
// Configuration
'date_format' => 'Y/m/d'

// Output for Jalali date 1403/5/15
jalaliDate() → "1403/05/15"

// With custom format
jalaliDate(format: 'Y-m-d') → "1403-05-15"
jalaliDate(format: 'd/m/Y') → "15/05/1403"
```

--------------------------------

### Jalali DateTime Formatting Examples

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/configuration.md

Examples showing default and custom datetime formatting using the jalaliDateTime macro.

```php
// Configuration
'date_time_format' => 'Y/m/d H:i:s'

// Output for Jalali datetime 1403/5/15 at 14:30:45
jalaliDateTime() → "1403/05/15 14:30:45"

// With custom format
jalaliDateTime(format: 'Y-m-d H:i') → "1403-05-15 14:30"
```

--------------------------------

### Multiple Columns Example

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/usage-examples.md

Demonstrates how to include Jalali columns alongside standard columns in a table definition array.

```php
use Filament\Tables\Columns\TextColumn;

[
    TextColumn::make('id')
        ->sortable(),
    
    TextColumn::make('title')
        ->searchable(),
    
    TextColumn::make('created_at')
        ->jalaliDate()
        ->label('Created')
        ->sortable(),
    
    TextColumn::make('published_at')
        ->jalaliDateTime()
        ->label('Published')
        ->sortable(),
]
```

--------------------------------

### Install Filament Jalali via Composer

Source: https://github.com/ariaieboy/filament-jalali/blob/main/README.md

Run this command in your terminal to add the package to your project.

```bash
composer require ariaieboy/filament-jalali
```

--------------------------------

### Jalali Date Configuration File Structure

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/configuration.md

Example of the date_format setting within the configuration file.

```php
// config/filament-jalali.php
return [
    'date_format' => 'Y/m/d',  // Persian format: year/month/day
];
```

--------------------------------

### Jalali DateTime Configuration File Structure

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/configuration.md

Example of the date_time_format setting within the configuration file.

```php
// config/filament-jalali.php
return [
    'date_time_format' => 'Y/m/d H:i:s',  // Persian format with time
];
```

--------------------------------

### Customizing Global Formats

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/configuration.md

Example of modifying the published configuration file to set custom default formats.

```php
return [
    'date_format' => 'd/m/Y',           // Day/Month/Year format
    'date_time_format' => 'd/m/Y H:i',  // Without seconds
];
```

--------------------------------

### Macro Configuration Fallback

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/configuration.md

Example of how the service provider uses the config helper to provide default values for macros.

```php
// src/FilamentJalaliServiceProvider.php
TextColumn::macro('jalaliDate', function (?string $format = null, ?string $timezone = null): static {
    $format ??= config('filament-jalali.date_format');  // Falls back to config
    // ...
});
```

--------------------------------

### Example Macro Execution

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/service-provider.md

Demonstrates the internal execution flow when a jalali macro is called on a DatePicker component.

```php
// User code
DatePicker::make('date')
    ->jalali(weekdaysShort: true)
    ->required()

// What happens internally:
// 1. DatePicker::make('date') returns DatePicker instance
// 2. jalali(true) closure executes:
//    - $this = the DatePicker instance
//    - $this->view = 'filament-jalali::components.jalali-datetimepicker'
//    - $this->extraAlpineAttributes([...], true)
//    - ... more configuration
//    - return $this (returns the modified DatePicker)
// 3. required() is called on the returned instance
// 4. Final result: configured DatePicker with Jalali support
```

--------------------------------

### Implement jalali() Macro

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/macros.md

Usage examples for the jalali macro, including standard configuration and the short weekday variant.

```php
use Filament\Forms\Components\DateTimePicker;

DateTimePicker::make('published_at')
    ->jalali()
    ->label('Publication Time')
    ->required()
```

```php
DateTimePicker::make('event_datetime')
    ->jalali(weekdaysShort: true)
    ->label('Event Start')
```

--------------------------------

### Usage of jalaliDateTimeTooltip

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/macros.md

Example of applying the jalaliDateTimeTooltip macro to a TextEntry component.

```php
TextEntry::make('last_login')
    ->jalaliDateTimeTooltip()
    ->label('Last Login')
```

--------------------------------

### formatStateUsing Implementation

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/types.md

Example implementation of a formatStateUsing callback to transform raw state into a formatted Jalali date string.

```php
$this->formatStateUsing(static function (Column $column, $state) use ($format, $timezone): ?string {
    if (blank($state)) {
        return null;
    }
    
    return Jalali::fromCarbon(Carbon::parse($state)
        ->setTimezone($timezone ?? $column->getTimezone()))
        ->format($format);
});
```

--------------------------------

### Usage of jalaliDateTooltip

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/macros.md

Examples of adding a Jalali-formatted date as a tooltip to a TextEntry.

```php
TextEntry::make('event_date')
    ->jalaliDateTooltip()
    ->label('Event Date')
    // Tooltip shows: "1403/05/15" (example Jalali date)
```

```php
TextEntry::make('published_at')
    ->jalaliDate()
    ->jalaliDateTooltip(format: 'jY/jm/jd')
    ->label('Published')
    // Main display: "1403/05/15"
    // Tooltip: "1403/05/15"
```

--------------------------------

### Implement hasToday() Macro

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/macros.md

Usage example for adding the 'Today' button to a Jalali-enabled DateTimePicker.

```php
DateTimePicker::make('updated_at')
    ->jalali()
    ->hasToday()
    ->label('Last Updated')
```

--------------------------------

### Usage of jalaliDateTime

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/macros.md

Example of using jalaliDateTime to display both date and time.

```php
TextEntry::make('submitted_at')
    ->jalaliDateTime()
    ->label('Submission Time')
```

--------------------------------

### Configure Week Start Day

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/localization.md

Use firstDayOfWeek() to override the default Saturday start day for DatePicker components.

```php
// Default (Saturday = 6, standard for Persian-speaking regions)
DatePicker::make('date')
    ->jalali()
    // firstDayOfWeek(6) is automatically applied

// Override to start on Sunday (0)
DatePicker::make('date')
    ->jalali()
    ->firstDayOfWeek(0)

// Start on Monday (1)
DatePicker::make('date')
    ->jalali()
    ->firstDayOfWeek(1)
```

--------------------------------

### Manual Operator Selection for DateConstraint

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/macros.md

Example of explicitly defining which Jalali operators to use for a DateConstraint.

```php
DateConstraint::make('birth_date')
    ->operators([
        IsJalaliDateOperator::class,
        IsJalaliAfterOperator::class,
        IsJalaliBeforeOperator::class,
    ])
```

--------------------------------

### Implement DateConstraint Operator

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/types.md

Example of using the Builder within a custom operator apply method.

```php
// In IsJalaliDateOperator::apply()
public function apply(Builder $query, string $qualifiedColumn): Builder
{
    return $query->whereDate($qualifiedColumn, '=', Carbon::parse($date)->format('Y-m-d'));
}
```

--------------------------------

### Testing Translations in PHP

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/localization.md

Example test case to ensure translation files are correctly loaded and contain the expected data for the Persian locale.

```php
// Verify translations are loaded
public function test_translations_loaded()
{
    $months = trans('filament-jalali::months');
    $this->assertCount(12, $months);
    $this->assertEquals('فروردین', $months[0]);  // For Persian locale
}
```

--------------------------------

### Implement Jalali fields in a Filament Resource

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/usage-examples.md

Integrates Jalali date pickers in forms and Jalali-formatted columns and filters in tables. Requires the filament-jalali package to be installed and configured.

```php
namespace App\Filament\Resources;

use App\Models\Post;
use Filament\Forms;
use Filament\Tables;
use Filament\Resources\Resource;
use Filament\Tables\Filters\QueryBuilder;
use Filament\Tables\Filters\QueryBuilder\Constraints\DateConstraint;

class PostResource extends Resource
{
    protected static ?string $model = Post::class;

    public static function form(Forms\Form $form): Forms\Form
    {
        return $form
            ->schema([
                Forms\Components\TextInput::make('title')
                    ->required(),
                
                Forms\Components\Textarea::make('content')
                    ->required(),
                
                Forms\Components\DatePicker::make('publish_date')
                    ->jalali()
                    ->hasToday()
                    ->label('Publish Date')
                    ->required(),
                
                Forms\Components\DateTimePicker::make('published_at')
                    ->jalali()
                    ->label('Publication Time'),
            ]);
    }

    public static function table(Tables\Table $table): Tables\Table
    {
        return $table
            ->columns([
                Tables\Columns\TextColumn::make('id')
                    ->sortable(),
                
                Tables\Columns\TextColumn::make('title')
                    ->searchable(),
                
                Tables\Columns\TextColumn::make('created_at')
                    ->jalaliDate()
                    ->label('Created')
                    ->sortable(),
                
                Tables\Columns\TextColumn::make('published_at')
                    ->jalaliDateTime()
                    ->label('Published')
                    ->sortable(),
            ])
            ->filters([
                QueryBuilder::make()
                    ->constraints([
                        DateConstraint::make('created_at')
                            ->jalali()
                            ->label('Creation Date'),
                        
                        DateConstraint::make('published_at')
                            ->jalali()
                            ->label('Publication Date'),
                    ])
            ]);
    }
}
```

--------------------------------

### Handling invalid year operator input

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/errors.md

Examples showing the internal code path for year validation and the recommended implementation using the base operator class.

```php
// In IsJalaliYearOperator::apply()
$year = $this->getSettings()['year'];
$start = new Jalali($year, 1, 1);  // Could throw if $year is invalid
$days_of_last_month = $start->getDaysOf(12);
```

```php
// Best practice: let Filament's parent class handle validation
// The base IsYearOperator already validates the year format
DateConstraint::make('created_at')
    ->jalali()
    ->label('Created Year')
```

--------------------------------

### Handle missing configuration

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/errors.md

Shows how a missing configuration file results in null values during macro execution.

```php
// If config is missing:
$format ??= config('filament-jalali.date_format');  // null
// Jalali::format(null) could throw or produce unexpected output
```

--------------------------------

### Configure Package File Loading

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/service-provider.md

Use this method within the service provider to enable the publishing of the package configuration file.

```php
->hasConfigFile()
```

--------------------------------

### bootingPackage Method Signature

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/service-provider.md

The signature for the bootingPackage lifecycle method.

```php
public function bootingPackage(): void
```

--------------------------------

### Publish and configure package settings

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/usage-examples.md

Publish the configuration file to customize date and time formats.

```bash
php artisan vendor:publish --provider="Ariaieboy\FilamentJalali\FilamentJalaliServiceProvider" --tag="config"
```

```php
return [
    'date_format' => 'Y/m/d',           // Jalali format
    'date_time_format' => 'Y/m/d H:i:s', // Jalali format with time
];
```

--------------------------------

### Check Configuration Values

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/errors.md

Verify current package and application configuration settings.

```php
// In tinker or code
config('filament-jalali.date_format')      // Check default format
config('filament-jalali.date_time_format') // Check datetime format
config('app.locale')                       // Check active locale
```

--------------------------------

### Publish Configuration File

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/configuration.md

Command to publish the package configuration file to the application's config directory.

```bash
php artisan vendor:publish --provider="Ariaieboy\FilamentJalali\FilamentJalaliServiceProvider" --tag="config"
```

--------------------------------

### Example Custom Urdu Translation

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/localization.md

Content structure for a custom translation file defining days and labels.

```php
<?php

return [
    'short' => [
        '1' => 'سو',    // سوموار (Monday)
        '2' => 'منگل',  // منگل (Tuesday)
        // ... more days
    ],
    'long' => [
        '1' => 'سوموار',     // Monday
        '2' => 'منگل',       // Tuesday
        // ... more days
    ],
    'today' => 'آج',  // Today
];
```

--------------------------------

### Define Package Configuration

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/overview.md

Default date and datetime formats for the Jalali calendar.

```php
return [
    'date_format' => 'Y/m/d',           // Default Jalali date format
    'date_time_format' => 'Y/m/d H:i:s', // Default Jalali datetime format
];
```

--------------------------------

### Select Date

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/alpine-component.md

Sets the selected day and updates the Livewire state.

```javascript
selectDate(day?: number): void
```

--------------------------------

### Macro Registration Flow

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/service-provider.md

Steps involved in the macro registration process from service provider boot to application usage.

```text
Laravel → PackageServiceProvider::bootingPackage()
```

```text
DatePicker::macro('jalali', closure)
DateTimePicker::macro('jalali', closure)
TextColumn::macro('jalaliDate', closure)
... etc
```

```text
DatePicker::make('date')->jalali()  // ✓ Works
```

```text
When jalali() is called, the closure executes with $this = DatePicker instance
```

--------------------------------

### Package Configuration

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/service-provider.md

Configures the package name and registers publishable assets like translations, config files, and views.

```php
$package
    ->name('filament-jalali')           // Package identifier
    ->hasTranslations()                 // Publish tag: filament-jalali-translations
    ->hasConfigFile()                   // Publish tag: config
    ->hasViews();                       // Publish tag: views
```

--------------------------------

### Import day.js dependencies

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/alpine-component.md

Include all required day.js plugins and calendar system modules at the top of the component file.

```javascript
import dayjs from 'dayjs/esm'
import customParseFormat from 'dayjs/plugin/customParseFormat'
import localeData from 'dayjs/plugin/localeData'
import timezone from 'dayjs/plugin/timezone'
import utc from 'dayjs/plugin/utc'
import calendarSystems from "@calidy/dayjs-calendarsystems"
import PersianCalendarSystem from "@calidy/dayjs-calendarsystems/calendarSystems/PersianCalendarSystem"
```

--------------------------------

### Artisan Commands for Asset Publishing

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/service-provider.md

Commands to publish configuration, translations, views, or all package assets.

```bash
# Publish configuration file
php artisan vendor:publish --tag=config

# Publish translation files
php artisan vendor:publish --tag=filament-jalali-translations

# Publish Blade views
php artisan vendor:publish --tag=views

# Publish all
php artisan vendor:publish --provider="Ariaieboy\FilamentJalali\FilamentJalaliServiceProvider"
```

--------------------------------

### Publishing Translations

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/configuration.md

Command to publish language files for customization.

```bash
php artisan vendor:publish --provider="Ariaieboy\FilamentJalali\FilamentJalaliServiceProvider" --tag="filament-jalali-translations"
```

--------------------------------

### Extend FilamentJalaliServiceProvider

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/service-provider.md

Create a custom service provider by extending the base class and overriding the bootingPackage method to register additional macros.

```php
namespace App;

use AriaieboyilamentJalaliilamentJalaliServiceProvider;

class AppJalaliServiceProvider extends filamentJalaliServiceProvider
{
    public function bootingPackage(): void
    {
        parent::bootingPackage();  // Call parent to get all macros
        
        // Add your own macros here
        TextColumn::macro('customJalali', function () {
            // Your custom macro
        });
    }
}
```

--------------------------------

### Infolist Display Macros

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/README.md

Macros for displaying Jalali dates, datetimes, and tooltips in TextEntry components.

```php
// TextEntry
TextEntry::macro('jalaliDate', function (?string $format = null, ?string $timezone = null): static)
TextEntry::macro('jalaliDateTime', function (?string $format = null, ?string $timezone = null): static)
TextEntry::macro('jalaliDateTooltip', function (?string $format = null, ?string $timezone = null): static)
TextEntry::macro('jalaliDateTimeTooltip', function (?string $format = null, ?string $timezone = null): static)
```

--------------------------------

### Publish Localization Files

Source: https://github.com/ariaieboy/filament-jalali/blob/main/README.md

Use the artisan command to publish translation files for customization.

```bash
php artisan vendor:publish --tag="filament-jalali-translations"
```

--------------------------------

### Register Service Provider

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/overview.md

The entry point for the package functionality within the service provider.

```php
namespace Ariaieboy\FilamentJalali;

class FilamentJalaliServiceProvider extends PackageServiceProvider
```

--------------------------------

### Publishing Translations and Setting Locale

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/usage-examples.md

Commands to publish translation files and verify the application locale configuration.

```bash
# Publish translation files
php artisan vendor:publish --tag=filament-jalali-translations

# Check locale is set correctly
# config/app.php: 'locale' => 'fa'
```

--------------------------------

### configurePackage Method Signature

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/service-provider.md

The signature for the configurePackage lifecycle method.

```php
public function configurePackage(Package $package): void
```

--------------------------------

### Method Chaining and Parameter Types

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/README.md

Demonstrates the fluent interface for DatePicker and TextColumn components, noting that methods return static for chaining and format parameters are optional strings.

```php
// All return static for chaining
DatePicker::make('date')
    ->jalali()           // returns DatePicker
    ->hasToday()         // returns DatePicker
    ->required()         // returns DatePicker

// All format parameters are ?string (optional)
TextColumn::make('date')
    ->jalaliDate(format: 'Y/m/d', timezone: 'UTC')
    .jalaliDateTime()
```

--------------------------------

### Configure Date Format

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/README.md

Set the global date format for the package via the configuration file.

```php
config('filament-jalali.date_format')
```

--------------------------------

### Defining Environment Variables

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/configuration.md

Set the custom format values in the .env file.

```text
JALALI_DATE_FORMAT=d/m/Y
JALALI_DATE_TIME_FORMAT=d/m/Y H:i
```

--------------------------------

### Package File Structure

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/README.md

Overview of the directory layout for the filament-jalali package.

```text
filament-jalali/
├── src/
│   ├── FilamentJalaliServiceProvider.php      (main service provider)
│   └── DateConstraint/
│       └── Operators/
│           ├── IsJalaliAfterOperator.php
│           ├── IsJalaliBeforeOperator.php
│           ├── IsJalaliDateOperator.php
│           └── IsJalaliYearOperator.php
├── config/
│   └── filament-jalali.php                    (configuration)
├── resources/
│   ├── dist/js/
│   │   └── jalali-date-time-picker.js         (compiled Alpine component)
│   ├── js/components/
│   │   └── jalali-date-time-picker.js         (source Alpine component)
│   ├── lang/
│   │   ├── en/
│   │   ├── fa/
│   │   ├── fa_AF/
│   │   └── ps/
│   └── views/
│       └── components/
│           └── jalali-datetimepicker.blade.php (view template)
└── composer.json
```

--------------------------------

### Define DateConstraint correctly

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/errors.md

Shows the recommended way to define constraints versus an invalid approach.

```php
// Correct
DateConstraint::make('created_at')

// Not recommended (relies on implicit table)
DateConstraint::make('some_invalid_column')
```

--------------------------------

### Table and Infolist Display Macros

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/README.md

Macros for formatting dates in Tables and Infolists using the Jalali calendar.

```APIDOC
## TextColumn::jalaliDate

### Description
Formats a table column as a Jalali date.

### Signature
`TextColumn::macro('jalaliDate', function (?string $format = null, ?string $timezone = null): static)`

## TextColumn::jalaliDateTime

### Description
Formats a table column as a Jalali date and time.

### Signature
`TextColumn::macro('jalaliDateTime', function (?string $format = null, ?string $timezone = null): static)`

## TextEntry::jalaliDate

### Description
Formats an infolist entry as a Jalali date.

### Signature
`TextEntry::macro('jalaliDate', function (?string $format = null, ?string $timezone = null): static)`

## TextEntry::jalaliDateTime

### Description
Formats an infolist entry as a Jalali date and time.

### Signature
`TextEntry::macro('jalaliDateTime', function (?string $format = null, ?string $timezone = null): static)`
```

--------------------------------

### Configure Jalali Date Formats

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/README.md

Define the date and datetime display formats in the configuration file.

```php
return [
    'date_format' => 'Y/m/d',           // Jalali date format
    'date_time_format' => 'Y/m/d H:i:s', // Jalali datetime format
];
```

--------------------------------

### Carbon Datetime Handling

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/types.md

Demonstrates parsing date strings and converting timezones using Carbon.

```php
// In operators
$date = Carbon::parse($this->getSettings()['date']);
$dateString = $date->format('Y-m-d');

// In macros
Jalali::fromCarbon(Carbon::parse($state)->setTimezone($timezone))
```

--------------------------------

### Query Builder Integration

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/usage-examples.md

Shows how to register Jalali date constraints within a Filament resource table's filter array.

```php
use Filament\Tables\Filters\QueryBuilder;
use Filament\Tables\Filters\QueryBuilder\Constraints\DateConstraint;

public function getFilters(): array
{
    return [
        QueryBuilder::make()
            ->constraints([
                DateConstraint::make('created_at')
                    ->jalali()
                    ->label('Created Date'),
                    
                DateConstraint::make('updated_at')
                    ->jalali()
                    ->label('Updated Date'),
            ])
    ];
}
```

--------------------------------

### Basic DatePicker implementation

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/usage-examples.md

Use the jalali() method on a DatePicker component to enable the Jalali calendar.

```php
use Filament\Forms\Components\DatePicker;

DatePicker::make('birth_date')
    ->jalali()
    ->label('Birth Date')
    ->required()
```

--------------------------------

### Using Environment Variables in Configuration

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/configuration.md

Update the package configuration file to support environment variables.

```php
// config/filament-jalali.php
return [
    'date_format' => env('JALALI_DATE_FORMAT', 'Y/m/d'),
    'date_time_format' => env('JALALI_DATE_TIME_FORMAT', 'Y/m/d H:i:s'),
];
```

--------------------------------

### Inspect Frontend Component

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/errors.md

Verify the Alpine.js component is correctly loaded in the browser.

```javascript
// Check if the Alpine component is loaded
console.log(typeof jalaliDateTimePickerFormComponent)  // Should be 'function'

// Check current state of a picker
// Right-click the picker input → Inspect → Look at x-data attributes
```

--------------------------------

### isOpen()

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/alpine-component.md

Checks if the picker panel is currently visible.

```APIDOC
## isOpen()

### Description
Checks if the picker panel is currently visible.

### Signature
`isOpen(): boolean`

### Returns
- **boolean** - true if the `.fi-fo-date-time-picker-panel` is visible
```

--------------------------------

### Directory Structure

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/localization.md

The expected file structure for language resources.

```text
resources/
├── lang/
│   ├── en/
│   │   ├── days.php
│   │   └── months.php
│   ├── fa/
│   │   ├── days.php
│   │   └── months.php
│   ├── fa_AF/
│   │   ├── days.php
│   │   └── months.php
│   └── ps/
│       ├── days.php
│       └── months.php
```

--------------------------------

### DateTimePicker implementation

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/usage-examples.md

Enable a combined date and time picker with Jalali support.

```php
use Filament\Forms\Components\DateTimePicker;

DateTimePicker::make('published_at')
    ->jalali()
    ->label('Publication Date & Time')
    ->hint('When should this be published?')
```

--------------------------------

### Default Configuration File

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/configuration.md

The standard structure of the config/filament-jalali.php file defining default date and datetime formats.

```php
<?php

// config/filament-jalali.php

return [
    /*
    |--------------------------------------------------------------------------
    | Jalali Date Format
    |--------------------------------------------------------------------------
    |
    | The format string used to display dates in the Jalali/Shamsi calendar.
    | This is used as the default by the jalaliDate() and jalaliDateTooltip()
    | macros on TextColumn and TextEntry components.
    |
    */
    'date_format' => 'Y/m/d',

    /*
    |--------------------------------------------------------------------------
    | Jalali DateTime Format
    |--------------------------------------------------------------------------
    |
    | The format string used to display datetimes in the Jalali/Shamsi calendar.
    | This is used as the default by the jalaliDateTime() and jalaliDateTimeTooltip()
    | macros on TextColumn and TextEntry components.
    |
    */
    'date_time_format' => 'Y/m/d H:i:s',
];
```

--------------------------------

### Usage of jalaliDate in Filament Components

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/configuration.md

Demonstrates applying the jalaliDate macro to TextColumn components with default and custom formats.

```php
use Filament\Tables\Columns\TextColumn;

// Uses default format from config
TextColumn::make('created_at')
    ->jalaliDate()

// Overrides default format
TextColumn::make('birth_date')
    ->jalaliDate(format: 'jY/jm/jd')
```

--------------------------------

### Since Entry with Jalali Tooltip

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/usage-examples.md

Combines relative time display with an exact Jalali datetime tooltip.

```php
TextEntry::make('last_login')
    ->since()  // Shows: "2 hours ago", "3 days ago"
    ->jalaliDateTimeTooltip()  // Tooltip shows exact Jalali date
    ->label('Last Login')
```

--------------------------------

### Configure Persian Localization

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/usage-examples.md

Set the application locale to Persian to enable Jalali month and weekday names.

```php
// config/app.php
'locale' => 'fa',

// Results in:
// - Months: فروردین، اردیبهشت، ... (Jalali month names in Persian)
// - Days: یکشنبه، دوشنبه، ... (Weekday names in Persian)
// - "Today" button: امروز
```

--------------------------------

### Macro Signatures for Filament Components

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/API-INDEX.md

Quick reference for all available macros provided by the package for Filament form and table components.

```php
// DatePicker
DatePicker::macro('jalali', fn(bool $weekdaysShort = false): static)
DatePicker::macro('hasToday', fn(bool $hasToday = true): static)

// DateTimePicker
DateTimePicker::macro('jalali', fn(bool $weekdaysShort = false): static)
DateTimePicker::macro('hasToday', fn(bool $hasToday = true): static)

// TextColumn
TextColumn::macro('jalaliDate', fn(?string $format = null, ?string $timezone = null): static)
TextColumn::macro('jalaliDateTime', fn(?string $format = null, ?string $timezone = null): static)

// TextEntry
TextEntry::macro('jalaliDate', fn(?string $format = null, ?string $timezone = null): static)
TextEntry::macro('jalaliDateTime', fn(?string $format = null, ?string $timezone = null): static)
TextEntry::macro('jalaliDateTooltip', fn(?string $format = null, ?string $timezone = null): static)
TextEntry::macro('jalaliDateTimeTooltip', fn(?string $format = null, ?string $timezone = null): static)

// DateConstraint
DateConstraint::macro('jalali', fn(): static)
```

--------------------------------

### Using Default Formats in Components

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/configuration.md

Applying the jalaliDate macro to a TextColumn to use the globally configured default format.

```php
TextColumn::make('created_at')->jalaliDate()  // Uses 'd/m/Y'
```

--------------------------------

### Configure boolean flags

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/types.md

Used for toggling configuration options like short weekday names or the today button.

```php
// Use short weekday format
DatePicker::make('date')->jalali(weekdaysShort: true)

// Enable the today button
DateTimePicker::make('date')->hasToday(true)
```

--------------------------------

### Implement Localized Components

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/localization.md

Use jalali() or jalaliDate() methods to automatically apply Persian translations to form and table components.

```php
// Form component automatically uses Persian translations
DatePicker::make('birth_date')
    ->jalali()
    ->label('تاریخ تولد')  // Birth date in Persian

// Table column
TextColumn::make('created_at')
    ->jalaliDate()
    ->label('تاریخ ایجاد')  // Created date in Persian
```

--------------------------------

### TextEntry jalaliDateTimeTooltip Macro

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/API-INDEX.md

Adds a Jalali formatted datetime as a tooltip to an infolist entry.

```php
jalaliDateTimeTooltip(?string $format = null, ?string $timezone = null): static
```

--------------------------------

### Wrap DatePicker initialization in try-catch

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/errors.md

Use a try-catch block when manually initializing the DatePicker to log or handle potential configuration errors.

```php
try {
    $picker = DatePicker::make('date')
        ->jalali()
        ->required();
    
    // Use the picker in form schema
} catch (\Exception $e) {
    // Log the error
    Log::error('DatePicker initialization failed', ['error' => $e->getMessage()]);
}
```

--------------------------------

### Enable Debug Mode

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/errors.md

Configuration setting to enable detailed error messages and stack traces.

```text
APP_DEBUG=true
```

--------------------------------

### getSummary()

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/date-constraint-operators.md

Generates a human-readable summary of the filter constraint, displaying the attribute name and the selected Jalali date.

```APIDOC
## getSummary()

### Description
Generates a human-readable summary of the filter constraint, showing the attribute name and the Jalali date. It retrieves the current filter settings, converts the date from Gregorian to Jalali, and returns a localized message.

### Signature
`public function getSummary(): string`

### Returns
- **string** - Localized summary text (e.g., "created_at is after 1403/05/15")
```

--------------------------------

### Implement Jalali DateTimePicker

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/README.md

Enable Jalali support and the 'today' button on a DateTimePicker component.

```php
DateTimePicker::make('date')->jalali()->hasToday()
```

--------------------------------

### Jalali Calendar Operations

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/types.md

Demonstrates converting Carbon dates to Jalali format and initializing Jalali date objects.

```php
// In macros
Jalali::fromCarbon($carbonDate)->format('Y/m/d')

// In operators
$start = new Jalali($year, 1, 1);
$end = new Jalali($year, 12, 30);
```

--------------------------------

### Clear and Cache Configuration

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/configuration.md

Use these commands to refresh the Laravel configuration cache after making changes to the package settings.

```bash
php artisan config:cache
```

```bash
php artisan config:clear
```

--------------------------------

### Form Component Macros

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/README.md

Configuration macros for DatePicker and DateTimePicker components.

```php
// DatePicker
DatePicker::macro('jalali', function (bool $weekdaysShort = false): static)
DatePicker::macro('hasToday', function (bool $hasToday = true): static)

// DateTimePicker
DateTimePicker::macro('jalali', function (bool $weekdaysShort = false): static)
DateTimePicker::macro('hasToday', function (bool $hasToday = true): static)
```

--------------------------------

### Navigate Days

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/alpine-component.md

Moves focus to the next or previous day.

```javascript
focusNextDay(): void
focusPreviousDay(): void
```

--------------------------------

### Accessing Configuration Values

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/configuration.md

Use the Laravel config helper to retrieve date and time format settings.

```php
// In a Blade view or PHP code
$dateFormat = config('filament-jalali.date_format');      // 'Y/m/d'
$dateTimeFormat = config('filament-jalali.date_time_format'); // 'Y/m/d H:i:s'
```

--------------------------------

### Configure Application Locale

Source: https://github.com/ariaieboy/filament-jalali/blob/main/README.md

Set the application locale in config/app.php to enable support for Persian, English, Pashto, or Dari.

```php
'locale' => 'fa' // or 'en' for english, 'fa_AF' dari, 'ps' for pashto
```

--------------------------------

### Display Jalali Dates in Infolists

Source: https://github.com/ariaieboy/filament-jalali/blob/main/README.md

Use jalaliDate(), jalaliDateTime(), or their tooltip variants on TextEntry components.

```php
use Filament\Infolists\Components\TextEntry;

TextEntry::make('created_at')->jalaliDate();
TextEntry::make('created_at')->jalaliDateTime();
TextEntry::make('created_at')->since()->jalaliDateTooltip();
TextEntry::make('created_at')->since()->jalaliDateTimeTooltip();
```

--------------------------------

### State Flow Diagram

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/alpine-component.md

Visual representation of the data flow between user interaction, Livewire state, and the UI.

```text
User selects date in calendar
    ↓
selectDate(day) called
    ↓
focusedDate updated
    ↓
Livewire state binding updated (via $entangle)
    ↓
displayText updated (via setDisplayText)
    ↓
Blade input field shows formatted date

---

Livewire state changes externally
    ↓
Component reactive watchers trigger
    ↓
focusedMonth/focusedYear updated
    ↓
Calendar grid re-renders
    ↓
User sees updated calendar
```

--------------------------------

### getSummary()

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/date-constraint-operators.md

Generates a human-readable summary of the filter constraint, returning a localized string indicating the attribute and the selected Jalali date.

```APIDOC
## getSummary()

### Description
Generates a human-readable summary of the filter constraint. It returns a localized message showing the attribute name and the selected Jalali date.

### Signature
`public function getSummary(): string`

### Returns
- **string** - Localized summary text (e.g., "created_at is on 1403/05/15")
```

--------------------------------

### Define Date Format Strings

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/localization.md

Apply Jalali-specific format specifiers to customize date and time display strings.

```php
// From configuration
'date_format' => 'Y/m/d'              // 1403/05/15
'date_time_format' => 'Y/m/d H:i:s'   // 1403/05/15 14:30:45

// Custom formats
'Y-m-d'                 // 1403-05-15
'd/m/Y'                 // 15/05/1403
'Y/m/d H:i'             // 1403/05/15 14:30
```

--------------------------------

### Accessing Translations in Tinker

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/localization.md

Use these commands within the Laravel Tinker environment to verify that translation keys return the expected values.

```bash
php artisan tinker
```

```php
> trans('filament-jalali::months')
> trans('filament-jalali::days.long')
> trans('filament-jalali::days.short')
> trans('filament-jalali::days.today')
```

--------------------------------

### Table Display Macros

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/README.md

Macros for displaying Jalali dates and datetimes in TextColumn components.

```php
// TextColumn
TextColumn::macro('jalaliDate', function (?string $format = null, ?string $timezone = null): static)
TextColumn::macro('jalaliDateTime', function (?string $format = null, ?string $timezone = null): static)
```

--------------------------------

### Extend Filament components with Jalali support

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/README.md

Apply Jalali functionality to standard Filament components using the jalali() or jalaliDate() macros.

```php
// Extends DatePicker with Jalali support
DatePicker::make('date')->jalali()

// Extends TextColumn with Jalali display
TextColumn::make('created_at')->jalaliDate()

// Extends DateConstraint with Jalali operators
DateConstraint::make('date')->jalali()
```

--------------------------------

### Handle Dates in Controllers

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/usage-examples.md

Standard Eloquent model creation remains compatible with Gregorian dates while using the package for display.

```php
public function store(Request $request)
{
    $post = Post::create([
        'title' => $request->title,
        'content' => $request->content,
        'publish_date' => $request->publish_date,  // Stores as Gregorian
        'published_at' => $request->published_at,
    ]);

    return redirect()->route('posts.show', $post);
}
```

--------------------------------

### Initialize jalaliDateTimePickerFormComponent

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/alpine-component.md

Constructor function signature for the Alpine.js component, defining the required configuration parameters for the date picker.

```javascript
export default function jalaliDateTimePickerFormComponent({
    displayFormat,
    firstDayOfWeek,
    isAutofocused,
    locale,
    shouldCloseOnDateSelection,
    state,
    months,
    dayLabel,
    dayShortLabel
})
```

--------------------------------

### Configure DateTimePicker for Jalali

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/types.md

Use the jalali() macro to enable Jalali date and time selection in form schemas.

```php
DateTimePicker::make('published_at')
    ->jalali()
    ->hasToday()
    ->label('Publication Date & Time')
    ->required()
    ->seconds(false)
```

--------------------------------

### Configure Application Locale

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/localization.md

Set the default application locale in the configuration file.

```php
'locale' => 'fa',  // Persian
```

--------------------------------

### DatePicker::jalali() Implementation

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/service-provider.md

Configures the DatePicker component to use the Jalali view and sets default display formats.

```php
DatePicker::macro('jalali', function (bool $weekdaysShort = false) {
    /** @var DatePicker $this */
    $this->view = 'filament-jalali::components.jalali-datetimepicker';
    $this->extraAlpineAttributes(['data-weekdays-short' => ($weekdaysShort ? 'short' : 'long')], true);
    $this->firstDayOfWeek(6);  // Saturday
    $this->displayFormat('Y/m/d');
    return $this;
});
```

--------------------------------

### TextEntry jalaliDateTooltip Macro

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/API-INDEX.md

Adds a Jalali formatted date as a tooltip to an infolist entry.

```php
jalaliDateTooltip(?string $format = null, ?string $timezone = null): static
```

--------------------------------

### Service Provider Dependencies

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/service-provider.md

Required imports for the service provider, including Filament components, external Jalali libraries, and Laravel package tools.

```php
// Filament components
use Filament
Forms
Components
DatePicker;
use Filament
Forms
Components
DateTimePicker;
use Filament
Infolists
Components
TextEntry;
use Filament
Support
Assets
AlpineComponent;
use Filament
Support
Facades
FilamentAsset;
use Filament
Tables
Columns
Column;
use Filament
Tables
Columns
TextColumn;
use Filament
Tables
Filters
QueryBuilder
Constraints
DateConstraint;
use Filament
Tables
Filters
QueryBuilder
Constraints
Operators
IsFilledOperator;

// External libraries
use Ariaieboy
FilamentJalali
DateConstraint
Operators
IsJalaliAfterOperator;
use Ariaieboy
FilamentJalali
DateConstraint
Operators
IsJalaliBeforeOperator;
use Ariaieboy
FilamentJalali
DateConstraint
Operators
IsJalaliDateOperator;
use Ariaieboy
FilamentJalali
DateConstraint
Operators
IsJalaliYearOperator;
use Ariaieboy
Jalali
Jalali;
use Carbon
Carbon;
use Spatie
LaravelPackageTools
Package;
use Spatie
LaravelPackageTools
PackageServiceProvider;
```

--------------------------------

### Usage of jalaliDateTime in Filament Components

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/configuration.md

Demonstrates applying the jalaliDateTime macro to TextColumn and TextEntry components.

```php
use Filament\Tables\Columns\TextColumn;
use Filament\Infolists\Components\TextEntry;

// Uses default format from config
TextColumn::make('updated_at')
    ->jalaliDateTime()

TextEntry::make('submitted_at')
    ->jalaliDateTime()

// Overrides default format
TextColumn::make('event_time')
    ->jalaliDateTime(format: 'Y/m/d H:i')
```

--------------------------------

### Convert Dates Programmatically

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/usage-examples.md

Convert Carbon instances to Jalali objects to access year, month, and day components.

```php
use Ariaieboy\Jalali\Jalali;
use Carbon\Carbon;

// Convert a date to Jalali format
$carbon = Carbon::parse('2024-05-15');
$jalali = Jalali::fromCarbon($carbon);
$formatted = $jalali->format('Y/m/d');  // 1403/02/26

// Get Jalali parts
echo $jalali->year;   // 1403
echo $jalali->month;  // 2
echo $jalali->day;    // 26
```

--------------------------------

### Implement fluent interface with static return type

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/types.md

Enables method chaining by returning the same class instance.

```php
// Chaining multiple macros
DatePicker::make('date')
    ->jalali()              // Returns DatePicker
    ->hasToday()            // Returns DatePicker
    ->label('Select Date')  // Returns DatePicker
```

--------------------------------

### Basic Jalali Date Column

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/usage-examples.md

Displays a date in Jalali format using the default configuration.

```php
use Filament\Tables\Columns\TextColumn;

TextColumn::make('created_at')
    ->jalaliDate()
    ->label('Created')
    ->sortable()
```

--------------------------------

### formatStateUsing Callback

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/types.md

Signature for the callback used by TextColumn and TextEntry macros to transform date state into Jalali strings.

```APIDOC
## formatStateUsing Callback

### Signature
`function(TextColumn|TextEntry $column, $state): ?string`

### Parameters
- **$column** (TextColumn|TextEntry) - The column or entry instance.
- **$state** (mixed) - The raw state value, expected to be a datetime string or Carbon instance.

### Returns
- **?string** - The formatted Jalali date string or null if the input is blank.
```

--------------------------------

### Form Component Macros

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/README.md

Macros for extending DatePicker and DateTimePicker components with Jalali support.

```APIDOC
## DatePicker::jalali

### Description
Enables Jalali calendar support for the DatePicker component.

### Signature
`DatePicker::macro('jalali', function (bool $weekdaysShort = false): static)`

## DatePicker::hasToday

### Description
Configures whether the 'Today' button is displayed in the Jalali picker.

### Signature
`DatePicker::macro('hasToday', function (bool $hasToday = true): static)`

## DateTimePicker::jalali

### Description
Enables Jalali calendar support for the DateTimePicker component.

### Signature
`DateTimePicker::macro('jalali', function (bool $weekdaysShort = false): static)`

## DateTimePicker::hasToday

### Description
Configures whether the 'Today' button is displayed in the Jalali DateTime picker.

### Signature
`DateTimePicker::macro('hasToday', function (bool $hasToday = true): static)`
```

--------------------------------

### Configure Jalali Date and DateTime Pickers

Source: https://github.com/ariaieboy/filament-jalali/blob/main/README.md

Use the jalali() method on form components to enable the Jalali calendar. The hasToday() method adds a button to set the current date.

```php
use Filament\Forms\Components\DatePicker;
use Filament\Forms\Components\DateTimePicker;

DatePicker::make('birth_date')->jalali();
DateTimePicker::make('birth_date')->jalali(weekdaysShort: true);
DateTimePicker::make('birth_date')->jalali(weekdaysShort: true)->hasToday(); // add a today button that when use press on it the date will be set to today
```

--------------------------------

### Define jalaliDateTooltip macro signature

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/macros.md

The method signature for the jalaliDateTooltip macro.

```php
TextEntry::macro('jalaliDateTooltip', function (?string $format = null, ?string $timezone = null): static)
```

--------------------------------

### Switch Locale at Runtime

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/localization.md

Change the locale dynamically within controllers, commands, or Livewire components.

```php
// In a controller or command
app()->setLocale('fa');

// Or in Livewire component
$this->resetPage(pageName: 'locale');
// Then request locale: ?locale=fa
```

--------------------------------

### Set Day Labels

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/alpine-component.md

Configures day labels based on the first day of the week.

```javascript
setDayLabels(): void
```

--------------------------------

### DatePicker::jalali()

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/service-provider.md

Configures a DatePicker component to use the Jalali calendar system.

```APIDOC
## DatePicker::jalali()

### Description
Configures the DatePicker to use the Jalali view, sets the first day of the week to Saturday, and defaults the display format to 'Y/m/d'.

### Parameters
- **weekdaysShort** (bool) - Optional - If true, sets weekday labels to short format.
```

--------------------------------

### IsJalaliAfterOperator getSummary method

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/API-INDEX.md

Generates a localized summary string for the IsJalaliAfterOperator.

```php
public function getSummary(): string
```

--------------------------------

### Register Alpine component asset

Source: https://github.com/ariaieboy/filament-jalali/blob/main/_autodocs/errors.md

Shows the service provider registration logic for the Alpine component.

```php
FilamentAsset::register([
    AlpineComponent::make('jalali-datetime-picker', __DIR__.'/../resources/dist/js/jalali-date-time-picker.js'),
], package: 'ariaieboy/jalali');
```
Tokens:
Raw