Filament Kanban

https://github.com/mokhosh/filament-kanban
Admin
Filament Kanban is a package that allows developers to easily integrate and customize interactive...
Tokens:31,878
Snippets:240
Trust Score:7.5
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install via Composer

Source: https://github.com/mokhosh/filament-kanban/blob/main/README.md

Run this command in your terminal to install the package.

```bash
composer require mokhosh/filament-kanban
```

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

### Generated file example

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/make-kanban-board-command.md

Example of the generated file after running the command, showing the required manual edits to replace `Model::class` and `ModelStatus::class` with the actual model and status enum.

```php
<?php

namespace App\Filament\Pages;

use App\Models\Task;
use Mokhosh\FilamentKanban\Pages\KanbanBoard;

class TasksKanbanBoard extends KanbanBoard
{
    protected static string $model = Task::class;
    protected static string $statusEnum = TaskStatus::class;
}
```

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

### Get Plugin Instance

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/filament-kanban-plugin.md

Resolves the currently registered plugin instance from the panel. Includes usage example.

```php
// src/FilamentKanbanPlugin.php:30-36
public static function get(): static
{
    /** @var static $plugin */
    $plugin = filament(app(static::class)->getId());

    return $plugin;
}
```

```php
$plugin = FilamentKanbanPlugin::get();

assert($plugin->getId() === 'filament-kanban');
```

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

### Standard Pest/Livewire Kanban Board Tests

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/tests-filament-kanban.md

Examples of testing Kanban board interactions using standard Pest and Livewire methods.

```php
use function Pest\Laravel\actingAs;
use function Pest\Livewire\livewire;

it('moves a task to another status', function () {
    $task = Task::factory()->todo()->create();

    actingAs($this->admin)->get(TestBoard::getUrl());

    livewire(TestBoard::class)
        ->dispatch('status-changed', $task->id, TaskStatus::Done->value, [], []);

    expect($task->fresh()->status)->toBe(TaskStatus::Done);
});

it('opens and submits the edit modal', function () {
    $task = Task::factory()->todo()->create();

    livewire(TestBoard::class)
        ->call('recordClicked', $task->id, [])
        ->assertDispatched('open-modal', id: 'kanban--edit-record-modal')
        ->set('editModalFormState.title', 'New Title')
        ->call('editModalFormSubmitted')
        ->assertDispatched('close-modal', id: 'kanban--edit-record-modal');

    expect($task->fresh()->title)->toBe('New Title');
});

it('can hide the edit modal', function () {
    livewire(TestBoard::class)
        ->set('disableEditModal', true)
        ->assertDontSee('Edit Record');
});
```

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

### get()

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/filament-kanban-plugin.md

Static method that returns the currently registered plugin instance for the panel, resolved via the filament() global helper using the id 'filament-kanban'. Throws an Error if called before the plugin is registered.

```APIDOC
## get()

### Description
Static method that returns the currently registered plugin instance for the panel, resolved via the filament() global helper using the id 'filament-kanban'. Throws an Error if called before the plugin is registered.

### Method
get()

### Signature
public static function get(): static

### Parameters
None

### Return
- **static** - The currently registered plugin instance for the panel.

### Throws
- **Error** - If called before/without the plugin being registered on a panel (delegated to Filament's filament() helper).

### Example
```php
$plugin = FilamentKanbanPlugin::get();

assert($plugin->getId() === 'filament-kanban');
```
```

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

### Override kanbanCases() to expose subset

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/is-kanban-status.md

Example of overriding kanbanCases() to return only specific cases.

```php
public static function kanbanCases(): array
{
    return [
        static::Todo,
        static::Done,
    ];
}
```

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

### Default records() usage

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/kanban-board.md

Example of defining the model for the Kanban board using the default records() behavior.

```php
class TasksKanbanBoard extends KanbanBoard
{
    protected static string $model = Task::class;
}
```

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

### Scope query in KanbanBoard

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/kanban-board.md

Example of overriding getEloquentQuery to scope records to the authenticated user.

```php
use Illuminate	ypesuilder;

class TasksKanbanBoard extends KanbanBoard
{
    protected function getEloquentQuery(): Builder
    {
        return static::$model::query()->where('user_id', auth()->id());
    }
}
```

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

### Make Plugin Instance

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/filament-kanban-plugin.md

Creates a new instance of the plugin using the Laravel container. Includes an example of registering the plugin in an AdminPanelProvider.

```php
// src/FilamentKanbanPlugin.php:25-28
public static function make(): static
{
    return app(static::class);
}
```

```php
use App\Providers\Filament\AdminPanelProvider;
use Mokhosh\FilamentKanban\FilamentKanbanPlugin;

class AdminPanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            ->default()
            ->id('admin')
            ->plugins([
                FilamentKanbanPlugin::make(),
            ]);
    }
}
```

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

### Usage of statuses() with enum

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/is-kanban-status.md

Example enum using the trait and calling statuses() to get the status items.

```php
enum TaskStatus: string
{
    use IsKanbanStatus;

    case Todo = 'Todo';
    case Doing = 'Doing';
    case Done = 'Done';
}

// Returns [[ 'id' => 'Todo', 'title' => 'Todo' ], ...]
TaskStatus::statuses();
```

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

