habibtalib/filament-flowstone
Filament Flowstone
A Filament plugin for Flowstone - Laravel Workflow Engine with Symfony Workflow Integration.
Installation
Install the package via Composer:
composer require habibtalib/filament-flowstone
Usage
Register the plugin in your Filament Panel Provider:
use CleaniqueCoders\FilamentFlowstone\FilamentFlowstonePlugin;
public function panel(Panel $panel): Panel
{
return $panel
// ...
->plugins([
FilamentFlowstonePlugin::make(),
]);
}
Configuration
You can customize the plugin behavior:
FilamentFlowstonePlugin::make()
->navigationGroup('System')
->navigationIcon('heroicon-o-cog')
->navigationSort(100)
->workflowResource(true)
->workflowDesignerPage(true)
->widgets(true)
Available Options
| Method | Description | Default |
|---|---|---|
navigationGroup(?string $group) |
Set the navigation group | null |
navigationIcon(?string $icon) |
Set the navigation icon | heroicon-o-arrow-path |
navigationSort(?int $sort) |
Set the navigation sort order | null |
workflowResource(bool $condition) |
Enable/disable the Workflow resource | true |
workflowDesignerPage(bool $condition) |
Enable/disable the Workflow Designer page | true |
widgets(bool $condition) |
Enable/disable the dashboard widgets | true |
Features
Workflow Resource
Full CRUD management for workflows including:
- Create, edit, and delete workflows
- Configure workflow type (state machine or workflow)
- Set initial marking and marking store configuration
- Toggle event dispatch settings
- Enable/disable audit trails
Relation Managers
- Places - Manage workflow places/states with drag-and-drop reordering
- Transitions - Define transitions between places with guard configuration
- Audit Logs - View the audit trail for workflow transitions (read-only)
Workflow Designer Page
Visual designer for viewing and managing workflows:
- View workflow structure and configuration
- Quick access to places and transitions
- Rebuild workflow configuration
Dashboard Widgets
- Workflow Stats Widget - Overview statistics (total workflows, places, transitions, audit logs)
- Workflow Overview Widget - Table of recent workflows with quick actions
Publishing Assets
Publish the configuration file:
php artisan vendor:publish --tag="filament-flowstone-config"
Publish views (optional, for customization):
php artisan vendor:publish --tag="filament-flowstone-views"
Publish translations (optional):
php artisan vendor:publish --tag="filament-flowstone-translations"
Note: This plugin uses tables from the main cleaniquecoders/flowstone package. Make sure to run the Flowstone migrations first:
php artisan vendor:publish --tag="flowstone-migrations"
php artisan migrate
Requirements
- PHP 8.2+
- Laravel 10.x, 11.x, or 12.x
- Filament 3.x
- Flowstone 1.x
License
The MIT License (MIT). Please see License File for more information.