Advanced Kanban

https://laravelplugins.com/filament/advanced-kanban
Admin
A powerful and flexible premium Kanban board plugin for Filament 4.x that provides an intuitive...
Tokens:12,985
Snippets:108
Trust Score:2.7
Update:11 months ago
Show doc for...
Tokens:
Raw
### Install Advanced Kanban Plugin

Source: https://laravelplugins.com/filament/advanced-kanban/help

Command to install the Advanced Kanban plugin using Composer. Ensure you have a valid license and correct package name.

```bash
composer require asmit/advanced-kanban
```

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

### Add Private Composer Repository

Source: https://laravelplugins.com/filament/advanced-kanban/installation

Configure your project's composer.json to include the private registry for the Advanced Kanban package. This allows composer to locate and download the package.

```json
{
  "repositories": [
    {
      "type": "composer",
      "url": "https://filament-advanced-kanban.composer.sh"
    }
  ]
}
```

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

### Create a Kanban Page with Artisan

Source: https://laravelplugins.com/filament/advanced-kanban/quick-start

This command generates a new Filament page that will serve as the base for your kanban board. It uses the Artisan command-line tool provided by Laravel.

```bash
php artisan make:filament-page TasksKanban
```

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

### Register Kanban Builder Plugin in Filament Panel

Source: https://laravelplugins.com/filament/advanced-kanban/installation

Register the KanbanBuilder plugin within your Filament panel configuration. This makes the kanban functionality available in your Filament application.

```php
<?php

use Asmit\AdvancedKanban\KanbanBuilder;
use Filament\Panel;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            KanbanBuilder::make()
            // Other plugins if any
        ]);
}
```

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

### Publish Filament Assets

Source: https://laravelplugins.com/filament/advanced-kanban/help

Command to publish Filament assets, often required after installation or updates to ensure proper loading. Clear application and view cache if assets are not loading.

```bash
php artisan filament:assets
```

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

### Configure Kanban Page in PHP

Source: https://laravelplugins.com/filament/advanced-kanban/quick-start

This PHP code demonstrates how to configure a custom Kanban page by extending the `KanbanPage` class. It specifies the model, status field, and defines the kanban columns. Ensure you have `title` and `description` fields in your model.

```php
<?php

namespace App\Filament\Pages;

use App\Models\Task;
use Asmit\AdvancedKanban\Columns\KanbanColumn;
use Asmit\AdvancedKanban\Pages\KanbanPage;
use Asmit\AdvancedKanban\Kanban;

class TasksKanban extends KanbanPage  // ← Must extend KanbanPage
{
    // Other properties like $navigationIcon, $navigationGroup, etc.

    public function kanban(Kanban $kanban): Kanban
    {
        return $kanban
            ->model(Task::class)           // ← Pass your model
            ->statusField('status')        // ← Pass the status field
            ->columns([
                KanbanColumn::make('todo')     // ← Pass required column
                    ->label('To Do'),
                KanbanColumn::make('in_progress')
                    ->label('In Progress'),
                KanbanColumn::make('completed')
                    ->label('Completed'),
            ])
            ->searchableFields(['title', 'description'])
            ->recordsPerColumn(10);
    }
}

```

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

### Basic Search Setup in Kanban Page (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/search

This snippet demonstrates the basic setup for enabling search functionality in a Filament Kanban page. It utilizes the `->searchableFields()` method to specify which model attributes should be searchable. It supports searching through related models using dot notation.

```php
public function kanban(Kanban $kanban): Kanban
{
    return $kanban
        ->model(Task::class)
        ->statusField('status')
        ->searchableFields(['title', 'description', 'assignedTo.name']) // ← Add searchable fields here
        ->columns([
            // Your columns here
        ]);
}
```

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

### Advanced MRR Kanban Configuration (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/relational-records/mrr-kanban-setup

Provides an example of advanced configuration for the MRR Kanban board, including custom labels, colors, and icons for each Kanban column, along with adjustments for searchable fields and records per column. This allows for a more visually customized and functional Kanban display.

```php
<?php

namespace App\Filament\Pages;

use App\Filament\Resources\UserResource;
use App\Models\Task;
use Asmit\AdvancedKanban\Concerns\HasKanbanRelatedRecords;
use Asmit\AdvancedKanban\Contracts\HasKanban;
use Asmit\AdvancedKanban\Kanban;
use Asmit\AdvancedKanban\Columns\KanbanColumn;
use Filament\Resources\Pages\ManageRelatedRecords;

class UserTasks extends ManageRelatedRecords implements HasKanban
{
    use HasKanbanRelatedRecords;

    protected static string $resource = UserResource::class;
    protected static string $relationship = 'tasks';

    public function kanban(Kanban $kanban): Kanban
    {
        return $kanban
            ->model(Task::class)
            ->statusField('status')
            ->titleField('title')
            ->descriptionField('description')
            ->columns([
                KanbanColumn::make('todo')
                    ->label('To Do')
                    ->color('gray')
                    ->icon('heroicon-o-clock'),
                
                KanbanColumn::make('in-progress')
                    ->label('In Progress')
                    ->color('blue')
                    ->icon('heroicon-o-play'),
                
                KanbanColumn::make('review')
                    ->label('Review')
                    ->color('yellow')
                    ->icon('heroicon-o-eye'),
                
                KanbanColumn::make('done')
                    ->label('Done')
                    ->color('green')
                    ->icon('heroicon-o-check-circle'),
            ])
            ->searchableFields(['title', 'description'])
            ->recordsPerColumn(15);
    }
}
```

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