### Status item array override

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/types.md

An example of returning a collection of status items using a plain-array override in KanbanBoard::statuses().

```php
return collect([
    ['id' => 'user', 'title' => 'User'],
    ['id' => 'admin', 'title' => 'Admin'],
]);
```

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

### Custom onSortChanged() implementation

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-status-change.md

Example of overriding the onSortChanged hook for custom reorder logic.

```php
class TasksKanbanBoard extends KanbanBoard
{
    public function onSortChanged(int|string $recordId, string $status, array $orderedIds): void
    {
        User::setNewOrder($orderedIds);
    }
}
```

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

### editRecord() custom override

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-edit-record-modal.md

Example of overriding editRecord to save data into a specific column.

```php
use Illuminate	ypes

class ClientsKanbanBoard extends KanbanBoard
{
    protected function editRecord(int|string $recordId, array $data, array $state): void
    {
        Model::find($recordId)->update([
            'phone' => $data['phone'],
        ]);
    }
}
```

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

### Customized records() override

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/kanban-board.md

Example of overriding the records() method to apply specific constraints, such as filtering by user role.

```php
use Illuminate	Support	Collection;

class TasksKanbanBoard extends KanbanBoard
{
    protected static string $model = Task::class;

    protected function records(): Collection
    {
        return User::where('role', 'admin')->get();
    }
}
```

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

### Get Plugin ID

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/filament-kanban-plugin.md

Returns the unique identifier for the plugin, which is 'filament-kanban'.

```php
// src/FilamentKanbanPlugin.php:10-13
public function getId(): string
{
    return 'filament-kanban';
}
```

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

### Custom onStatusChanged() override

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-status-change.md

An example of overriding the onStatusChanged method within a KanbanBoard class to implement custom persistence logic.

```php
class TasksKanbanBoard extends KanbanBoard
{
    public function onStatusChanged(int|string $recordId, string $status, array $fromOrderedIds, array $toOrderedIds): void
    {
        User::find($recordId)->update(['status' => $status]);
        User::setNewOrder($toOrderedIds);
    }
}
```

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

### Customizing KanbanBoard Form Schema

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-edit-record-modal.md

Example of overriding getEditModalFormSchema within a KanbanBoard subclass to provide a custom form structure.

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

class TasksKanbanBoard extends KanbanBoard
{
    protected function getEditModalFormSchema(null|int|string $recordId): array
    {
        return [
            TextInput::make('title')->required(),
            Select::make('team')->relationship('team', 'name'),
        ];
    }
}
```

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

### Override getTitle() to customize column header

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/is-kanban-status.md

Example of overriding getTitle() to return a localized label.

```php
public function getTitle(): string
{
    return __($this->label());
}
```

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

### Implement packageBooted in FilamentKanbanServiceProvider

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/filament-kanban-service-provider.md

This method is called by PackageServiceProvider::boot() after configuration to register assets, publish stubs, and mix in testing functionality.

```php
public function packageBooted(): void
{
    // Asset Registration
    FilamentAsset::register(
        $this->getAssets(),
        $this->getAssetPackageName()
    );

    // Handle Stubs
    if (app()->runningInConsole()) {
        foreach (app(Filesystem::class)->files(__DIR__ . '/../stubs/') as $file) {
            $this->publishes([
                $file->getRealPath() => base_path("stubs/filament-kanban/{$file->getFilename()}"),
            ], 'filament-kanban-stubs');
        }
    }

    // Testing
    Testable::mixin(new TestsFilamentKanban);
}
```

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

### Publish Assets

Source: https://github.com/mokhosh/filament-kanban/blob/main/README.md

Run this command to publish the necessary assets for correct styling.

```bash
php artisan filament-kanban:install
```

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

### Boot Plugin

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/filament-kanban-plugin.md

Lifecycle hook for booting the plugin within a Filament panel. Currently a no-op.

```php
// src/FilamentKanbanPlugin.php:20-23
public function boot(Panel $panel): void
{
    //
}
```

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

### boot(Panel $panel)

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/filament-kanban-plugin.md

Lifecycle hook required by the Filament Plugin contract. In the current release, this method is a no-op with no behavior.

```APIDOC
## boot(Panel $panel)

### Description
Lifecycle hook required by the Filament Plugin contract. In the current release, this method is a no-op with no behavior.

### Method
boot(Panel $panel)

### Signature
public function boot(Panel $panel): void

### Parameters
- **$panel** (Filament\Panel) - Required - The panel the plugin is booted with.

### Return
- **void** - No return value.

