Filament

https://filamentphp.com/docs/5.x/
Admin
Filament is a Laravel admin panel builder that provides a complete CRUD UI system with resources,...
Tokens:952,696
Snippets:7,074
Trust Score:9.6
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Check filament/actions installation with composer show

Source: https://filamentphp.com/docs/5.x/components/action

Run this command to verify that filament/actions is installed. If it is not installed, consult the installation guide and configure the individual components.

```bash
composer show filament/actions

```

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

### Using columnStart() with breakpoints in a Filament grid

Source: https://filamentphp.com/docs/5.x/schemas/layouts

Configures a grid with responsive columns and starts a text input at specific columns for each breakpoint. The example shows a grid with 3 columns on small devices, 6 on extra large, and 8 on extra extra large, with the text input starting at column 2, 3, and 4 respectively, effectively centering it.

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

Grid::make()
    ->columns([
        'sm' => 3,
        'xl' => 6,
        '2xl' => 8,
    ])
    ->schema([
        TextInput::make('name')
            ->columnStart([
                'sm' => 2,
                'xl' => 3,
                '2xl' => 4,
            ]),
        // ...
    ])
```

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

### Run Laravel Boost Installer

Source: https://filamentphp.com/docs/5.x/introduction/ai

Run the interactive installer and select Agent Skills, then filament/filament (skills) when prompted. The installer detects your IDE and AI agents, generating necessary configuration files. Verify installation by checking your agent's skills directory for filament-development/SKILL.md.

```bash
php artisan boost:install

```

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

### Entry utility injection examples

Source: https://filamentphp.com/docs/5.x/infolists/overview

Shows how to use closures in entry methods with injected utilities like $state, $get, $record, $operation, $livewire, $component, and Laravel container dependencies.

```php
use App\Models\User;
use Filament\Infolists\Components\TextEntry;

TextEntry::make('name')
    ->label(fn (string $state): string => str_contains($state, ' ') ? 'Full name' : 'Name')

TextEntry::make('currentUserEmail')
    ->state(fn (): string => auth()->user()->email)

TextEntry::make('role')
    ->hidden(fn (User $record): bool => $record->role === 'admin')

```

```php
function ($state) {
    // ...
}

```

```php
use Filament\Schemas\Components\Utilities\Get;

function (Get $get) {
    $email = $get('email'); // Store the value of the `email` entry in the `$email` variable.
    //...
}

```

```php
use Illuminate\Database\Eloquent\Model;

function (?Model $record) {
    // ...
}

```

```php
function (string $operation) {
    // ...
}

```

```php
use Livewire\Component;

function (Component $livewire) {
    // ...
}

```

```php
use Filament\Infolists\Components\Entry;

function (Entry $component) {
    // ...
}

```

```php
use App\Models\User;
use Filament\Schemas\Components\Utilities\Get;
use Livewire\Component as Livewire;

function (Livewire $livewire, Get $get, User $record) {
    // ...
}

```

```php
use App\Models\User;
use Illuminate\Http\Request;

function (Request $request, User $record) {
    // ...
}

```

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

### Run Boost Installer

Source: https://filamentphp.com/docs/5.x/introduction/ai

Run the Boost installer and select Agent Skills, then filament/blueprint (skills) when prompted.

```bash
php artisan boost:install
```

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

### Install @tiptap/extension-highlight

Source: https://filamentphp.com/docs/5.x/forms/rich-editor

Install the TipTap highlight extension as a dev dependency before creating the JavaScript extension file.

```bash
npm install @tiptap/extension-highlight --save-dev

```

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

### Check filament/forms installation with composer show

Source: https://filamentphp.com/docs/5.x/components/form

Run this command to verify that the filament/forms package is installed in your project. If it is not installed, consult the installation guide and configure the individual components.

```bash
composer show filament/forms

