Filament

https://filamentphp.com/docs/4.x
Admin
Filament is a full-stack framework and panel builder designed for rapidly creating administrative...
Tokens:1,046,154
Snippets:7,474
Trust Score:9.6
Update:1 week ago
Show doc for...
Tokens:
Raw
### Run the Laravel Boost interactive installer

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

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

```bash
php artisan boost:install

```

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

### Provide multiple example rows with examples()

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

Use the `examples()` method to add multiple example rows to the CSV. Pass an array of values for the column.

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

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

```

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

### Check filament/actions installation

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

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

```bash
composer show filament/actions

```

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

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

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

Use the `example()` method on an `ImportColumn` to add a single example row to the downloadable CSV. The example value is placed in the corresponding column.

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

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

```

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

### Install @tiptap/extension-highlight

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

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

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

```

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

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

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

Shows the form data structure used to illustrate how $get() is scoped to the current builder item and how ../ syntax accesses parent fields.

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

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

```

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

### Install npm dependencies

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

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

```bash
npm install
```

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

### Override setUp() for default configuration

Source: https://filamentphp.com/docs/4.x/upgrade-guide

If you override make() to pass default configuration, use setUp() instead. It is called immediately after the object is instantiated.

```php
protected function setUp(): void
{
    parent::setUp();

    $this->label('Default label');
}
```

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

### Install Filament frontend assets (existing Laravel project)

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

Run this command to install Filament frontend assets in an existing Laravel project. This is the manual installation method to preserve existing functionality.

```bash
php artisan filament:install

```

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

### Install Filament frontend assets (new Laravel project)

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

Run these commands to install Livewire, Alpine.js, and Tailwind CSS and scaffold Filament. This will overwrite existing files, so only run in a new Laravel project.

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

npm install

npm run dev

```

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

### Install Blueprint via Composer

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

Configures the Filament Composer repository with your license credentials and installs the filament/blueprint package as a dev dependency. Replace YOUR_EMAIL_ADDRESS and YOUR_LICENSE_KEY with your actual purchase details.

```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 InterNACHI/Modular

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

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

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

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

### Example usage of Heading component in README

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

Shows how to use the Heading component in a Filament project. This example is intended to be included in the plugin's README.md to demonstrate usage to users.

```php
use Awcodes\Headings\Heading;

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

```

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

### Install Tailwind CSS and Vite plugin

Source: https://filamentphp.com/docs/4.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

```

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

### Install phiki/phiki package

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

Installs the phiki/phiki package, which is required for the code entry component. Filament does not include it by default.

```bash
composer require phiki/phiki

```

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

### Install Filament Panel Builder

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

Run these commands in your Laravel project directory to install the Filament Panel Builder. This creates and registers the AdminPanelProvider service provider.

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

php artisan filament:install --panels

```

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

### Get enabled options with getEnabledOptions()

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

Retrieves the options that are not disabled, for validation purposes. Uses getEnabledOptions() to get the enabled option keys and passes them to the in() validation rule. This example builds on the previous disableOptionWhen() setup.

```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()))

```

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

### Check filament/tables installation

Source: https://filamentphp.com/docs/4.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

```

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

### Using a wizard with steps()

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

Transform the creation process into a multistep wizard by defining a steps() array with Step objects. Each step can have its own schema and description. The example shows steps for Name, Description, and Visibility.

```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),
            ]),
    ])
```

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

### Check filament/schemas installation

Source: https://filamentphp.com/docs/4.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

```

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

### Check if filament/notifications is installed

Source: https://filamentphp.com/docs/4.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/widgets is installed

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

Run this command to verify that the filament/widgets 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/widgets

```

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

### actionJs() example with $get and $set

Source: https://filamentphp.com/docs/4.x/actions/overview

Use actionJs() to run JavaScript directly in the browser when the action is clicked. The example shows a TextInput with an afterContent action that generates a slug from the title field using $get() and $set(). This action cannot open a modal or perform server-side processing.

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

TextInput::make('title')
    ->live(onBlur: true)
    ->afterContent(
        Action::make('generateSlug')
            ->actionJs(<<<'JS'
                $set('slug', $get('title').toLowerCase().replaceAll(' ', '-'))
                JS)
    )

TextInput::make('slug')

```

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

### Define wizard steps with Step::make

Source: https://filamentphp.com/docs/4.x/resources/creating-records

Return an array of Step instances from getSteps(). Each step has a name, optional description, and a schema with form fields. This example shows steps for Name, Description, and Visibility.

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