### Example
```php
public function boot(Panel $panel): void
{
    //
}
```
```

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

### Create Kanban Board via Artisan

Source: https://github.com/mokhosh/filament-kanban/blob/main/README.md

Use this command to generate a new Kanban board class.

```bash
php artisan make:kanban UsersKanbanBoard
```

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

### Publish Kanban Views

Source: https://github.com/mokhosh/filament-kanban/blob/main/README.md

Use the artisan command to publish the package views for global customization.

```bash
php artisan vendor:publish --tag="filament-kanban-views"
```

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

### Configure package settings

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/filament-kanban-service-provider.md

The configurePackage method registers assets, commands, and views using the Spatie package tools.

```php
// src/FilamentKanbanServiceProvider.php:22-36
public function configurePackage(Package $package): void
{
    $package->name(static::$name)
        ->hasAssets()
        ->hasCommands($this->getCommands())
        ->hasInstallCommand(function (InstallCommand $command) {
            $command
                ->publishAssets()
                ->askToStarRepoOnGitHub('mokhosh/filament-kanban');
        });

    if (file_exists($package->basePath('/../resources/views'))) {
        $package->hasViews(static::$viewNamespace);
    }
}
```

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

### mount()

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-edit-record-modal.md

Livewire mount hook that fills the form with empty state on page load. Takes no parameters and returns void.

```APIDOC
## mount()

### Description
Livewire mount hook; fills the form with empty state on page load.

### Method
`mount()`

### Signature
```php
public function mount(): void
```

### Parameters
None.

### Return
`void`

### Example
```php
$this->form->fill();
```
```

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

### Import KanbanBoard class

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/kanban-board.md

Use this import statement to reference the KanbanBoard class in your Filament application.

```php
use Mokhosh\FilamentKanban\Pages\KanbanBoard;
```

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

### Usage command

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/make-kanban-board-command.md

Artisan command to generate a new Kanban board page class.

```bash
php artisan make:kanban TasksKanbanBoard
```

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

### getStub() method

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/make-kanban-board-command.md

Returns the path to the stub file used for generating the Kanban board page.

```php
// src/Commands/MakeKanbanBoardCommand.php:15-18
protected function getStub()
{
    return __DIR__ . '/../../stubs/board.stub';
}
```

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

### Run tests with composer

Source: https://github.com/mokhosh/filament-kanban/blob/main/README.md

Execute the test suite for the package using the composer test command.

```bash
composer test
```

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

### Import FilamentKanbanServiceProvider

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/filament-kanban-service-provider.md

The namespace import required to use the service provider class.

```php
use Mokhosh\FilamentKanban\FilamentKanbanServiceProvider;
```

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

### Define static properties

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/filament-kanban-service-provider.md

Static configuration properties for the package name and view namespace.

```php
// src/FilamentKanbanServiceProvider.php:18
public static string $name = 'filament-kanban';

// src/FilamentKanbanServiceProvider.php:20
public static string $viewNamespace = 'filament-kanban';
```

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

### Configuring Modal via Properties

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-edit-record-modal.md

Instead of overriding getters, you can configure the modal appearance by defining these protected properties in your KanbanBoard subclass.

```php
class TasksKanbanBoard extends KanbanBoard
{
    protected string $editModalTitle = 'Edit Todo';
    protected string $editModalWidth = '4xl';
    protected string $editModalSaveButtonLabel = 'Update';
    protected string $editModalCancelButtonLabel = 'Dismiss';
    protected bool $editModalSlideOver = true;
}
```

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

### Import TestsFilamentKanban

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/tests-filament-kanban.md

The namespace import for the testing mixin class.

```php
use Mokhosh\FilamentKanban\Testing\TestsFilamentKanban;
```

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

### make()

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/filament-kanban-plugin.md

Static factory method that returns a fresh instance of the plugin resolved from the Laravel container. Used for registering the plugin with a Filament panel.

```APIDOC
## make()

### Description
Static factory method that returns a fresh instance of the plugin resolved from the Laravel container. Used for registering the plugin with a Filament panel.

### Method
make()

### Signature
public static function make(): static

### Parameters
None

### Return
- **static** - A fresh instance resolved from the Laravel container (app(static::class)).

### Example
```php
use App\Providers\Filament\AdminPanelProvider;
use Mokhosh\FilamentKanban\FilamentKanbanPlugin;

class AdminPanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            ->default()
            ->id('admin')
            ->plugins([
                FilamentKanbanPlugin::make(),
            ]);
    }
}
```
```

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

### Import FilamentKanbanPlugin

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/filament-kanban-plugin.md

The namespace import required to use the plugin class.

```php
use Mokhosh\FilamentKanban\FilamentKanbanPlugin;
```

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

### Register TestsFilamentKanban in Service Provider

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/tests-filament-kanban.md

The service provider registers the mixin in the packageBooted method.

```php
// src/FilamentKanbanServiceProvider.php:56
Testable::mixin(new TestsFilamentKanban);
```

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

### kanbanCases()

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/is-kanban-status.md

Returns an array of enum cases. Defaults to all cases (static::cases()). Override to expose only a subset of cases on the board.

```APIDOC
## kanbanCases()

### Description
Returns an array of enum cases. Defaults to all cases (static::cases()). Override to expose only a subset of cases on the board.

### Method
kanbanCases()

### Signature
public static function kanbanCases(): array

### Parameters
None.

### Return
array of enum cases.