```

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

### Install Filament Panel Builder with Composer and Artisan

Source: https://filamentphp.com/docs/5.x/introduction/installation

Installs the Filament Panel Builder and runs the installer to create the AdminPanelProvider. Use this in a Laravel project directory.

```bash
composer require filament/filament:"^5.0"

php artisan filament:install --panels

```

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

### Add a single example row with example()

Source: https://filamentphp.com/docs/5.x/actions/import

Adds a single example row to the downloadable example CSV for the 'sku' column. The example value is used to populate the row in the generated CSV file.

```php
use Filament\Actions\Imports\ImportColumn;

ImportColumn::make('sku')
    ->example('ABC123')

```

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

### Add multiple example rows with examples()

Source: https://filamentphp.com/docs/5.x/actions/import

Adds multiple example rows to the example CSV for the 'sku' column. Pass an array of values to the examples() method to generate multiple rows.

```php
use Filament\Actions\Imports\ImportColumn;

ImportColumn::make('sku')
    ->examples(['ABC123', 'DEF456'])

```

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

### Plugin usage example

Source: https://filamentphp.com/docs/5.x/plugins/building-a-standalone-plugin

Example usage of the plugin in a user's project, showing how to create a heading with content and color.

```php
use Awcodes\Headings\Heading;

Heading::make(2)
    ->content('Product Information')
    ->color(Color::Lime),

```

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

### Install npm dependencies

Source: https://filamentphp.com/docs/5.x/plugins/building-a-standalone-plugin

Runs npm install to install the dependencies defined in package.json.

```bash
npm install

```

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

### Example state for KeyValueEntry

Source: https://filamentphp.com/docs/5.x/infolists/key-value-entry

Example state for the key-value entry, showing a PHP array with string keys and values.

```php
[
    'description' => 'Filament is a collection of Laravel packages',
    'og:type' => 'website',
    'og:site_name' => 'Filament',
]

```

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

### Install phiki/phiki package

Source: https://filamentphp.com/docs/5.x/infolists/code-entry

Install the phiki/phiki Composer package to use the code entry. Filament does not include it by default.

```bash
composer require phiki/phiki

```

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

### Install Filament frontend assets in an existing Laravel project

Source: https://filamentphp.com/docs/5.x/introduction/installation

Run this command to install the Filament frontend assets in an existing Laravel project. This manual installation preserves your existing functionality.

```bash
php artisan filament:install

```

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

### Install a Chart.js plugin with NPM

Source: https://filamentphp.com/docs/5.x/widgets/charts

Install the chartjs-plugin-datalabels plugin using NPM as a dev dependency.

```bash
npm install chartjs-plugin-datalabels --save-dev
```

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

### Install Tailwind CSS and Vite plugin

Source: https://filamentphp.com/docs/5.x/introduction/installation

Install Tailwind CSS and its Vite plugin if you don't have them installed already.

```bash
npm install tailwindcss @tailwindcss/vite --save-dev

```

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

### Enable profile page for MFA setup

Source: https://filamentphp.com/docs/5.x/users/multi-factor-authentication

Enable the profile page in a Filament panel to automatically add multi-factor authentication setup UI elements.

```php
use Filament\Panel;

public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->profile();
}

```

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

### Install InterNACHI/Modular

Source: https://filamentphp.com/docs/5.x/advanced/modular-architecture

Installs the InterNACHI/Modular package for organizing Filament applications into self-contained modules.

```bash
composer require internachi/modular
```

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

### Install Blueprint via Composer

Source: https://filamentphp.com/docs/5.x/introduction/ai

Install Blueprint 2.x for Filament v5 via Composer. Requires a purchased license and your email address and license key for authentication.

```bash
composer config repositories.filament composer https://packages.filamentphp.com/composer
composer config --auth http-basic.packages.filamentphp.com "YOUR_EMAIL_ADDRESS" "YOUR_LICENSE_KEY"
composer require filament/blueprint --dev
```

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

### Install Filament Panel Builder on Windows PowerShell

Source: https://filamentphp.com/docs/5.x/introduction/installation

Alternative installation command for Windows PowerShell, which ignores the caret (^) character in version constraints. Use this instead of the ^5.0 version.

```bash
composer require filament/filament:"~5.0"