### Basic Record Move Customization in PHP

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/advanced-features/handle-record-move

Override the `handleRecordMove` method to customize the behavior when a record is moved between Kanban columns. This example updates the record's status and logs the activity. It requires the `Task` model and an `activity()` helper.

```php
<?php

namespace App\Filament\Pages;

use App\Models\Task;
use Illuminate\Database\Eloquent\Model;

class TasksKanban extends KanbanPage
{
    public function handleRecordMove(string $newStatus, Model $record): void
    {
        // Update the record's status
        $record->update(['status' => $newStatus]);
        
        // Log the move
        activity()
            ->performedOn($record)
            ->log("Task moved to {$newStatus}");
    }
}
```

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

### Configure Built-in DeleteAction with Confirmation (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/columns/record-actions

This example demonstrates the usage of the `DeleteAction`, a built-in action for removing records. It includes options for setting a custom label, icon, and color. Crucially, it shows how to enable confirmation prompts using `requiresConfirmation()`, `modalHeading()`, and `modalDescription()` to prevent accidental deletions. The `DeleteAction::make()` method is the entry point.

```php
use Asmit\AdvancedKanban\RecordAction\DeleteAction;

DeleteAction::make('delete')
    ->label('Delete Task')
    ->icon('heroicon-o-trash')
    ->color('danger')
    ->action(fn($record) => $this->deleteTask($record))
    ->requiresConfirmation()
    ->modalHeading('Delete Task')
    ->modalDescription('Are you sure you want to delete this task? This action cannot be undone.');

```

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

### Custom Column Header Component Structure (Blade)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/advanced-features/components

Example of a custom column header component using Blade. It displays the column icon, label, description, and any slotted actions. It utilizes Tailwind CSS for styling and Heroicons for icons.

```blade
{{-- resources/views/components/kanban/tasks/column-header.blade.php --}}
<div class="flex items-center justify-between p-4 bg-gray-50 border-b">
    <div class="flex items-center space-x-2">
        @if($icon)
            <x-heroicon-o-{{ $icon }} class="w-5 h-5 text-gray-500" />
        @endif
        <h3 class="font-semibold text-gray-900">{{ $label }}</h3>
        @if($description)
            <p class="text-sm text-gray-500">{{ $description }}</p>
        @endif
    </div>
    <div class="flex items-center space-x-2">
        {{ $slot }}
    </div>
</div>
```

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

### Define Kanban Columns (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/columns/overview

This snippet shows the basic setup for defining kanban columns within a Laravel Filament kanban page. It uses the `->columns()` method to pass an array of `KanbanColumn` instances, specifying the column's internal name, label, and color.

```php
<?php
use Asmit\AdvancedKanban\Columns\KanbanColumn;

public function kanban(Kanban $kanban): Kanban
{
    return $kanban
        ->model(Task::class)
        ->statusField('status')
        ->columns([
            KanbanColumn::make('todo')
                ->label('To Do')
                ->color('gray'),
            KanbanColumn::make('in_progress')
                ->label('In Progress')
                ->color('blue'),
            KanbanColumn::make('completed')
                ->label('Completed')
                ->color('green'),
        ]);
}
```

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

### Custom Card Component Structure (Blade)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/advanced-features/components

Example of a custom card component using Blade. It displays the record's title, description, creation date, and due date, along with any actions. Includes a lock icon if the card is locked. Uses Tailwind CSS for styling.

```blade
{{-- resources/views/components/kanban/tasks/card.blade.php --}}
<div class="bg-white rounded-lg shadow-sm border p-4 hover:shadow-md transition-shadow">
    <div class="flex items-start justify-between">
        <div class="flex-1">
            <h4 class="font-medium text-gray-900 mb-2">{{ $title }}</h4>
            @if($description)
                <p class="text-sm text-gray-600 mb-3">{{ $description }}</p>
            @endif
            <div class="flex items-center space-x-2 text-xs text-gray-500">
                <span>Created: {{ $record->created_at->diffForHumans() }}</span>
                @if($record->due_date)
                    <span>Due: {{ $record->due_date->format('M d') }}</span>
                @endif
            </div>
        </div>
        @if($isLocked)
            <div class="ml-2">
                <x-heroicon-o-lock-closed class="w-4 h-4 text-gray-400" />
            </div>
        @endif
    </div>
    @if($actions)
        <div class="mt-3 pt-3 border-t">
            {{ $actions }}
        </div>
    @endif
</div>
```

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

### Standalone Kanban Page with Tab Filtering (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/filters/tab-filters

Example of a standalone Kanban page in Filament that uses tabs to filter records. Each tab can have a custom query modification to scope the displayed Kanban items. This requires the AdvancedKanban plugin and Filament.

```php
use Asmit\AdvancedKanban\Pages\KanbanPage;
use Filament\Schemas\Components\Tabs\Tab;
use Illuminate\Database\Eloquent\Builder;

class TaskKanban extends KanbanPage
{
    public function getTabs(): array
    {
        return [
            'All' => Tab::make('All'),
            'High Priority' => Tab::make('High Priority')
                ->modifyQueryUsing(fn (Builder $query) => $query->where('priority', 'high')),
        ];
    }

    public function kanban(Kanban $kanban): Kanban
    {
        return $kanban
            ->model(Task::class)
            ->statusField('status')
            // ... other Kanban config
        ;
    }
}
```

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

