Download the PHP package a909m/filament-statefusion without Composer

Filament-StateFusion

Brings the full power of Spatie Laravel Model States to Filament with zero complexity and beautiful visual workflows.

Filament StateFusion is a powerful FilamentPHP plugin that seamlessly integrates Spatie Laravel Model States into the Filament admin panel. Effortlessly manage model states, transitions, and filtering within Filament, enhancing both user experience and developer productivity.

Perfect for order processing, publishing workflows, approval systems, and any application requiring well-defined state management.

Features

✨ Rich State Management

• Display model states in tables with colors, icons, and descriptions
• Filter and group records by state
• Transition between states using intuitive UI components
• Bulk state transitions with validation

🛠 Developer Experience

• Out-of-the-box support for Spatie Laravel Model States
• Custom transition forms for collecting additional data
• Automatic state validation and transition rules
• Compatible with Filament v4 dark mode

🎨 Customizable Interface

• Custom labels, colors, icons, and descriptions for states
• Custom transition forms and validation
• Flexible attribute mapping for complex models

🎬 Preview

📸 Screenshots and demo GIFs will be added soon

Requirements

This plugin is designed to work with the following dependencies:

• PHP: ^8.1
• Laravel: ^10.0|^11.0|^12.0
• Filament: ^3.0|^4.0|^5.0
• Spatie Laravel Model States: ^2.0

Installation

Install the package via Composer:

Upgrading to Filament v4

• composer require a909m/filament-statefusion:2.0
• The Action classes were simplified into a single StateFusionBulkAction and StateFusionAction for pages and tables

Then, implement the HasFilamentStateFusion interface and use the StateFusionInfo trait on your abstract state class.

Finally, you can start using the components and actions provided by this plugin in your Filament resources.

Understanding State Management

This plugin builds on Spatie Laravel Model States, which provides:

• State Classes: Each state is a separate class with its own behavior and logic
• State Transitions: Define which state changes are allowed (e.g., Pending → Processing)
• Transition Classes: Optional classes for complex transitions that need additional data or logic
• Type Safety: Your IDE knows which states and methods are available

Example: An order can be Pending, Processing, Shipped, or Cancelled. You define:

• Which transitions are valid (Pending can become Processing, but Shipped cannot become Pending)
• What happens during each transition (send emails, update timestamps, etc.)

StateFusion makes these states visual and interactive in Filament with dropdowns, badges, filters, and action buttons.

Getting Started

1. Prepare Your State Classes

First, ensure you have Spatie Laravel Model States configured. Then implement the HasFilamentStateFusion interface and use the StateFusionInfo trait on your abstract state class:

New to Spatie Laravel Model States? Read their introduction first to understand states, transitions, and the state pattern.

2. Configure Your Model

Add the state to your Eloquent model:

3. Use in Filament Resources

Now you can use StateFusion components in your Filament resources:

Usage

Form Components

You can use the following state-aware components in your forms:

• StateFusionSelect
• StateFusionRadio
• StateFusionToggleButtons

Table Columns

StateFusionSelectColumn

Display state information in your Filament tables and allow for quick state transitions.

TextColumn

You can also use the standard TextColumn to display the state as a badge. When your state classes implement HasLabel, HasColor, and HasIcon interfaces, the badge will automatically display the appropriate label, color, and icon without any additional configuration.

Table Filter

Filter records by state:

Table Actions

StateFusionTableAction

Add state transition actions to your table rows.

StateFusionBulkAction

Transition multiple records at once.

Infolist Entries

TextEntry

Similar to the table column, you can use the standard TextEntry in your infolists to display the model state as a badge. When your state classes implement HasLabel, HasColor, and HasIcon interfaces, the badge will automatically display the appropriate label, color, and icon without any additional configuration.

Page Actions

StateFusionAction

Create actions to transition between states from a page.

Customization

Custom Attributes

By default, the state components use the first attribute defined in your model's getDefaultStates() as the state attribute. If your model uses a different attribute name or you want to specify which attribute to use, you can set it using the attribute() method.

This is useful when your model has multiple state attributes or you want to reuse the component for different attributes.

Customizing States

To customize how states appear in the UI, implement the HasLabel, HasDescription, HasColor, or HasIcon interfaces on your concrete state classes:

Customizing Transitions

Similarly, transitions can be customized by implementing the same interfaces:

Custom Transitions with Forms

Sometimes you need to collect additional information when transitioning between states. StateFusion makes this easy by letting you add a form() method to your custom transition classes.

Example: Cancelling an order with a reason

The form data is automatically passed to your transition's $data parameter, which you can then use in the handle() method to update your model.

Learn more: Custom Transition Classes in the Spatie documentation.

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details on how to contribute to this project.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• A909M
• All Contributors

License

The MIT License (MIT). Please see License File for more information.