protected function getSteps(): array
{
    return [
        Step::make('Name')
            ->description('Give the category a clear and 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', fn ($record) => $record),
            ]),
        Step::make('Description')
            ->description('Add some extra details')
            ->schema([
                MarkdownEditor::make('description')
                    ->columnSpan('full'),
            ]),
        Step::make('Visibility')
            ->description('Control who can view it')
            ->schema([
                Toggle::make('is_visible')
                    ->label('Visible to customers.')
                    ->default(true),
            ]),
    ];
}

```

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

### Run configure.php to set up the plugin skeleton

Source: https://filamentphp.com/docs/4.x/plugins/getting-started

Run this command from the root of the cloned Filament Plugin Skeleton repository. It will ask a series of questions to configure the plugin and then stub out a new plugin.

```bash
php ./configure.php

```

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

### Using prime components to display instructions, QR code, and recovery codes

Source: https://filamentphp.com/docs/4.x/schemas/primes

This example demonstrates how to use Text, Image, Section, and UnorderedList components within a schema. It shows setting colors, image height, alignment, and styling options like font weight, size, and copyable text. The code uses a closure to generate a list of recovery codes.

```php
use Filament\Actions\Action;
use Filament\Schemas\Components\Image;
use Filament\Schemas\Components\Section;
use Filament\Schemas\Components\Text;
use Filament\Schemas\Components\UnorderedList;
use Filament\Support\Enums\FontWeight;
use Filament\Support\Enums\TextSize;

$schema
    ->components([
        Text::make('Scan this QR code with your authenticator app:')
            ->color('neutral'),
        Image::make(
            url: asset('images/qr.jpg'),
            alt: 'QR code to scan with an authenticator app',
        )
            ->imageHeight('12rem')
            ->alignCenter(),
        Section::make()
            ->schema([
                Text::make('Please save the following recovery codes in a safe place. They will only be shown once, but you\'ll need them if you lose access to your authenticator app:')
                    ->weight(FontWeight::Bold)
                    ->color('neutral'),
                UnorderedList::make(fn (): array => array_map(
                    fn (string $recoveryCode): Text => Text::make($recoveryCode)
                        ->copyable()
                        ->fontFamily(FontFamily::Mono)
                        ->size(TextSize::ExtraSmall)
                        ->color('neutral'),
                    ['tYRnCqNLUx-3QOLNKyDiV', 'cKok2eImKc-oWHHH4VhNe', 'C0ZstEcSSB-nrbyk2pv8z', '49EXLRQ8MI-FpWywpSDHE', 'TXjHnvkUrr-KuiVJENPmJ', 'BB574ookll-uI20yxP6oa', 'BbgScF2egu-VOfHrMtsCl', 'cO0dJYqmee-S9ubJHpRFR'],
                ))
                    ->size(TextSize::ExtraSmall),
            ])
            ->compact()
            ->secondary(),
    ])
```

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

### Example data structure for repeater field access

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

Shows the data structure used to illustrate how $get() resolves paths relative to the current repeater item. The example includes a client_id field outside the repeater and a service_id inside the repeater item.

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

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

```

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

### Manipulate builder raw state

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

Get and set the raw data for the entire builder using `getState()` and `state()`. This example adds a new item with a random UUID key. Use `getRawItemState()` to get raw data for a specific item without validation.

```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);

```

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

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

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

Register one or more configurations using the make() method, each with a unique key. Each configured registration gets its own routes and navigation items. The configuration key is used internally to identify each registration.

```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(),
        ]);
}

```

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

### ExportPolicy view() method

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

Example view() method for an ExportPolicy that restricts download access to the user who started the export. This logic must be added manually if a policy is defined, as the default check is removed.

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

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

```

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

### Set default sub-navigation position with subNavigationPosition()

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

Use the subNavigationPosition() method to set the default position of sub-navigation for the entire panel. The value can be Start, End, or Top (to render as tabs). This example sets it to End.

```php
use Filament\Pages\Enums\SubNavigationPosition;
use Filament\Panel;

public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->subNavigationPosition(SubNavigationPosition::End);
}
```

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

### Blueprint plan example prompt

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

A Filament v5 prompt used with GPT-6 Astra and Amp agent in independent threads, with and without the planning-filament skill. It asks for an implementation plan for a SaaS invoicing system, describing user flows, mapping to Filament primitives, and identifying state transitions.

```markdown
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.

```

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

### Create custom avatar provider for boringavatars.com

Source: https://filamentphp.com/docs/4.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);
    }
}

```

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

### Access total table records count with $tableRecordsCount