### Override Example
```php
public static function kanbanCases(): array
{
    return [
        static::Todo,
        static::Done,
    ];
}
```
```

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

### getViewData() method implementation

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/kanban-board.md

The getViewData() method prepares the data for the board view by mapping statuses and filtering records for each status.

```php
// src/Pages/KanbanBoard.php:49-62
protected function getViewData(): array
{
    $records = $this->records();
    $statuses = $this->statuses()
        ->map(function ($status) use ($records) {
            $status['records'] = $this->filterRecordsByStatus($records, $status);

            return $status;
        });

    return [
        'statuses' => $statuses,
    ];
}
```

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

### kanbanCases() method implementation

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/is-kanban-status.md

Returns an array of enum cases, defaulting to all cases. Override to expose a subset.

```php
// src/Concerns/IsKanbanStatus.php:20-23
public static function kanbanCases(): array
{
    return static::cases();
}
```

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

### Implement Drag and Drop Methods

Source: https://github.com/mokhosh/filament-kanban/blob/main/README.md

Override these methods to handle record movement between statuses or reordering within the same status.

```php
public function onStatusChanged(int|string $recordId, string $status, array $fromOrderedIds, array $toOrderedIds): void
{
    User::find($recordId)->update(['status' => $status]);
    User::setNewOrder($toOrderedIds);
}

public function onSortChanged(int|string $recordId, string $status, array $orderedIds): void
{
    User::setNewOrder($orderedIds);
}
```

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

### getEloquentQuery() implementation

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/kanban-board.md

The default implementation of getEloquentQuery in src/Pages/KanbanBoard.php.

```php
// src/Pages/KanbanBoard.php:75-78
protected function getEloquentQuery(): Builder
{
    return static::$model::query();
}
```

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

### Register Plugin

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/filament-kanban-plugin.md

Lifecycle hook for registering the plugin with a Filament panel. Currently a no-op.

```php
// src/FilamentKanbanPlugin.php:15-18
public function register(Panel $panel): void
{
    //
}
```

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

### records() method implementation

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/kanban-board.md

The default implementation of the records() method which retrieves Eloquent models and applies ordering if the scopeOrdered scope exists.

```php
// src/Pages/KanbanBoard.php:42-47
protected function records(): Collection
{
    return $this->getEloquentQuery()
        ->when(method_exists(static::$model, 'scopeOrdered'), fn ($query) => $query->ordered())
        ->get();
}
```

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

### mount() method - HasEditRecordModal

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-edit-record-modal.md

Livewire mount hook for the edit record modal. Fills the form with an empty state on page load. Accepts no parameters and returns void.

```php
// src/Concerns/HasEditRecordModal.php:26-29
public function mount(): void
{
    $this->form->fill();
}
```

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

### statuses() method implementation

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/is-kanban-status.md

Returns a collection of status items, each with 'id' and 'title' keys, derived from kanbanCases().

```php
// src/Concerns/IsKanbanStatus.php:9-18
public static function statuses(): Collection
{
    return collect(static::kanbanCases())
        ->map(function (self $item) {
            return [
                'id' => $item->getId(),
                'title' => $item->getTitle(),
            ];
        });
}
```

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

### Enum-driven statuses configuration

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/kanban-board.md

Configuring the Kanban board using an enum that implements the IsKanbanStatus trait.

```php
use Mokhoshilament-kanban\Concerns\IsKanbanStatus;

enum TaskStatus: string
{
    use IsKanbanStatus;

    case Todo = 'Todo';
    case Doing = 'Doing';
    case Done = 'Done';
}

class TasksKanbanBoard extends KanbanBoard
{
    protected static string $statusEnum = TaskStatus::class;
}
```

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

### Import IsKanbanStatus trait

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/is-kanban-status.md

Import the IsKanbanStatus trait to use it in a string-backed enum.

```php
use Mokhosh\FilamentKanban\Concerns\IsKanbanStatus;
```

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

### KanbanBoard static configuration properties

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/kanban-board.md

These protected static properties are intended to be overridden in subclasses to customize the kanban board. The $model and $statusEnum properties must be overridden.

```php
// src/Pages/KanbanBoard.php:17
protected static ?string $navigationIcon = 'heroicon-o-document-text';

// src/Pages/KanbanBoard.php:19
protected static string $view = 'filament-kanban::kanban-board';

// src/Pages/KanbanBoard.php:21
protected static string $headerView = 'filament-kanban::kanban-header';

// src/Pages/KanbanBoard.php:23
protected static string $recordView = 'filament-kanban::kanban-record';

// src/Pages/KanbanBoard.php:25
protected static string $statusView = 'filament-kanban::kanban-status';

// src/Pages/KanbanBoard.php:27
protected static string $scriptsView = 'filament-kanban::kanban-scripts';

// src/Pages/KanbanBoard.php:29
protected static string $model;                       // MUST be overridden

// src/Pages/KanbanBoard.php:31
protected static string $statusEnum;                  // MUST be overridden

// src/Pages/KanbanBoard.php:33
protected static string $recordTitleAttribute = 'title';

// src/Pages/KanbanBoard.php:35
protected static string $recordStatusAttribute = 'status';
```

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

### Command identity properties

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/make-kanban-board-command.md

Defines the Artisan command name, description, and type for the `make:kanban` command.

```php
// src/Commands/MakeKanbanBoardCommand.php:9
public $name = 'make:kanban';

