Actions

Before you read about the different ways to interact with the calendar, you need to understand how actions work inside it.

Actions used within the calendar need our CalendarAction trait to work properly. We provide drop-in replacements for the regular filament actions that already include everything necessary:

• Guava\Calendar\Filament\Actions\CreateAction
• Guava\Calendar\Filament\Actions\ViewAction
• Guava\Calendar\Filament\Actions\EditAction
• Guava\Calendar\Filament\Actions\DeleteAction

All they do is extend the regular filament action and add a few important setUp calls. So whenever you use one of these, make sure you import the action from our package, not from filament.

Defining actions

Every action you use in the calendar should be defined as a public method on the widget, just as usual when adding an action to a livewire component in filament.

The view, edit and delete actions are already present for you, you don't need to add them.

Create actions you still define yourself, since each model needs its own. For example, to add a createFooAction (where Foo is a model in your app):

use Guava\Calendar\Filament\Actions\CreateAction;

public function createFooAction(): CreateAction
{
    // You can use our helper method
    return $this->createAction(Foo::class);

    // Or you can add it manually, both variants are equivalent:
    return CreateAction::make('createFoo')
        ->model(Foo::class);
}

Mounting actions

Whenever you want to mount an action programmatically within a calendar context, such as in the onDateClick handler, use the mountAction method:

use Guava\Calendar\ValueObjects\DateClickInfo;

protected function onDateClick(DateClickInfo $info): void
{
    $this->mountAction('createFoo');
}

In the background, we pass a few extra arguments along, so your actions can access the calendar context.

Accessing context information

Inside calendar actions, you can type hint contextual information and it will be injected for you if available:

For example, to prefill the form based on where the user clicked:

use Guava\Calendar\Contracts\ContextualInfo;
use Guava\Calendar\Enums\Context;
use Guava\Calendar\ValueObjects\DateClickInfo;
use Guava\Calendar\ValueObjects\DateSelectInfo;

public function createFooAction(): CreateAction
{
    return $this->createAction(Foo::class)
        ->mountUsing(function (?ContextualInfo $info) {
            if ($info instanceof DateClickInfo) {
                // do something on date click
            }

            // Both checks are equal, but instanceof gives you better IDE help
            if ($info->getContext() === Context::DateSelect) {
                // do something on date select
            }
        })
        // You can also type hint each info directly:
        ->mountUsing(fn (?DateClickInfo $dateClick, ?DateSelectInfo $dateSelect) => /* ... */);
}

This is not limited to mountUsing, almost all action methods have access to these. For example, to hide an action in the date click context:

use Guava\Calendar\Contracts\ContextualInfo;
use Guava\Calendar\Enums\Context;

$this->createAction(Foo::class)
    ->hidden(fn (?ContextualInfo $info) => $info?->getContext() === Context::DateClick);

Authorization

Since these are regular filament actions, adding authorization is a breeze:

use Guava\Calendar\Filament\Actions\CreateAction;

public function createFooAction(): CreateAction
{
    return $this->createAction(Foo::class)
        // Authorizes against your FooPolicy
        ->authorize('create', Foo::class)
        // Optionally give the user feedback with a notification
        // containing the response message from your policy
        ->authorizationNotification()
        // For context menu actions, you can instead disable the action
        // and show the message as a tooltip
        ->authorizationTooltip();
}

For detailed information, please follow the filament documentation on authorizing actions.

Record vs event record

When you place a calendar widget on a filament resource page, $record is the record of the currently opened resource page, whereas $eventRecord is the record of the calendar event you are interacting with.