Source: https://filamentphp.com/docs/4.x/resources/widgets

Use the `$tableRecordsCount` property to get the total count of all records for the table query without executing an additional count query. This example creates a Stat widget for 'Total Products'.

```php
use Filament\Widgets\StatsOverviewWidget\Stat;

Stat::make('Total Products', $this->tableRecordsCount),

```

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

### Create an empty state with EmptyState::make

Source: https://filamentphp.com/docs/4.x/schemas/empty-states

Use EmptyState::make() to display a heading, optional description, icon, and footer actions. The make() and description() methods also accept functions for dynamic values, with utility injection available.

```php
use Filament\Actions\Action;
use Filament\Schemas\Components\EmptyState;
use Filament\Support\Icons\Heroicon;

EmptyState::make('No users yet')
    ->description('Get started by creating a new user.')
    ->icon(Heroicon::OutlinedUser)
    ->footer([
        Action::make('createUser')
            ->icon(Heroicon::Plus),
    ])
```

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

### Opt-in to tenancy for all resources using Resource::scopeToTenant(false)

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

Call `Resource::scopeToTenant(false)` inside 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);

```

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

### Set current panel for testing non-default panel

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

Use this code to set the current panel when testing a non-default panel without making a request. Place it in the setUp() method or at the start of a test. Replace 'app' with the panel ID.

```php
use Filament\Facades\Filament;

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

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

### Passing arguments to table configuration with tableArguments()

Source: https://filamentphp.com/docs/4.x/forms/select

Use tableArguments() to pass form field values to the table configuration class. The closure can inject utilities like Get to retrieve form data. This example passes category_id and budget_limit from the form.

```php
use Filament\Actions\Action;
use Filament\Forms\Components\ModalTableSelect;
use Filament\Schemas\Components\Utilities\Get;

ModalTableSelect::make('products')
    ->relationship('products', 'name')
    ->multiple()
    ->tableConfiguration(ProductsTable::class)
    ->tableArguments(function (Get $get): array {
        return [
            'category_id' => $get('category_id'),
            'budget_limit' => $get('budget'),
        ];
    })
```

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

### Creating actions with make(), url(), and action()

Source: https://filamentphp.com/docs/4.x/tables/actions

Create actions using the static make() method, with url() for links and action() for tasks. The $record parameter is available in callbacks.

```php
use App\Models\Post;
use Filament\Actions\Action;

Action::make('edit')
    ->url(fn (Post $record): string => route('posts.edit', $record))
    ->openUrlInNewTab()

Action::make('delete')
    ->requiresConfirmation()
    ->action(fn (Post $record) => $record->delete())
```

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

### Dependent select options using Eloquent queries

Source: https://filamentphp.com/docs/4.x/forms/overview

Adapts the previous example to load options from Eloquent models. The category select uses `pluck('name', 'id')` and the sub_category select filters by the selected category using `$get('category')`.

```php
use Filament\Schemas\Components\Utilities\Get;
use Filament\Forms\Components\Select;
use Illuminate\Support\Collection;

Select::make('category')
    ->options(Category::query()->pluck('name', 'id'))
    ->live()
    
Select::make('sub_category')
    ->options(fn (Get $get): Collection => SubCategory::query()
        ->where('category', $get('category'))
        ->pluck('name', 'id'))
```

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

### ComponentColorMap: Build a custom slot map with slot() and get()

Source: https://filamentphp.com/docs/4.x/styling/colors

Use this snippet to create a custom color map for components that pick one shade per slot, such as badges, links, or text columns. It shows how to chain slot() calls with parameters like surface, minRatio, maxShade, shouldStartFromDarkest, and fallback, then call get() to return the mapping. The example uses the gray palette and enforces WCAG AA text contrast with a fallback shade of 900 for light mode.

```php
use Filament\Support\Colors\Color;
use Filament\Support\Facades\FilamentColor;
use Filament\Support\View\Components\ColorMaps\ComponentColorMap;

$gray = FilamentColor::getColor('gray');

ComponentColorMap::make($color)
    ->slot('text', surface: $gray[50], minRatio: Color::WCAG_AA_TEXT, fallback: 900)
    ->slot('dark:text', surface: $gray[700], maxShade: 500, shouldStartFromDarkest: true, fallback: 200)
    ->get();
```

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

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

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

Run this artisan command to generate a new Filament resource with a View page. The --view flag adds the ViewRecord page to the resource.

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

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

### Example state for KeyValueEntry

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

Shows the expected PHP array structure for the entry's state.

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