php artisan filament:install --panels

```

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

### Check if filament/notifications is installed

Source: https://filamentphp.com/docs/5.x/components/notifications

Run this Composer command to verify that the filament/notifications package is installed in your project. If it is not installed, consult the installation guide and configure the individual components.

```bash
composer show filament/notifications

```

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

### Check if filament/infolists is installed

Source: https://filamentphp.com/docs/5.x/components/infolist

Run this command to verify that the filament/infolists package is installed in your project. If it is not, consult the installation guide and configure the individual components.

```bash
composer show filament/infolists

```

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

### Register configurations on a panel with make()

Source: https://filamentphp.com/docs/5.x/plugins/configurable-resources-and-pages

Register one or more configurations on a panel using the make() method. Each configuration needs a unique key, and each registration gets its own routes and navigation items.

```php
use App\Filament\Resources\OrderResource;

public function panel(Panel $panel): Panel
{
    return $panel
        ->resources([
            // "Active orders" configuration
            OrderResource::make('active')
                ->navigationLabel('Active Orders')
                ->navigationGroup('Orders'),
            // "Archived orders" configuration
            OrderResource::make('archived')
                ->navigationLabel('Archived Orders')
                ->navigationGroup('Orders')
                ->archived(),
        ]);
}

```

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

### Check filament/tables installation with composer show

Source: https://filamentphp.com/docs/5.x/components/table

Check whether the filament/tables package is installed in your project. If it is not installed, consult the installation guide and configure the individual components according to the instructions.

```bash
composer show filament/tables

```

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

### Check filament/schemas installation with composer show

Source: https://filamentphp.com/docs/5.x/components/schema

Check whether the filament/schemas package is installed in your project. If it is not installed, consult the installation guide and configure the individual components according to the instructions.

```bash
composer show filament/schemas

```

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

### Verify filament/widgets installation with composer show

Source: https://filamentphp.com/docs/5.x/components/widget

Check whether the filament/widgets package is installed in your project before proceeding. If it is not installed, consult the installation guide and configure the individual components according to the instructions.

```bash
composer show filament/widgets
```

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

### TextEntry::alignStart()

Source: https://filamentphp.com/docs/5.x/infolists/overview

Documentation for the alignStart() method on TextEntry.

```APIDOC
## TextEntry::alignStart()

### Description
Aligns the entry content to the start (left in LTR, right in RTL). This is the default alignment.

### Method
N/A (PHP method)

### Endpoint
N/A

### Parameters
None

### Request Example
```php
use Filament\Infolists\Components\TextEntry;

TextEntry::make('title')
    ->alignStart();
```

### Response
N/A
```

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

### Using a wizard with steps()

Source: https://filamentphp.com/docs/5.x/actions/create

Transforms the creation process into a multistep wizard by defining a steps() array with Step objects. Each step can have its own schema, description, and column layout.

```php
use Filament\Actions\CreateAction;
use Filament\Forms\Components\MarkdownEditor;
use Filament\Forms\Components\TextInput;
use Filament\Forms\Components\Toggle;
use Filament\Schemas\Components\Wizard\Step;

CreateAction::make()
    ->steps([
        Step::make('Name')
            ->description('Give the category a unique name')
            ->schema([
                TextInput::make('name')
                    ->required()
                    ->live()
                    ->afterStateUpdated(fn ($state, callable $set) => $set('slug', Str::slug($state))),
                TextInput::make('slug')
                    ->disabled()
                    ->required()
                    ->unique(Category::class, 'slug'),
            ])
            ->columns(2),
        Step::make('Description')
            ->description('Add some extra details')
            ->schema([
                MarkdownEditor::make('description'),
            ]),
        Step::make('Visibility')
            ->description('Control who can view it')
            ->schema([
                Toggle::make('is_visible')
                    ->label('Visible to customers.')
                    ->default(true),
            ]),
    ])