### Group Record Actions with ActionGroup in Kanban (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/columns/record-actions

This example shows how to group multiple record actions, including a 'view', 'duplicate', and 'delete' action, under a single 'More Actions' button using `ActionGroup`. This improves organization and user experience by decluttering the record card. It requires importing `Action`, `DeleteAction`, and `ActionGroup`. The `dropdownPlacement` and `icon` can be customized for the group.

```php
use Asmit\AdvancedKanban\RecordAction\Action;
use Asmit\AdvancedKanban\RecordAction\DeleteAction;
use Asmit\AdvancedKanban\Actions\ActionGroup;

public function kanban(Kanban $kanban): Kanban
{
    return $kanban
        ->model(Task::class)
        ->statusField('status')
        ->recordActions([
            Action::make('edit')
                ->label('Edit')
                ->icon('heroicon-o-pencil')
                ->action(fn($record) => $this->editTask($record)),
            ActionGroup::make([
                Action::make('view')
                    ->label('View Details')
                    ->icon('heroicon-o-eye')
                    ->action(fn($record) => $this->viewTask($record)),
                Action::make('duplicate')
                    ->label('Duplicate')
                    ->icon('heroicon-o-document-duplicate')
                    ->action(fn($record) => $this->duplicateTask($record)),
                DeleteAction::make('delete')
                    ->label('Delete')
                    ->icon('heroicon-o-trash')
                    ->color('danger')
                    ->action(fn($record) => $this->deleteTask($record)),
            ])
            ->label('More Actions')
            ->icon('heroicon-o-ellipsis-vertical')
            ->dropdownPlacement('bottom-end'),
        ])
        ->columns([
            // Your columns here
        ]);
}
```

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

### Before Record Move Hook in PHP

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/advanced-features/handle-record-move

Implement the `beforeRecordMove` hook to perform actions or validations before a record is moved between Kanban columns. This example prevents moving a task to 'completed' if subtasks are not finished and logs the move attempt. It requires a `Log` facade.

```php
public function beforeRecordMove(string $newStatus, Model $record): void
{
    // Perform actions before the record is moved
    if ($newStatus === 'completed') {
        // Validate that the task can be completed
        if (!$record->all_subtasks_completed) {
            throw new \Exception('Cannot complete task: all subtasks must be finished');
        }
    }
    
    // Log the move attempt
    \Log::info("Attempting to move task {$record->id} to {$newStatus}");
}
```

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

### Resource Relation Manager with Tab Filtering (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/filters/tab-filters

Example of a Filament resource relation manager demonstrating tab-based filtering for Kanban records. It utilizes the HasKanbanRelatedRecords concern to integrate Kanban functionality and allows custom query modifications per tab. Dependencies include the AdvancedKanban plugin and Filament.

```php
use Asmit\AdvancedKanban\Concerns\HasKanbanRelatedRecords;
use Asmit\AdvancedKanban\Contracts\HasKanban;
use Filament\Schemas\Components\Tabs\Tab;
use Illuminate\Database\Eloquent\Builder;

class ManageProjectTask extends ManageRelatedRecords implements HasKanban
{
    use HasKanbanRelatedRecords;

    public function getTabs(): array
    {
        return [
            'all' => Tab::make(),
            'complete' => Tab::make()
                ->modifyQueryUsing(fn (Builder $query) => $query->where('status', 'complete')),
            'pending' => Tab::make()
                ->modifyQueryUsing(fn (Builder $query) => $query->where('status', 'pending')),
        ];
    }

    public function kanban(Kanban $kanban): Kanban
    {
        return $kanban
            ->model(Task::class)
            ->statusField('status')
            // ... other Kanban config
        ;
    }
}
```

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

### After Record Move Hook in PHP

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/advanced-features/handle-record-move

Implement the `afterRecordMove` hook to perform actions after a record has been successfully moved between Kanban columns. This example sends a notification and updates a completion timestamp when a task is moved to 'completed'. It requires a `TaskCompletedNotification` and a `Log` facade.

```php
public function afterRecordMove(mixed $oldStatus, string $newStatus, Model $record): void
{
    // Perform actions after the record is moved
    if ($newStatus === 'completed') {
        // Send notification
        $record->assignee->notify(new TaskCompletedNotification($record));
        
        // Update completion timestamp
        $record->update(['completed_at' => now()]);
    }
    
    // Log the successful move
    \Log::info("Task {$record->id} moved from {$oldStatus} to {$newStatus}");
}
```

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

### Advanced Kanban Board Configuration with Options in PHP

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/overview

Demonstrates a more detailed configuration for a kanban board, including fields for title, description, searchable fields, pagination, and defining various actions for columns and records.

```php
public function kanban(Kanban $kanban): Kanban
{
    return $kanban
        ->model(Task::class)
        ->statusField('status')
        ->titleField('title')                    // Field to display as card title
        ->descriptionField('description')        // Field to display as card description
        ->searchableFields(['title', 'description']) // Fields to search
        ->recordsPerColumn(10)                   // Pagination limit
        ->columns([
            // Your columns here
        ])
        ->columnHeaderActions([
            // Actions here
        ])
        ->recordActions([
            // Actions here
        ]);
}
```

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