// src/Commands/MakeKanbanBoardCommand.php:11
public $description = 'Create a filament kanban board page';

// src/Commands/MakeKanbanBoardCommand.php:13
public $type = 'Kanban page';
```

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

### register(Panel $panel)

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/filament-kanban-plugin.md

Lifecycle hook required by the Filament Plugin contract. In the current release, this method is a no-op with no behavior.

```APIDOC
## register(Panel $panel)

### Description
Lifecycle hook required by the Filament Plugin contract. In the current release, this method is a no-op with no behavior.

### Method
register(Panel $panel)

### Signature
public function register(Panel $panel): void

### Parameters
- **$panel** (Filament\Panel) - Required - The panel the plugin is registered with.

### Return
- **void** - No return value.

### Example
```php
public function register(Panel $panel): void
{
    //
}
```
```

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

### Import HasEditRecordModal trait

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-edit-record-modal.md

Import the HasEditRecordModal trait. Normally used implicitly because it is composed into KanbanBoard.

```php
use Mokhosh\FilamentKanban\Concerns\HasEditRecordModal;
```

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

### Import HasStatusChange Trait

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-status-change.md

The namespace import required to use the HasStatusChange trait.

```php
use Mokhoshilament-kanban\Concerns\HasStatusChange;
```

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

### TestsFilamentKanban Class Definition

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/tests-filament-kanban.md

The empty class definition acting as an extension point for Livewire test helpers.

```php
// src/Testing/TestsFilamentKanban.php:7-13
/**
 * @mixin Testable
 */
class TestsFilamentKanban
{
    //
}
```

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

### Status with records mapping

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/types.md

The logic used in KanbanBoard::getViewData() to append records to a status item.

```php
$status['records'] = $this->filterRecordsByStatus($records, $status);
```

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

### Customize Kanban Enum Cases

Source: https://github.com/mokhosh/filament-kanban/blob/main/README.md

Override kanbanCases to return a subset of Enum cases for the board.

```php
public static function kanbanCases(): array
{
    return [
        static::CaseOne,
        static::CaseThree,
    ];
}
```

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

### form() method

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-edit-record-modal.md

Configures the Filament form for the edit modal. Sets the schema from getEditModalFormSchema(), state path 'editModalFormState', and the model to the edited record instance or the model class when no record is selected.

```php
// src/Concerns/HasEditRecordModal.php:56-62
public function form(Form $form): Form
{
    return $form
        ->schema($this->getEditModalFormSchema($this->editModalRecordId))
        ->statePath('editModalFormState')
        ->model($this->editModalRecordId ? static::$model::find($this->editModalRecordId) : static::$model);
}
```

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

### Define a Kanban Board Class

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/configuration.md

Extend the KanbanBoard class to define the model, status enum, and custom form schema for the edit modal.

```php
class TestBoard extends KanbanBoard
{
    protected static string $model = Task::class;

    protected static string $statusEnum = TaskStatus::class;

    protected function getEditModalFormSchema(null | int | string $recordId): array
    {
        return [
            Forms"::"Components"::"TextInput::make('title')->required(),
            Forms"::"Components"::"Select::make('team')
                ->relationship('team', 'name')
                ->multiple()
                ->options(User::pluck('name', 'id')),
        ];
    }
}
```

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

### Stub content (stubs/board.stub)

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/make-kanban-board-command.md

The stub template used to generate a new Kanban board page. Contains placeholders `DummyNamespace` and `DummyClass` that are replaced by Laravel, and literal `Model::class` and `ModelStatus::class` tokens that must be manually replaced.

```php
<?php

namespace DummyNamespace;

use Mokhosh\FilamentKanban\Pages\KanbanBoard;

class DummyClass extends KanbanBoard
{
    protected static string $model = Model::class;
    protected static string $statusEnum = ModelStatus::class;
}
```

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

### Typed static properties configuration

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/types.md

Defines the required and optional static properties for the board. Overriding $model and $statusEnum is mandatory, while $recordTitleAttribute and $recordStatusAttribute have defaults.

```php
protected static string $model;         // Eloquent model class name (MUST override)
protected static string $statusEnum;    // class providing statuses() (MUST override)
protected static string $recordTitleAttribute = 'title';
protected static string $recordStatusAttribute = 'status';
```

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

### Customize Edit Modal Appearance

Source: https://github.com/mokhosh/filament-kanban/blob/main/README.md

Configure modal properties such as title, width, button labels, and slide-over behavior.

```php
protected string $editModalTitle = 'Edit Record';

protected string $editModalWidth = '2xl';

protected string $editModalSaveButtonLabel = 'Save';

protected string $editModalCancelButtonLabel = 'Cancel';

protected bool $editModalSlideOver = true;
```

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

### Override Individual Board Views

Source: https://github.com/mokhosh/filament-kanban/blob/main/README.md

Override specific view properties to customize the appearance of a single Kanban board.

```php
protected static string $view = 'filament-kanban::kanban-board';

protected static string $headerView = 'filament-kanban::kanban-header';

protected static string $recordView = 'filament-kanban::kanban-record';

protected static string $statusView = 'filament-kanban::kanban-status';

