README

A Livewire component for Jalali (Persian) date picker with AlpineJS.

Features

Jalali (Persian) calendar support
Leap year calculation for Esfand (اسفند) month
Year selection with both input field and dropdown options
Month selection with proper Jalali month names
Day selection that adjusts based on the selected month and year
Inline or column layout options
Default to today's date option
Fully customizable through configuration

Requirements

PHP 8.0 or higher
Laravel 8.0 or higher
Livewire 2.0 or higher
AlpineJS

Installation

You can install the package via composer:

composer require aliqasemzadeh/livewire-jalali-date-picker

After installing the package, you can publish the config file with:

php artisan vendor:publish --provider="Aliqasemzadeh\LivewireJalaliDatePicker\LivewireJalaliDatePickerServiceProvider" --tag="config"

You can also publish the views if you need to customize them:

php artisan vendor:publish --provider="Aliqasemzadeh\LivewireJalaliDatePicker\LivewireJalaliDatePickerServiceProvider" --tag="views"

Usage

In your Livewire component, you can use the JalaliDatePicker like this:

<?php

namespace App\Livewire;

use Livewire\Component;

class MyForm extends Component
{
    public $date;

    public function save()
    {
        $this->validate([
            'date' => 'required|date_format:Y/m/d',
        ]);

        // Save the date...
    }

    public function render()
    {
        return view('livewire.my-form');
    }
}

And in your Blade view:

<div>
    <label>Date</label>
    <livewire:jalali-date-picker wire:model="date" />

    <button type="button" wire:click="save">Save</button>
</div>

Available Properties

The JalaliDatePicker component accepts the following properties:

Property	Type	Default	Description
wire:model	string	-	The property to bind the selected date to
year-input	boolean	false	Whether to use an input field for the year (true) or a dropdown (false)
default-today	boolean	true	Whether to default to today's date if no value is provided
inline-layout	boolean	true	Whether to display inputs in a row (true) or in columns (false)

Example

<livewire:jalali-date-picker
    wire:model="date"
    :year-input="true"
    :default-today="true"
    :inline-layout="true"
/>

Configuration

You can configure the default settings for the JalaliDatePicker component in the config/livewire-jalali-date-picker.php file:

return [
    // Whether to use an input field for the year (true) or a dropdown (false)
    'year_input' => false,

    // Whether to default to today's date if no value is provided
    'default_today' => true,

    // Whether to display inputs in a row (true) or in columns (false)
    'inline_layout' => true,

    // Jalali calendar months
    'months' => [
        1 => 'فروردین',
        2 => 'اردیبهشت',
        3 => 'خرداد',
        4 => 'تیر',
        5 => 'مرداد',
        6 => 'شهریور',
        7 => 'مهر',
        8 => 'آبان',
        9 => 'آذر',
        10 => 'دی',
        11 => 'بهمن',
        12 => 'اسفند',
    ],
];

Testing

composer test

License

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

AI Created

This package was developed with the assistance of artificial intelligence technologies:

Development Process

Initial Design: The component architecture and API were designed with the help of GPT-4, focusing on developer experience and Laravel best practices.
Code Generation: Core functionality was scaffolded using AI code generation, then manually refined and tested.
Documentation: This documentation was enhanced with AI assistance to ensure clarity and completeness.

AI Benefits in This Package

Optimized Algorithms: The Jalali calendar calculations were optimized through AI analysis of different implementation approaches.
Consistent Styling: Component styling and structure follow consistent patterns recommended by AI based on modern web development practices.
Comprehensive Testing: Test cases were expanded using AI-suggested edge cases for date handling.

Human Oversight

While AI played a significant role in development, all code was reviewed, tested, and refined by human developers to ensure:

Security best practices are followed
Performance is optimized for Laravel applications
The component integrates seamlessly with Livewire and Alpine.js

If you have suggestions for improvements or encounter any issues, please feel free to contribute or open an issue on the GitHub repository.

aliqasemzadeh / livewire-jalali-date-picker

Maintainers

Details