```

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

### Adding operator to start with unshiftOperators()

Source: https://filamentphp.com/docs/5.x/tables/filters/query-builder

Add an operator to the start of the default operator list using `unshiftOperators()`. The example passes the class name, not an instance.

```php
use Filament\QueryBuilder\Constraints\Operators\IsFilledOperator;
use Filament\QueryBuilder\Constraints\TextConstraint;

TextConstraint::make('author.name')
    ->unshiftOperators([
        IsFilledOperator::class,
    ])
```

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

### Get enabled options with getEnabledOptions()

Source: https://filamentphp.com/docs/5.x/forms/toggle-buttons

Use getEnabledOptions() to retrieve the options that have not been disabled, for example for validation. This example combines disableOptionWhen() with the in() validation rule to ensure the submitted value is one of the enabled options.

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

ToggleButtons::make('status')
    ->options([
        'draft' => 'Draft',
        'scheduled' => 'Scheduled',
        'published' => 'Published',
    ])
    ->disableOptionWhen(fn (string $value): bool => $value === 'published')
    ->in(fn (ToggleButtons $component): array => array_keys($component->getEnabledOptions()))

```

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

### Opt-in to tenancy with Resource::scopeToTenant(false)

Source: https://filamentphp.com/docs/5.x/users/tenancy

Call this in a service provider's boot() method or a middleware to opt-in to tenancy for each resource instead of opting out.

```php
use Filament\Resources\Resource;

Resource::scopeToTenant(false);

```

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

### Manipulate repeater state

Source: https://filamentphp.com/docs/5.x/forms/repeater

Example of getting and setting the raw state of a repeater component to add, remove, or modify items.

```APIDOC
## [POST] /repeater/state-manipulation

### Description
Demonstrates how to get and set the raw state of a repeater component for programmatic manipulation.

### Method
POST

### Endpoint
/repeater/state-manipulation

### Parameters
#### Request Body
- **component** (Repeater) - Required - The repeater component instance.

### Request Example
```
use Illuminate\Support\Str;

// Get the raw data for the entire repeater
$state = $component->getState();

// Add an item, with a random UUID as the key
$state[Str::uuid()] = [
    'email' => auth()->user()->email,
];

// Set the new data for the repeater
$component->state($state);
```

### Response
#### Success Response (200)
- **status** (string) - Success message.

#### Response Example
```
{
  "status": "State updated successfully"
}
```
```

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

### Repeater data structure for $get() scoping

Source: https://filamentphp.com/docs/5.x/forms/repeater

Example data structure showing a repeater item with a client_id field outside the repeater. Used to illustrate how $get() and $set() are scoped to the current repeater item and how ../ syntax navigates to parent levels.

```php
[
    'client_id' => 1,

    'repeater' => [
        'item1' => [
            'service_id' => 2,
        ],
    ],
]

```

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

### ImportPolicy view() method

Source: https://filamentphp.com/docs/5.x/actions/import

Example view() method for an ImportPolicy that restores the default behavior of allowing only the user who started the import to access the failure CSV file.

```php
use App\Models\User;
use Filament\Actions\Imports\Models\Import;

public function view(User $user, Import $import): bool
{
    return $import->user()->is($user);
}

```

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

### ExportPolicy view() method

Source: https://filamentphp.com/docs/5.x/actions/export

Implement the view() method in your ExportPolicy to authorize download access. This example restores the default behavior of allowing only the user who started the export.

```php
use App\Models\User;
use Filament\Actions\Exports\Models\Export;

public function view(User $user, Export $export): bool
{
    return $export->user()->is($user);
}

```

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

### Create a Filament User with Artisan

Source: https://filamentphp.com/docs/5.x/introduction/installation