protected static string $scriptsView = 'filament-kanban::kanban-scripts';
```

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

### statuses()

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/is-kanban-status.md

Returns a collection of status items, one per kanbanCases() entry, each with an 'id' and 'title' key. This is the shape consumed by KanbanBoard::statuses().

```APIDOC
## statuses()

### Description
Returns a Collection of status items, one per kanbanCases() entry, each an array with exactly two keys: 'id' and 'title'. This is the shape consumed by KanbanBoard::statuses().

### Method
statuses()

### Signature
public static function statuses(): Collection

### Parameters
None.

### Return
Illuminate\Support\Collection of status items, each an array with keys:
- id (string) - $item->getId() - by default the case value
- title (string) - $item->getTitle() - by default the case value

### Usage Example
```php
enum TaskStatus: string
{
    use IsKanbanStatus;

    case Todo = 'Todo';
    case Doing = 'Doing';
    case Done = 'Done';
}

// Returns [[ 'id' => 'Todo', 'title' => 'Todo' ], ...]
TaskStatus::statuses();
```
```

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

### getEloquentQuery()

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/kanban-board.md

Returns the Eloquent Builder instance for the model used by the KanbanBoard. Override this method to scope the query used across records(), edit modal, and status change operations.

```APIDOC
## getEloquentQuery()

### Description
Returns the Eloquent Builder for the model associated with the KanbanBoard. This method is used by records(), the HasEditRecordModal trait, and the default onStatusChanged() from HasStatusChange. Overriding it changes the query used everywhere a record is fetched.

### Method
protected function getEloquentQuery(): Builder

### Parameters
None

### Return
Illuminate\Database\Eloquent\Builder for static::$model

### Usage Example
```php
use Illuminate\Database\Eloquent\Builder;

class TasksKanbanBoard extends KanbanBoard
{
    protected function getEloquentQuery(): Builder
    {
        return static::$model::query()->where('user_id', auth()->id());
    }
}
```
```

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

### Default statuses() implementation

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/kanban-board.md

The default implementation of the statuses() method which resolves status items from the static $statusEnum property.

```php
// src/Pages/KanbanBoard.php:37-40
protected function statuses(): Collection
{
    return static::$statusEnum::statuses();
}
```

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

### Override Model Property

Source: https://github.com/mokhosh/filament-kanban/blob/main/README.md

Define the model to be used by the Kanban board.

```php
protected static string $model = User::class;
```

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

### recordClicked()

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-edit-record-modal.md

Handles a record click event, stores the record ID, fills the form with the record's data, and dispatches an open-modal event. Takes a record ID and data array, returns void.

```APIDOC
## recordClicked()

### Description
Stores the record id, re-builds and fills the form with the record's current attributes (via `getEditModalRecordData()`), then dispatches the Livewire browser event `open-modal` with `id: 'kanban--edit-record-modal'`. Invoked from `resources/views/kanban-record.blade.php` via `wire:click="recordClicked('{{ $record->getKey() }}', {{ @json_encode($record) }})"`.

### Method
`recordClicked()`

### Signature
```php
public function recordClicked(int | string $recordId, array $data): void
```

### Parameters
- `$recordId` (int | string) - Required - Record key (`$record->getKey()`, so ULID/string keys work)
- `$data` (array) - Required - Record data passed from the view's `wire:click`. The default view passes `@json_encode($record)`

### Return
`void`

### Error Conditions
If the record cannot be found, `getEditModalRecordData()`'s `->find($recordId)->toArray()` throws `Error` ("Call to a member function toArray() on null").

### Example
```php
$this->editModalRecordId = $recordId;
$this->form($this->form);
$this->form->fill($this->getEditModalRecordData($recordId, $data));
$this->dispatch('open-modal', id: 'kanban--edit-record-modal');
```
```

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

### Define Status Enum

Source: https://github.com/mokhosh/filament-kanban/blob/main/README.md

Create a string-backed enum using the IsKanbanStatus trait to define your board statuses.

```php
use Mokhosh\FilamentKanban\Concerns\IsKanbanStatus;

enum UserStatus: string
{
    use IsKanbanStatus;

    case User = 'User';
    case Admin = 'Admin';
}
```

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

### recordClicked() method - HasEditRecordModal

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-edit-record-modal.md

Handles a record click from the view's wire:click, stores the record ID, re-fills the form with current record data, and dispatches the open-modal event. Throws an Error if the record is not found.

```php
// src/Concerns/HasEditRecordModal.php:31-44
public function recordClicked(int | string $recordId, array $data): void
{
    $this->editModalRecordId = $recordId;

    /**
     * todo - the following line is a hacky fix
     * figure why sometimes form schema is created before this
     * method when a RichText is present in the form schema
     **/
    $this->form($this->form);
    $this->form->fill($this->getEditModalRecordData($recordId, $data));

    $this->dispatch('open-modal', id: 'kanban--edit-record-modal');
}
```

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

### getTitle()

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/is-kanban-status.md

Returns the case value as a string by default. Override to customize the rendered column header.

```APIDOC
## getTitle()

### Description
Returns the case value as a string by default. Override to customize the rendered column header.