### Basic Kanban Board Configuration in PHP

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/overview

Sets up a basic kanban board by defining the model, status field, and columns. It's essential for initializing a kanban board with your data.

```php
public function kanban(Kanban $kanban): Kanban
{
    return $kanban
        ->model(YourModel::class)        // The model to display
        ->statusField('status')          // The status field name
        ->columns([
            KanbanColumn::make('todo')->label('To Do'),
            KanbanColumn::make('in_progress')->label('In Progress'),
            KanbanColumn::make('completed')->label('Completed'),
        ]);
}
```

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

### Configure Kanban Columns with Advanced Options

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-options

Sets up the kanban columns, allowing for basic key-value pairs or advanced configuration using `KanbanColumn` objects for custom labels, colors, and icons.

```php
use Asmit\AdvancedKanban\Columns\KanbanColumn;

->columns([
    KanbanColumn::make('todo')
        ->label('To Do')
        ->color('gray')
        ->icon('heroicon-o-clock'),
    KanbanColumn::make('done')
        ->label('Done')
        ->color('green')
        ->icon('heroicon-o-check-circle'),
])
```

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

### Create KanbanColumn Instance - PHP

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-column-options

Demonstrates how to create a new KanbanColumn instance using the `make()` method, specifying the status for the column. This is the initial step in defining a Kanban column.

```php
KanbanColumn::make('todo')
KanbanColumn::make('in-progress')
KanbanColumn::make('done')
```

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

### Create MRR Page with Filament CLI (Bash)

Source: https://laravelplugins.com/filament/advanced-kanban/relational-records/mrr-kanban-setup

Generates a new Filament page specifically designed for managing related records, utilizing the 'make:filament-page' command with the '--resource' and '--type' options.

```bash
php artisan make:filament-page ManageUserTasks --resource=UserResource --type=ManageRelatedRecords
```

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

### Add Basic Record Actions to Kanban (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/columns/record-actions

This snippet demonstrates how to add basic record actions, such as 'edit' and 'view', to each record card in a Laravel Advanced Kanban board. It utilizes the `Action::make()` method to define individual actions with labels, icons, and associated controller methods. Imports for `Kanban`, `Action`, and `DeleteAction` are required.

```php
<?php
use Asmit\AdvancedKanban\Kanban;
use Asmit\AdvancedKanban\RecordAction\Action;
use Asmit\AdvancedKanban\RecordAction\DeleteAction;

public function kanban(Kanban $kanban): Kanban
{
    return $kanban
        ->model(Task::class)
        ->statusField('status')
        ->recordActions([
            Action::make('edit')
                ->label('Edit')
                ->icon('heroicon-o-pencil')
                ->action(fn($record) => $this->editTask($record)),
            Action::make('view')
                ->label('View')
                ->icon('heroicon-o-eye')
                ->action(fn($record) => $this->viewTask($record))
                ->openUrlInNewTab(),
        ])
        ->columns([
            // Your columns here
        ]);
}
```

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

### Implement Custom Search Logic for Kanban

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-options

Provides a callback function to define custom logic for how search queries are applied to the underlying data retrieval. This allows for complex filtering beyond simple field matching.

```php
->applySearchUsing(function ($query, $search) {
    return $query->where(function ($q) use ($search) {
        $q->where('title', 'like', "%{$search}%")
          ->orWhere('description', 'like', "%{$search}%");
    });
})
```

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

### Kanban Column Customization in PHP

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/overview

Shows how to customize individual kanban columns by setting labels, colors, icons, descriptions, controlling allowed transitions between columns, and locking specific cards.

```php
KanbanColumn::make('todo')
    ->label('To Do')
    ->color('gray')
    ->icon('heroicon-o-clock')
    ->description('Tasks that need to be started')
    ->allowedTransitions(['in_progress'])        // Control allowed moves
    ->lockCardUsing(fn($record) => false)        // Lock specific cards
    ->extraColumnHeadingClass('font-bold');      // Custom CSS classes
```

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

### Implement Advanced Kanban Filters with DatePicker and Toggle

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/filters/overview

Shows how to implement more advanced filtering options in a Laravel Filament Kanban board, including a date picker for 'due_date' and a toggle for 'is_urgent' tasks. It covers defining the filter schema and the corresponding query application logic.

```php
<?php
use Filament\Forms\Components\DatePicker;
use Filament\Forms\Components\Toggle;

public function kanban(Kanban $kanban): Kanban
{
    return $kanban
        ->model(Task::class)
        ->statusField('status')
        ->filterFormSchema([
            Select::make('priority')
                ->options([
                    'low' => 'Low',
                    'medium' => 'Medium',
                    'high' => 'High',
                ]),
            DatePicker::make('due_date')
                ->label('Due Date'),
            Toggle::make('is_urgent')
                ->label('Urgent Tasks Only'),
        ])
        ->applyFiltersUsing(function(Builder $query, array $data) {
            if (!empty($data['priority'])) {
                $query->where('priority', $data['priority']);
            }
            
            if (!empty($data['due_date'])) {
                $query->whereDate('due_date', $data['due_date']);
            }
            
            if (!empty($data['is_urgent'])) {
                $query->where('is_urgent', true);
            }
            
            return $query;
        });
}

```

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