Creates a new user account for the Filament panel. Run this after installation to be able to sign in.

```bash
php artisan make:filament-user

```

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

### Data structure for builder item scoping

Source: https://filamentphp.com/docs/5.x/forms/builder

Example data structure showing a builder item nested inside a form. This illustrates how $get() is scoped to the current builder item, so to access client_id from inside the builder item you must use $get('../client_id') to go up a level.

```php
[
    'client_id' => 1,

    'builder' => [
        'item1' => [
            'service_id' => 2,
        ],
    ],
]

```

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

### Group navigation items with $navigationGroup

Source: https://filamentphp.com/docs/5.x/navigation

Set the protected static property $navigationGroup to group navigation items under a label. The example groups items under 'Settings'. Ungrouped items appear at the start.

```php
use UnitEnum;

protected static string | UnitEnum | null $navigationGroup = 'Settings';

```

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

### Generate model, migration, and factory at the same time

Source: https://filamentphp.com/docs/5.x/resources/overview

Use the `--model`, `--migration`, and `--factory` flags in any combination to generate the model, migration, and factory for the new resource at the same time.

```bash
php artisan make:filament-resource Customer --model --migration --factory
```

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

### Inject utilities into a closure rule

Source: https://filamentphp.com/docs/5.x/forms/validation

Wrap the closure rule in another function to inject utilities like $get. This example references another field value to conditionally fail validation.

```php
use Filament\Schemas\Components\Utilities\Get;

TextInput::make('slug')->rules([
    fn (Get $get): Closure => function (string $attribute, $value, Closure $fail) use ($get) {
        if ($get('other_field') === 'foo' && $value !== 'bar') {
            $fail("The {$attribute} is invalid.");
        }
    },
])
```

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

### Implement custom filters with HasFiltersSchema trait

Source: https://filamentphp.com/docs/5.x/widgets/charts

Use the HasFiltersSchema trait and implement filtersSchema() to build custom filters with schema components. The example shows DatePicker components for start and end dates.

```php
use Filament\Forms\Components\DatePicker;
use Filament\Schemas\Schema;
use Filament\Widgets\ChartWidget\Concerns\HasFiltersSchema;

class BlogPostsChart extends ChartWidget
{
    use HasFiltersSchema;
    
    // ...
    
    public function filtersSchema(Schema $schema): Schema
    {
        return $schema->components([
            DatePicker::make('startDate')
                ->default(now()->subDays(30)),
            DatePicker::make('endDate')
                ->default(now()),
        ]);
    }
}

```

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

### Blueprint plan example for Filament v5

Source: https://filamentphp.com/docs/5.x/introduction/ai

Example prompt used with GPT-6 Astra and Amp agents to produce a Filament v5 implementation plan. Lists required capabilities and plan structure; used to compare plans written with and without the planning-filament skill.

```text
Produce an implementation plan for a Filament v5 application. The application is
a SaaS invoicing system with the following capabilities:

- Manage customers
- Manage products
- Create and edit invoices
- Add line items to invoices
- Send invoices to customers
- Record and track payments
  
The plan should:
- Describe the primary user flows end to end (for example: creating an invoice,
  sending it, recording a payment).
- Map each domain concept and flow to concrete Filament primitives (Resources,
  Relation Managers, Pages, Actions).
- Identify state transitions (such as draft → sent → paid) and the Actions that
  trigger them.

```

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

### Set current panel for testing multiple panels

Source: https://filamentphp.com/docs/5.x/testing/testing-resources

Set the current panel manually when testing a non-default panel without making a request, such as in a Livewire component test. Place this in the setUp() method or at the start of a test.

```php
use Filament\Facades\Filament;

Filament::setCurrentPanel('app'); // Where `app` is the ID of the panel you want to test.
```

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

### goToWizardStep() and assertWizardCurrentStep()

Source: https://filamentphp.com/docs/5.x/testing/testing-schemas