### Method
getTitle()

### Signature
public function getTitle(): string

### Parameters
None.

### Return
string - the case value by default.

### Override Example
```php
public function getTitle(): string
{
    return __($this->label());
}
```
```

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

### editRecord() default implementation

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-edit-record-modal.md

The default method for updating a record with form data. Override this method to customize the persistence logic.

```php
// src/Concerns/HasEditRecordModal.php:69-72
protected function editRecord(int | string $recordId, array $data, array $state): void
{
    $this->getEloquentQuery()->find($recordId)->update($data);
}
```

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

### Default onStatusChanged() implementation

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-status-change.md

The default implementation of the onStatusChanged hook as defined in the HasStatusChange concern.

```php
// src/Concerns/HasStatusChange.php:15-24
public function onStatusChanged(int | string $recordId, string $status, array $fromOrderedIds, array $toOrderedIds): void
{
    $this->getEloquentQuery()->find($recordId)->update([
        static::$recordStatusAttribute => $status,
    ]);

    if (method_exists(static::$model, 'setNewOrder')) {
        static::$model::setNewOrder($toOrderedIds);
    }
}
```

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

### Default kanban-record view flash detection

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-recent-update-indication.md

Blade code from the default record view that performs its own flash detection and animation without the trait. It checks timestamps and uses diffInSeconds with absolute diff, then applies a 3-second CSS pulse via Alpine x-init.

```blade
@if($record->timestamps && now()->diffInSeconds($record->{$record::UPDATED_AT}, true) < 3)
    x-data
    x-init="
        $el.classList.add('animate-pulse-twice', 'bg-primary-100', 'dark:bg-primary-800')
        $el.classList.remove('bg-white', 'dark:bg-gray-700')
        setTimeout(() => {
            $el.classList.remove('bg-primary-100', 'dark:bg-primary-800')
            $el.classList.add('bg-white', 'dark:bg-gray-700')
        }, 3000)
    "
@endif
```

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

### getDefaultNamespace() method

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/make-kanban-board-command.md

Returns the default namespace for generated classes, appending `\Filament\Pages` to the root namespace.

```php
// src/Commands/MakeKanbanBoardCommand.php:20-23
protected function getDefaultNamespace($rootNamespace)
{
    return $rootNamespace . '\Filament\Pages';
}
```

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

### getTitle() method implementation

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/is-kanban-status.md

Returns the case value by default, used as the status item title.

```php
// src/Concerns/IsKanbanStatus.php:30-33
public function getTitle(): string
{
    return $this->value;
}
```

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

### statusChanged Listener Method

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-status-change.md

The Livewire event listener method that handles the status-changed event and forwards it to the onStatusChanged hook.

```php
// src/Concerns/HasStatusChange.php:9-13
#[On('status-changed')]
public function statusChanged(int | string $recordId, string $status, array $fromOrderedIds, array $toOrderedIds): void
{
    $this->onStatusChanged($recordId, $status, $fromOrderedIds, $toOrderedIds);
}
```

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

### getEditModalRecordData() implementation

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-edit-record-modal.md

Retrieves the record attributes as an array to populate the edit form. Throws an error if the record is not found.

```php
// src/Concerns/HasEditRecordModal.php:64-67
protected function getEditModalRecordData(int | string $recordId, array $data): array
{
    return $this->getEloquentQuery()->find($recordId)->toArray();
}
```

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

### form(Form $form)

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-edit-record-modal.md

Configures the Filament form for the edit record modal. It sets the schema from getEditModalFormSchema(), the state path to 'editModalFormState', and the model to the edited record or the model class.

```APIDOC
## `form(Form $form)`

### Description
Configures the Filament form instance for the edit record modal. It sets the schema from `getEditModalFormSchema()`, the state path to `editModalFormState`, and the model to the edited record instance (or the model class when no record is selected).

### Method
`form`

### Parameters
- `$form` (`Filament\Forms\Form`) - Required - The form instance supplied by Filament's `HasForms`.

### Return
`Filament\Forms\Form` - The configured form instance.

### Behavior
- Sets schema to `$this->getEditModalFormSchema($this->editModalRecordId)`
- Sets state path to `editModalFormState`
- Sets model to `static::$model::find($this->editModalRecordId)` if a record is selected, otherwise `static::$model`.
```

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

### Override statuses Method

Source: https://github.com/mokhosh/filament-kanban/blob/main/README.md

Define custom logic for retrieving board statuses without using an Enum.

```php
protected function statuses(): Collection
{
     return collect([
         ['id' => 'user', 'title' => 'User'],
         ['id' => 'admin', 'title' => 'Admin'],
     ]);
}
```

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

### getId() method implementation

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/is-kanban-status.md

Returns the case value, used as the status item id.

```php
// src/Concerns/IsKanbanStatus.php:25-28
public function getId(): string
{
    return $this->value;
}
```

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

### getId()

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/filament-kanban-plugin.md

Returns the unique plugin id 'filament-kanban'. This id is used by the filament() helper to resolve the plugin and by consumers when registering the plugin with a panel.

```APIDOC
## getId()