### Define Searchable Fields for Kanban

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-options

Specifies which fields from the Eloquent model should be indexed and searchable via the kanban board's search functionality.

```php
->searchableFields(['title', 'description'])
->searchableFields(['name', 'users.email'])
```

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

### Set Column Description - PHP

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-column-options

Adds a descriptive text to a Kanban column using the `description()` method. This text can be displayed as a tooltip or subtitle, providing more context about the column's purpose.

```php
->description('Tasks that need to be started')
->description('Tasks currently being worked on')
->description('Completed tasks ready for review')
```

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

### Implement HasKanban Interface for MRR Kanban (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/relational-records/mrr-kanban-setup

Demonstrates how to implement the 'HasKanban' interface and use the 'HasKanbanRelatedRecords' trait within a Filament MRR page to enable Kanban board functionality for related records. It outlines the essential configurations like resource, relationship, model, and status fields.

```php
<?php

namespace App\Filament\Pages;

use App\Filament\Resources\UserResource;
use App\Models\Task;
use Asmit\AdvancedKanban\Concerns\HasKanbanRelatedRecords;
use Asmit\AdvancedKanban\Contracts\HasKanban;
use Asmit\AdvancedKanban\Kanban;
use Asmit\AdvancedKanban\Columns\KanbanColumn;
use Filament\Resources\Pages\ManageRelatedRecords;

class UserTasks extends ManageRelatedRecords implements HasKanban
{
    use HasKanbanRelatedRecords;  // ← Must use this trait

    protected static string $resource = UserResource::class;  // ← Set your resource
    protected static string $relationship = 'tasks';         // ← Set your relationship

    public function kanban(Kanban $kanban): Kanban
    {
        return $kanban
            ->model(Task::class)           // ← Pass your model
            ->statusField('status')        // ← Pass the status field
            ->titleField('title')
            ->descriptionField('description')
            ->columns([
                KanbanColumn::make('To Do'), // ← Pass required column
                KanbanColumn::make('In Progress'),
            ])
            ->searchableFields(['title', 'description'])
            ->recordsPerColumn(10);
    }
}
```

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

### Generate Custom Kanban Components (Artisan Command)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/advanced-features/components

Use this Artisan command to generate the basic structure for custom column header and card components for your Kanban board. It creates Blade files in a specified resource directory.

```bash
php artisan make:kanban-components --resource=YourResource
```

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

### Add Description to Kanban Column (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/columns/overview

Explains how to add a descriptive text to a kanban column using the `->description()` method. This provides users with more context about the status or category represented by the column.

```php
KanbanColumn::make('todo')
    ->label('To Do')
    ->description('Tasks that need to be started')
    ->color('gray');
```

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

### Implement Basic Kanban Filters with Select Fields

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/filters/overview

Demonstrates how to add basic filters for 'priority' and 'assigned_to' using select dropdowns in a Laravel Filament Kanban board. It defines the filter form schema and the logic to apply these filters to the Eloquent builder query.

```php
<?php
use Filament\Forms\Components\Select;
use Illuminate\Contracts\Database\Eloquent\Builder;

public function kanban(Kanban $kanban): Kanban
{
    return $kanban
        ->model(Task::class)
        ->statusField('status')
        ->enableFilterIndicator()
        ->searchableFields(['title', 'description'])
        ->filterFormSchema([
            Select::make('priority')
                ->options([
                    'low' => 'Low',
                    'medium' => 'Medium',
                    'high' => 'High',
                ])
                ->placeholder('All Priorities'),
            Select::make('assigned_to')
                ->options(User::pluck('name', 'id'))
                ->placeholder('All Users'),
        ])
        ->applyFiltersUsing(function(Builder $query, array $data) {
            if (!empty($data['priority'])) {
                $query->where('priority', $data['priority']);
            }
            
            if (!empty($data['assigned_to'])) {
                $query->where('assigned_to', $data['assigned_to']);
            }
            
            return $query;
        })
        ->columns([
            // Your columns here
        ]);
}

```

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

### Evaluate and Render Defined Kanban Action (Blade)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/advanced-features/actions-to-component

This Blade snippet demonstrates how to evaluate and render a previously defined Kanban action, specifically the 'addDocsAction', passing the current record's key as the record ID.

```php
{{ $this->evaluateAction($this->addDocsAction(), ['recordId' => $record->getKey()]) }}
```

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

### Add Basic Action to Kanban Column Header

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/columns/heading-actions

Demonstrates adding a simple action to a Kanban column header using `Action::make()`. This action can trigger custom logic via its `action` callback, receiving column status as an argument. It requires the Filament Actions package.

```php
<?php
use Filament\Actions\Action;

public function kanban(Kanban $kanban): Kanban
{
    return $kanban
        ->model(Task::class)
        ->statusField('status')
        ->columns([
            // Your columns here
        ])
        ->columnHeaderActions([
            Action::make('add_task')
                ->label('Add Task')
                ->icon('heroicon-o-plus')
                ->color('primary')
                ->action(function($arguments) {
                    // $arguments contains the current column status
                    $this->addTaskToColumn($arguments['status']);
                }),
        ]);
}
```

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

### Use Built-in CreateAction for Kanban Columns

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/columns/heading-actions

Shows how to utilize the `CreateAction` provided by the Advanced Kanban plugin for a pre-configured create operation within columns. This action simplifies adding new records and requires defining a form schema for the creation process. It depends on the Advanced Kanban RecordAction namespace.