Use goToWizardStep(2) to jump directly to a specific step and assertWizardCurrentStep(2) to verify you are on that step without validation errors from the previous step.

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

it('moves to the wizards second step', function () {
    livewire(CreatePost::class)
        ->goToWizardStep(2)
        ->assertWizardCurrentStep(2);
});

```

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

### Create custom avatar provider for boringavatars.com

Source: https://filamentphp.com/docs/5.x/users/overview

Create a custom avatar provider class that implements the AvatarProvider contract. The get() method accepts a user model instance and returns an avatar URL. This example uses boringavatars.com.

```php
<?php

namespace App\Filament\AvatarProviders;

use Filament\AvatarProviders\Contracts;
use Filament\Facades\Filament;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Database\Eloquent\Model;

class BoringAvatarsProvider implements Contracts\AvatarProvider
{
    public function get(Model | Authenticatable $record): string
    {
        $name = str(Filament::getNameForDefaultAvatar($record))
            ->trim()
            ->explode(' ')
            ->map(fn (string $segment): string => filled($segment) ? mb_substr($segment, 0, 1) : '')
            ->join(' ');

        return 'https://source.boringavatars.com/beam/120/' . urlencode($name);
    }
}

```

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

### Customize profile link with userMenuItems 'profile' key

Source: https://filamentphp.com/docs/5.x/navigation/user-menu

Customizes the profile link at the start of the user menu by registering an item with the 'profile' array key and passing a function that modifies the action object. The example changes the label to 'Edit profile'.

```php
use Filament\Actions\Action;
use Filament\Panel;

public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->userMenuItems([
            'profile' => fn (Action $action) => $action->label('Edit profile'),
            // ...
        ]);
}
```

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

### Generate a View page for a resource

Source: https://filamentphp.com/docs/5.x/resources/overview

Use the `--view` flag to also generate a View page in addition to the default List, Create, and Edit pages.

```bash
php artisan make:filament-resource Customer --view
```

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

### Entry configuration with injected utilities

Source: https://filamentphp.com/docs/5.x/infolists

Shows how to use label, state, and hidden methods with closures that inject utilities like $state, $record, and auth() user.

```php
use App\Models\User;
use Filament\Infolists\Components\TextEntry;

TextEntry::make('name')
    ->label(fn (string $state): string => str_contains($state, ' ') ? 'Full name' : 'Name')

TextEntry::make('currentUserEmail')
    ->state(fn (): string => auth()->user()->email)

TextEntry::make('role')
    ->hidden(fn (User $record): bool => $record->role === 'admin')

```

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

### DatePicker::defaultFocusedDate() - Set default calendar date

Source: https://filamentphp.com/docs/5.x/forms/date-time-picker

Sets the default focused date on the calendar panel when the field has no state. The example uses a non-native picker and sets the placeholder to the start of the month. The method also accepts a function for dynamic calculation.

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

DatePicker::make('custom_starts_at')
    ->native(false)
    ->placeholder(now()->startOfMonth())
    ->defaultFocusedDate(now()->startOfMonth())

```

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

### Manipulate builder state with getState() and state()

Source: https://filamentphp.com/docs/5.x/forms/builder

Manipulate the raw builder state by getting it with `getState()`, adding a new item with a UUID key, and setting it back with `state()`. This is useful for adding, removing, or modifying items programmatically. The example is from the 'Adding extra item actions' section.

```php
use Illuminate\Support\Str;

// Get the raw data for the entire builder
$state = $component->getState();

// Add an item, with a random UUID as the key
$state[Str::uuid()] = [
    'type' => 'contactDetails',
    'data' => [
        'email' => auth()->user()->email,
    ],
];

// Set the new data for the builder
$component->state($state);

```

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

### Create a resource with a View page using --view flag

Source: https://filamentphp.com/docs/5.x/resources/viewing-records

Creates a new Filament resource with a View page. Use the --view flag when generating the resource to include the View page.

