mansoor / filament-versionable
Effortlessly manage revisions of your Eloquent models in Filament.
Fund package maintenance!
mansoor
Installs: 30 686
Dependents: 6
Suggesters: 0
Security: 0
Stars: 90
Watchers: 2
Forks: 23
Open Issues: 3
Requires
- php: ^8.2
- filament/filament: ^4.0
- illuminate/contracts: ^10.0|^11.0|^12.0
- overtrue/laravel-versionable: ^5.5.0
- spatie/laravel-package-tools: ^1.15.0
Requires (Dev)
- larastan/larastan: 3.0
- laravel/pint: ^1.0
- nunomaduro/collision: ^7.9|^8.8.0
- orchestra/testbench: ^9.0|^10.0
- pestphp/pest: ^3.7
- pestphp/pest-plugin-arch: ^3.0
- pestphp/pest-plugin-laravel: ^3.0
README

Filament Versionable
Efforlessly manage your Eloquent model revisions in Filament. It includes:
- A Filament page to show the Diff of what has changed and who changed it
- A list of Revisions by different users
- A Restore action to restore the model to any state
Installation
You can install the package via composer:
composer require mansoor/filament-versionable
Then, publish the config file and migrations:
php artisan vendor:publish --provider="Overtrue\LaravelVersionable\ServiceProvider"
Run the migration command:
php artisan migrate
Important
If you have not set up a custom theme and are using Filament Panels follow the instructions in the Filament Docs first.
After setting up a custom theme add the plugin's views and css to your theme css file.
@import '../../../../vendor/mansoor/filament-versionable/resources/css/plugin.css'; @source '../../../../vendor/mansoor/filament-versionable/resources/**/*.blade.php';
Usage
Add Overtrue\LaravelVersionable\Versionable
trait to your model and set $versionable
attributes.
NOTE: Make sure to add protected $versionStrategy = VersionStrategy::SNAPSHOT;
This would save all the $versionable attributes when any of them changed. There are different bug reports on using VersionStrategy::DIFF
use Overtrue\LaravelVersionable\VersionStrategy; class Post extends Model { use Overtrue\LaravelVersionable\Versionable; protected $versionable = ['title', 'content']; protected $versionStrategy = VersionStrategy::SNAPSHOT; }
Create a Revisons Resource page to show Revisions, it should extend the Mansoor\FilamentVersionable\RevisionsPage
. If you were to create a Revisions page for ArticleResource
, it would look like:
namespace App\Filament\Resources\ArticleResource\Pages; use App\Filament\Resources\ArticleResource; use Mansoor\FilamentVersionable\RevisionsPage; class ArticleRevisions extends RevisionsPage { protected static string $resource = ArticleResource::class; }
Next, Add the ArticleRevisions page (that you just created) to your Resource
use App\Filament\Resources\ArticleResource\Pages; public static function getPages(): array { return [ ... 'revisions' => Pages\ArticleRevisions::route('/{record}/revisions'), ]; }
Add RevisionsAction
to your edit/view pages, this action would only appear when there are any versions for the model you are viewing/editing.
use Mansoor\FilamentVersionable\Page\RevisionsAction; protected function getHeaderActions(): array { return [ RevisionsAction::make(), ]; }
You can also add the RevisionsAction
to your table.
use Mansoor\FilamentVersionable\Table\RevisionsAction; $table->actions([ RevisionsAction::make(), ]);
You are all set! Your app should store the model states and you can manage them in Filament.
Customisation
If you want to change the UI for Revisions page, you may publish the publish the views to do so.
php artisan vendor:publish --tag="filament-versionable-views"
If you want more control over how the versions are stored, you may read the Laravel Versionable Docs.
Strip Tags from Diff
You can easily remove/strip HTML tags from the diff by just overriding shouldStripTags
method inside your revisions page.
class ArticleRevisions extends RevisionsPage { protected static string $resource = ArticleResource::class; public function shouldStripTags(): bool { return true; } }
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.