```php
use Asmit\AdvancedKanban\RecordAction\CreateAction;

CreateAction::make('create')
    ->schema([
        // Your form schema here
    ])

```

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

### Set Eloquent Model for Kanban Board

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-options

Configures the Eloquent model that the Kanban board will use to fetch and display records. This is essential for populating the kanban board with data.

```php
->model(Task::class)
->model(App\Models\Task::class)
```

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

### Set Description Field for Kanban Cards

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-options

Specifies the Eloquent model field that will be shown as the description on each kanban card. Useful for providing more detail at a glance.

```php
->descriptionField('description') // default description field
->descriptionField('content')
->descriptionField('notes')
```

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

### Define Kanban Action with Form Schema (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/advanced-features/actions-to-component

Defines a custom action named 'docs' for the Kanban component. This action includes a form schema with a text input that defaults to the provided record ID, demonstrating how to pass context to the action.

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

public function addDocsAction(): Action
{
    return Action::make('docs')
        ->schema(function (array $arguments): array {
            return [
                TextInput::make('title')->default($arguments['recordId']),
            ];
        });
}
```

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

### Set Record Actions for Kanban Cards (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-options

Configures actions that appear on individual kanban cards. This method accepts an array of Action objects.

```php
use Asmit\AdvancedKanban\RecordAction\Action;

->recordActions([
    Actions\EditAction::make(),
    Actions\DeleteAction::make(),
    Action::make('duplicate')
        ->label('Duplicate'),
])
```

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

### Configure Records Per Column (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-options

Sets the maximum number of records to display within each kanban column. Accepts an integer value for the desired count.

```php
->recordsPerColumn(10)
->recordsPerColumn(25)
```

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

### Custom Search Behavior in Kanban Page (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/search

This snippet shows how to customize the search behavior by overriding the `applySearch` method using `->applySearchUsing()`. It allows for custom query logic, including `orWhere` and `orWhereHas` clauses, to define complex search criteria.

```php
<?php
use Illuminate\Database\Eloquent\Builder;

public function kanban(Kanban $kanban): Kanban
{
    return $kanban
        ->model(Task::class)
        ->statusField('status')
        ->applySearchUsing(function(Builder $query, string $search) {
            return $query->where('title', 'like', '%' . $search . '%')
                ->orWhere('description', 'like', '%' . $search . '%')
                ->orWhereHas('assignedTo', function($q) use ($search) {
                    $q->where('name', 'like', '%' . $search . '%');
                });
        })
        ->columns([
            // Your columns here
        ]);
}
```

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

### Set Column Header Actions (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-options

Configures actions displayed in each column header. This method takes an array of Action objects, allowing for custom actions like adding tasks or exporting.

```php
->columnHeaderActions([
    Actions\Action::make('add_task')
        ->label('Add Task'),
    Actions\Action::make('export_column')
        ->label('Export'),
])
```

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

### Filter and Order Records by Column Status in Kanban (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-column-options

This snippet demonstrates how to use the `modifyRecordQueryUsing` method to filter and order records within a Filament Advanced Kanban board based on column status. It provides access to the query builder and the current column object, allowing for dynamic query adjustments. No external dependencies are required beyond the Filament Advanced Kanban package.

```php
// Filter records based on column status
$kanban->modifyRecordQueryUsing(function ($query, $column) {
    if ($column->getStatus() === 'urgent') {
        return $query->where('priority', 'high');
    }
    return $query;
})

// Add custom ordering for specific columns
$kanban->modifyRecordQueryUsing(function ($query, $column) {
    if ($column->getStatus() === 'done') {
        return $query->orderBy('completed_at', 'desc');
    }
    return $query->orderBy('created_at', 'asc');
})

// Apply column-specific filters
$kanban->modifyRecordQueryUsing(function ($query, $column) {
    if ($column->getStatus() === 'archived') {
        return $query->where('is_archived', true);
    }
    return $query->where('is_archived', false);
})
```

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

### Implement Custom Filter Application Logic

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-options

Allows for custom logic to be applied when filters are submitted. This callback receives the query builder and the filter values, enabling complex conditional filtering.

```php
->applyFiltersUsing(function ($query, $filters) {
    if (isset($filters['priority'])) {
        $query->where('priority', $filters['priority']);
    }
    if (isset($filters['date_range'])) {
        $query->whereBetween('created_at', $filters['date_range']);
    }
    return $query;
})
```

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

### Group Multiple Actions in Kanban Column Header

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/columns/heading-actions

Illustrates how to group several actions under a single dropdown in a Kanban column header using `ActionGroup`. This enhances organization by consolidating related actions like 'Add Task', 'Bulk Edit', and 'Export Column'. It requires Filament Actions and the Advanced Kanban ActionGroup.

```php
use Filament\Actions\Action;
use Asmit\AdvancedKanban\Actions\ActionGroup;