### Description
Returns the plugin's unique id, 'filament-kanban'. This id is what filament() resolves against in get() and what a consumer would pass to $panel->plugins([FilamentKanbanPlugin::make()]).

### Method
getId()

### Signature
public function getId(): string

### Parameters
None

### Return
- **string** - The plugin's unique id, 'filament-kanban'.

### Example
```php
$plugin = FilamentKanbanPlugin::get();
assert($plugin->getId() === 'filament-kanban');
```
```

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

### Import HasRecentUpdateIndication trait

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-recent-update-indication.md

Import the deprecated trait for use in a model. The trait is retained for backward compatibility but is no longer necessary.

```php
use Mokhosh\FilamentKanban\Concerns\HasRecentUpdateIndication;
```

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

### Override records Method

Source: https://github.com/mokhosh/filament-kanban/blob/main/README.md

Customize the retrieval of records displayed on the board.

```php
protected function records(): Collection
{
    return User::where('role', 'admin')->get();
}
```

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

### JavaScript: Livewire.dispatch calls for status-changed and sort-changed

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/types.md

Dispatches the 'status-changed' and 'sort-changed' browser events with the specified payload keys. These are received by the #[On(...)] listeners in the package.

```javascript
// resources/views/kanban-scripts.blade.php
Livewire.dispatch('status-changed', {recordId, status, fromOrderedIds, toOrderedIds})
Livewire.dispatch('sort-changed',     {recordId, status, orderedIds})
```

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

### statusChanged(int|string $recordId, string $status, array $fromOrderedIds, array $toOrderedIds): void

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-status-change.md

Livewire event listener for the 'status-changed' event. It receives the moved record's ID, the target status ID, and the ordered record IDs from the source and destination columns, then forwards them to the onStatusChanged hook.

```APIDOC
## statusChanged(int|string $recordId, string $status, array $fromOrderedIds, array $toOrderedIds): void

### Description
Listener for the 'status-changed' event dispatched by the board's SortableJS wiring. It forwards the event data to the overridable onStatusChanged hook.

### Method
Event Listener (Livewire 3 #[On('status-changed')])

### Parameters
- **$recordId** (int|string) - Required - Key of the moved record (e.item.id on the DOM element, i.e. $record->getKey())
- **$status** (string) - Required - Target status id (e.to.dataset.statusId)
- **$fromOrderedIds** (array) - Required - Ordered record ids of the source column after the move (e.from.children)
- **$toOrderedIds** (array) - Required - Ordered record ids of the destination column after the move (e.to.children)

### Return
void - Forwards to onStatusChanged().

### Event Dispatch
Client-side dispatch in resources/views/kanban-scripts.blade.php:
```js
Livewire.dispatch('status-changed', {recordId, status, fromOrderedIds, toOrderedIds})
```
```

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

### Status item array structure

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/types.md

The default structure for a status item as produced by IsKanbanStatus::statuses().

```php
[
    'id'    => $item->getId(),    // string, by default the enum case value
    'title' => $item->getTitle(), // string, by default the enum case value
]
```

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

### onSortChanged() hook

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-status-change.md

The default implementation of the onSortChanged hook, which persists the new order if the model supports it.

```php
// src/Concerns/HasStatusChange.php:32-37
public function onSortChanged(int | string $recordId, string $status, array $orderedIds): void
{
    if (method_exists(static::$model, 'setNewOrder')) {
        static::$model::setNewOrder($orderedIds);
    }
}
```

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

### Customize Edit Form Submit Action

Source: https://github.com/mokhosh/filament-kanban/blob/main/README.md

Override the editRecord method to define custom logic when the edit form is submitted.

```php
protected function editRecord(int|string $recordId, array $data, array $state): void
{
    Model::find($recordId)->update([
        'phone' => $data['phone']
    ]);
}
```

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

### HasEditRecordModal properties

Source: https://github.com/mokhosh/filament-kanban/blob/main/_autodocs/api-reference/has-edit-record-modal.md

Property declarations for the edit-record modal. Public properties are Livewire-exposed; protected properties are configurable defaults. The table below lists defaults and descriptions for each property.

```php
// src/Concerns/HasEditRecordModal.php:10
public bool $disableEditModal = false;

// src/Concerns/HasEditRecordModal.php:12
public ?array $editModalFormState = [];

// src/Concerns/HasEditRecordModal.php:14
public null | int | string $editModalRecordId = null;

// src/Concerns/HasEditRecordModal.php:16
protected string $editModalTitle = 'Edit Record';

// src/Concerns/HasEditRecordModal.php:18
protected bool $editModalSlideOver = false;

// src/Concerns/HasEditRecordModal.php:20
protected string $editModalWidth = '2xl';

// src/Concerns/HasEditRecordModal.php:22
protected string $editModalSaveButtonLabel = 'Save';

// src/Concerns/HasEditRecordModal.php:24
protected string $editModalCancelButtonLabel = 'Cancel';
```

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

### Change Navigation Icon

Source: https://github.com/mokhosh/filament-kanban/blob/main/README.md

Update the navigation icon by overriding the $navigationIcon property.

```php
protected static ?string $navigationIcon = 'heroicon-o-document-text';
```
Tokens:
Raw