```

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

### ImportPolicy view() method to restrict access to import owner

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

Define the view() method in your ImportPolicy to authorize access to the failure CSV file. This example replicates the default behavior of allowing only the user who started the import. Note that defining a policy removes the built-in logic, so you must add it yourself if needed.

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

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

```

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

### Entry utility injection examples

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

Shows how to use function parameters in TextEntry configuration methods to inject utilities like state, record, and hidden logic.

```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')

```

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

### Implement a blueprint

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

After reading the saved plan and resolving outstanding business choices, switch out of planning mode and give the implementing agent the saved blueprint and access to the application checkout. The prompt instructs to follow the plan, run relevant tests, and report what was implemented and any checks that could not be completed.

```markdown
Implement blueprints/invoicing.md in this application checkout. Follow the plan
and run the relevant tests. Report what was implemented and any checks that
could not be completed.

```

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

### Add Filament asset paths to .gitignore

Source: https://filamentphp.com/docs/4.x/advanced/assets

Rules added by `php artisan filament:install` to the app's `.gitignore` file, if not already present. The paths use the customized `assets_path` from `config/filament.php` when set, for example `/public/filament/css/filament`. The `/public/css/filament` rule also ignores custom themes compiled directly into that directory instead of through Vite.

```gitignore
/public/css/filament
/public/fonts/filament
/public/js/filament

```

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

### Write a blueprint with planning-filament skill

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

Enable planning mode and ask the AI agent to use the planning-filament skill, specifying a Markdown file for the plan. The prompt should describe the system and include managing customers, products, invoices, line items, sending invoices, and tracking payments.

```markdown
Using the planning-filament skill, create a Filament Blueprint for a SaaS invoicing
system using this application's Filament version. Write the plan as Markdown to
blueprints/invoicing.md.

Include managing customers and products, creating and editing invoices with line
items, sending invoices, and recording and tracking payments. Describe the user
flows, Filament components, and state transitions. Flag unresolved business choices.

```

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

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

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

Use the --model, --migration, and --factory flags in any combination to also generate the model, migration, and factory for the new resource.

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

```

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

### Starts With validation rule

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

Starts With validation rule: the field must start with one of the given values.

```php
Field::make('name')->startsWith(['a'])
```

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

### Use make() method to add plugin to panel

Source: https://filamentphp.com/docs/4.x/plugins/panel-plugins

Shows users using the fluent make() method to add the plugin to a panel.

```php
use DanHarrin\FilamentBlog\BlogPlugin;
use Filament\Panel;

public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->plugin(BlogPlugin::make());
}
```

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

### Test view page loads with assertOk and assertSchemaStateSet

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

Use this to verify the view page loads successfully (HTTP 200) and that the infolist entries are set to the correct values. Requires a user factory and the ViewUser page class.

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

it('can load the page', function () {
    $user = User::factory()->create();

    livewire(ViewUser::class, [
        'record' => $user->id,
    ])
        ->assertOk()
        ->assertSchemaStateSet([
            'name' => $user->name,
            'email' => $user->email,
        ]);
});
```

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

### Install Laravel Boost as a development dependency

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

Run this Composer command to install Laravel Boost as a development dependency. This is the first step before running the interactive installer.

```bash
composer require laravel/boost --dev

```

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

### Check Filament Forms installation

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

Verify that the filament/forms package is installed in your project.

```bash
composer show filament/forms
```

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

### Create a custom widget with make:filament-widget

Source: https://filamentphp.com/docs/4.x/widgets/overview

Run this artisan command to generate a BlogPostsOverview widget. It creates a widget class in the /Widgets directory and a view in the /widgets directory. The class is a Livewire component, so any Livewire features are available; the view can contain any HTML and access public Livewire properties and $this.

```bash
php artisan make:filament-widget BlogPostsOverview
```

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

### Review implementation against blueprint

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

Use Blueprint's reviewing-filament-plans skill with the same saved blueprint and application checkout to check whether the implementation satisfies the plan. The prompt requests requirement traceability, confirmed deviations, and anything blocked or not verified, and instructs not to change application code.

```markdown
Using the reviewing-filament-plans skill, review the implementation in
this checkout against blueprints/invoicing.md, including the current uncommitted
changes.
Report requirement traceability, confirmed deviations, and anything blocked
or not verified. Do not change application code.

```

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

### Install Spark Billing Provider via Composer

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

Run this Composer command to install the Filament billing provider for Laravel Spark. Requires Spark to be installed and configured for the tenant model first.

```bash
composer require filament/spark-billing-provider

```
Tokens:
Raw