public function kanban(Kanban $kanban): Kanban
{
    return $kanban
        ->model(Task::class)
        ->statusField('status')
        ->columns([
            // Your columns here
        ])
        ->columnHeaderActions([
            ActionGroup::make([
                Action::make('add_task')
                    ->label('Add Task')
                    ->icon('heroicon-o-plus')
                    ->action(fn($arguments) => $this->addTask($arguments['status'])),
                Action::make('bulk_edit')
                    ->label('Bulk Edit')
                    ->icon('heroicon-o-pencil')
                    ->action(fn($arguments) => $this->bulkEdit($arguments['status'])),
                Action::make('export_column')
                    ->label('Export Column')
                    ->icon('heroicon-o-arrow-down-tray')
                    ->action(fn($arguments) => $this->exportColumn($arguments['status'])),
            ])
            ->label('More Actions')
            ->icon('heroicon-o-ellipsis-vertical')
            ->color('gray'),
        ]);
}
```

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

### Override Default Kanban Components (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/advanced-features/components

Configure your custom Kanban page class to use your generated custom components by setting the static properties for the column header and card components. This requires extending the base KanbanPage class.

```php
<?php

namespace App\Filament\Pages;

use Asmit\AdvancedKanban\Pages\KanbanPage;

class TasksKanban extends KanbanPage
{
    protected static string $columnHeaderComponent = 'kanban.tasks.column-header';
    protected static string $cardComponent = 'kanban.tasks.card';

    public function kanban(Kanban $kanban): Kanban
    {
        return $kanban
            ->model(Task::class)
            ->statusField('status')
            ->columns([
                // Your columns here
            ]);
    }
}
```

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

### Set Title Field for Kanban Cards

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-options

Defines the Eloquent model field to be displayed as the title on each kanban card. This is typically a field like 'title', 'name', or 'subject'.

```php
->titleField('title') // default title field
->titleField('name')
->titleField('subject')
```

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

### Configure Kanban Filter Form Schema

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-options

Defines the schema for the filter form, allowing users to filter kanban records. Uses Filament's form components for creating input fields like selects and date pickers.

```php
->filterFormSchema([
    Forms\Components\Select::make('priority')
        ->options(['low', 'medium', 'high']),
    Forms\Components\DatePicker::make('created_at'),
])
```

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

### Set Column Label - PHP

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-column-options

Configures the display label for a Kanban column using the `label()` method. This label is shown as the column header. It accepts a string or a closure for dynamic labeling.

```php
->label('To Do')
->label('In Progress')
->label('Under Review')
->label(fn() => 'Custom ' . ucfirst($this->status))
```

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

### Modify Base Query for Records (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-options

Allows modification of the base query used to fetch kanban records. It accepts a Closure that receives the query builder instance, enabling custom filtering and ordering.

```php
->modifyQueryUsing(function ($query) {
    return $query->where('user_id', auth()->id())
        ->orderBy('priority', 'desc');
})
```

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

### Render Custom Action in Kanban Card (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/advanced-features/actions-to-component

Evaluates a custom action defined within the Kanban component and renders it within a card. It requires the action method name and an array of arguments, including the record ID.

```php
{{ $this->evaluateAction($this->yourAction(), ['recordId' => $record->getKey()]) }}
```

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

### Set Column Color - PHP

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-column-options

Applies a color theme to a Kanban column with the `color()` method. Accepts a color string or a closure for dynamically determined colors based on column status or other conditions.

```php
->color('gray')
->color('blue')
->color('green')
->color('red')
->color(fn() => $this->status === 'urgent' ? 'red' : 'gray')
```

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

### Add Extra CSS Classes to Column Header (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/columns/overview

Shows how to apply additional CSS classes to the kanban column header using the `->extraColumnHeadingClass()` method. This allows for further visual customization of the column headers.

```php
KanbanColumn::make('todo')
    ->label('To Do')
    ->extraColumnHeadingClass('text-lg font-bold'); // Add custom classes
```

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

### Define Kanban Column Transitions (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/advanced-features/workflow

This PHP code snippet demonstrates how to define allowed transitions between Kanban columns using the `->allowedTransitions()` method. It specifies which columns a record can move to from a given column, enforcing workflow rules. This method is part of the `AsmitAdvancedKanbanColumnsKanbanColumn` class.

```php
use Asmit\AdvancedKanban\Columns\KanbanColumn;

public function kanban(Kanban $kanban): Kanban
{
    return $kanban
        ->model(Task::class)
        ->statusField('status')
        ->columns([
            KanbanColumn::make('todo')
                ->label('To Do')
                ->allowedTransitions(['in_progress']), // Can only move to 'In Progress'

            KanbanColumn::make('in_progress')
                ->label('In Progress')
                ->allowedTransitions(['todo', 'review']), // Can move back to 'To Do' or forward to 'Review'

            KanbanColumn::make('review')
                ->label('Review')
                ->allowedTransitions(['in_progress', 'completed']), // Can move back to 'In Progress' or forward to 'Completed'

            KanbanColumn::make('completed')
                ->label('Completed')
                ->allowedTransitions([]), // No transitions allowed from 'Completed'
        ]);
}
```

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

### Add Icon to Kanban Column (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/columns/overview

Illustrates how to add an icon to a kanban column header using the `->icon()` method. The method accepts any valid Heroicon name, providing visual cues for each column.

```php
KanbanColumn::make('todo')
    ->label('To Do')
    ->icon('heroicon-o-clipboard-list'); // Use any Heroicon name
```

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

### Define Allowed Transitions - PHP

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-column-options

Specifies the valid status transitions for records within a Kanban column using `allowedTransitions()`. This method controls drag-and-drop behavior and workflow progression. It accepts an array of statuses or a closure for dynamic rules.

```php
// Simple array format
->allowedTransitions(['in-progress'])

