Installation - DevDeia Docs

Install via Composer

composer require andreia/filament-recurrence

Add a recurrence column to your table

Recurrence is stored as JSON on your model’s table. Add a nullable json column — name it however you like; the rest of these docs assume recurrence:

php artisan make:migration add_recurrence_to_your_table

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    public function up(): void
    {
        Schema::table('your_table', function (Blueprint $table) {
            $table->json('recurrence')->nullable()->after('your_column');
        });
    }

    public function down(): void
    {
        Schema::table('your_table', function (Blueprint $table) {
            $table->dropColumn('recurrence');
        });
    }
};

php artisan migrate

Publish the config (optional)

php artisan vendor:publish --tag="filament-recurrence-config"

See Configuration for every option.

Add the vendor directory to your theme

@source '../../../../vendor/andreia/filament-recurrence';

Then rebuild:

npm run build

Wire it into your model

Add the cast (and optionally the trait) to the model that owns the recurrence column:

use Andreia\FilamentRecurrence\Casts\RecurrenceCast;
use Andreia\FilamentRecurrence\Concerns\HasRecurrence;

class Event extends Model
{
    use HasRecurrence;

    protected $casts = [
        'recurrence' => RecurrenceCast::class,
    ];
}

The trait adds:

$event->getRecurrenceData();          // RecurrenceData object
$event->getNextOccurrence();          // Next occurrence as Carbon
$event->getUpcomingOccurrences(10);   // Next 10 occurrences
$event->occursOn(Carbon::parse('2024-12-25'));

// Query scopes
Event::occursOn(Carbon::today())->get();
Event::occursBetween(Carbon::now(), Carbon::now()->addMonth())->get();

Next: add the form field, table column, and infolist entry to your resource.