```bash
php artisan make:filament-resource User --view

```

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

### Hide an entry using JavaScript with hiddenJs()

Source: https://filamentphp.com/docs/5.x/infolists/overview

Use hiddenJs() to hide an entry based on a JavaScript expression. The $get() utility is available in JavaScript and behaves similarly to its PHP equivalent, but without requiring the depended-on entry to be live(). The example shows hiding an icon entry when the role is not 'staff'.

```php
use Filament\Forms\Components\Select;
use Filament\Infolists\Components\IconEntry;

Select::make('role')
    ->options([
        'user' => 'User',
        'staff' => 'Staff',
    ])

IconEntry::make('is_admin')
    ->boolean()
    ->hiddenJs(<<<'JS'
        $get('role') !== 'staff'
        JS)

```

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

### Create a new Filament panel with make:filament-panel

Source: https://filamentphp.com/docs/5.x/panel-configuration

Creates a new Filament panel named 'app'. The command generates a configuration file at app/Providers/Filament/AppPanelProvider.php and registers the panel at /app. Filament attempts to register the service provider automatically, but if the panel is not accessible, manual registration in bootstrap/providers.php or config/app.php may be required.

```bash
php artisan make:filament-panel app
```

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

### Create a basic wizard with steps

Source: https://filamentphp.com/docs/5.x/schemas/wizards

Creates a multistep wizard with three steps: Order, Delivery, and Billing. Each step uses the schema() method to define its fields. This is the basic structure for a wizard in Filament forms.

```php
use Filament\Schemas\Components\Wizard;
use Filament\Schemas\Components\Wizard\Step;

Wizard::make([
    Step::make('Order')
        ->schema([
            // ...
        ]),
    Step::make('Delivery')
        ->schema([
            // ...
        ]),
    Step::make('Billing')
        ->schema([
            // ...
        ]),
])
```

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

### Add custom icon to callout using icon() method

Source: https://filamentphp.com/docs/5.x/schemas/callouts

Use the icon() method to set a custom icon for a callout. The example uses Heroicon::OutlinedLightBulb. The method also accepts a function for dynamic calculation, with utilities like $component, $get, $livewire, $model, $operation, and $record injectable.

```php
use Filament\Schemas\Components\Callout;
use Filament\Support\Icons\Heroicon;

Callout::make('Pro tip')
    ->description('You can use keyboard shortcuts to navigate faster. Press ? to see all available shortcuts.')
    ->icon(Heroicon::OutlinedLightBulb)

```

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

### Test create page loads with assertOk

Source: https://filamentphp.com/docs/5.x/testing/testing-resources

Use this test to verify the create page loads successfully. It uses the Livewire component for the create page and calls assertOk() to ensure the HTTP response is 200 OK.

```php
use App\Filament\Resources\Users\Pages\CreateUser;
use App\Models\User;

it('can load the page', function () {
    livewire(CreateUser::class)
        ->assertOk();
});
```

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

### Create a custom infolist entry with artisan

Source: https://filamentphp.com/docs/5.x/infolists/custom-entries

Generates a custom Filament infolist entry class and Blade view. Run this command to create the AudioPlayerEntry component.

```bash
php artisan make:filament-infolist-entry AudioPlayerEntry
```

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

### Disable specific option with disableOptionWhen()

Source: https://filamentphp.com/docs/5.x/forms/toggle-buttons

Use disableOptionWhen() to disable an option based on its value. The closure receives the option value and can return true to disable it. In this example, the 'published' option is disabled. Utility injection parameters such as $component, $get, $label, $livewire, $model, $operation, $rawState, $record, $state, and $value are available.

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

ToggleButtons::make('status')
    ->options([
        'draft' => 'Draft',
        'scheduled' => 'Scheduled',
        'published' => 'Published',
    ])
    ->disableOptionWhen(fn (string $value): bool => $value === 'published')

```
Tokens:
Raw