// Multiple allowed transitions
->allowedTransitions(['in-progress', 'review'])

// No transitions allowed (final state)
->allowedTransitions([])

// Dynamic transitions based on conditions
->allowedTransitions(fn() => [
    'in-progress',
    auth()->user()->can('skip-review') ? 'done' : 'review'
])

// Complex workflow rules
->allowedTransitions(fn() => match($this->status) {
    'todo' => ['in-progress'],
    'in-progress' => ['review', 'todo'],
    'review' => ['done', 'in-progress'],
    'done' => ['review'],
    default => []
})
```

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

### Configure Built-in EditAction (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/columns/record-actions

This code snippet shows how to use the pre-configured `EditAction` provided by Advanced Kanban. It simplifies the process of adding an edit action to a record. You can customize the action's schema to define the form fields that appear when the edit action is triggered. The `EditAction::make()` method is used for this purpose.

```php
use Asmit\AdvancedKanban\RecordAction\EditAction;

EditAction::make('edit')
    ->schema([
        // Your form schema here
    ]),

```

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

### Enable or Disable Kanban Search Functionality

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-options

Controls whether the search input is displayed and active on the kanban board. Defaults to enabled.

```php
->searchable(true)   // Enable search
->searchable(false)  // Disable search
```

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

### Set Empty State Message for Columns (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-options

Configures the custom message displayed when a kanban column contains no records. Accepts a string for the message content.

```php
->emptyStateMessage('No tasks in this column yet.')
->emptyStateMessage('Add your first task to get started!')
```

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

### Set Column Icon Color - PHP

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-column-options

Defines the color for the icon associated with a Kanban column using the `iconColor()` method. Supports string color values or closures for dynamic coloring, including using icon sets.

```php
->iconColor('gray')
->iconColor('blue')
->iconColor(Heroicon::OutlinedRectangleStack)
->iconColor('red')
->iconColor(fn() => $this->status === 'urgent' ? 'red' : 'gray')
```

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

### Customize Kanban Column Color (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/columns/overview

Demonstrates how to customize the color of an individual kanban column using the `->color()` method. This method accepts various color formats, including hex, RGB, HSL, and Tailwind CSS color names.

```php
KanbanColumn::make('todo')
    ->label('To Do')
    ->color('green'); // Supports hex, rgb, hsl, and Tailwind colors
```

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

### Modify Base Kanban Query with `modifyQueryUsing` (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/advanced-features/query-modifications

This snippet demonstrates how to globally modify the query for all records in a Kanban board using the `modifyQueryUsing` method. It takes a closure that receives the query builder instance and returns the modified query, allowing for conditions like filtering by active records.

```php
use Asmit\AdvancedKanban\Kanban;

Kanban::make()
    ->modifyQueryUsing(function ($query) {
        return $query->where('is_active', true);
    });
```

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

### Configure Status Field for Kanban Columns

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-options

Specifies the Eloquent model field that determines which column a record belongs to. This field's value maps to the defined kanban columns.

```php
->statusField('status')
->statusField('state')
->statusField('phase')
```

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

### Modify Specific Column Record Query (PHP)

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-options

Enables modification of the query for records within a specific column. The Closure receives both the query builder and the column object, allowing conditional query adjustments.

```php
->modifyRecordQueryUsing(function ($query, $column) {
    if ($column->getStatus() === 'urgent') {
        return $query->where('priority', 'high');
    }
    return $query;
})
```

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

### Control Column Visibility - PHP

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-column-options

Manages whether a Kanban column is displayed or hidden using the `hidden()` method. This can be controlled by a boolean value or a closure to implement conditional visibility based on user roles or data.

```php
->hidden(true)  // Hide the column
->hidden(false) // Show the column
->hidden(fn() => auth()->user()->cannot('view-archived'))
->hidden(fn() => $this->status === 'archived' && !$showArchived)
```

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

### Customizing Lock Icon Appearance in Laravel Advanced Kanban

Source: https://laravelplugins.com/filament/advanced-kanban/kanban/advanced-features/lock-card

Explains how to customize the lock icon displayed on locked cards in Laravel Advanced Kanban using the `lockIcon` method. This allows for the use of any available Heroicon name to visually represent locked cards.

```php
KanbanColumn::make('completed')
    ->label('Completed')
    ->lockCardUsing(fn($record) => true)
    ->lockIcon('heroicon-o-lock-closed'); // Use any Heroicon name
```

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

### Set Locked Card Label - PHP

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-column-options

Configures the text label shown when a card in a Kanban column is locked, using the `lockedLabel()` method. Accepts a string or a closure for conditional labeling.

```php
->lockedLabel('Locked')
->lockedLabel(fn() => $this->status === 'urgent' ? 'Urgently Locked' : 'Locked')
```

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

### Set Locked Card Icon - PHP

Source: https://laravelplugins.com/filament/advanced-kanban/api-reference/kanban-column-options

Specifies the icon to be displayed when a card in a Kanban column is in a locked state using `lockedIcon()`. Supports direct icon references or dynamic closures.

```php
->lockedIcon(Heroicon::OutlineLockClosed)
->lockedIcon(fn() => $this->status === 'urgent' ? Heroicon::OutlineLockClosed : Heroicon::OutlineLockOpen)
```
Tokens:
Raw