Spatie Laravel activity logs inside of Filament.
This package provides a Filament resource that shows you all of the activity logs and detailed view of each log created using the spatie/laravel-activitylog package. It also provides a relationship manager for related models.
| Branch | Filament |
|---|---|
1.x |
v3 |
2.x |
v4 |
3.x (this branch) |
v5 |
ActivityLog Plugin is translated for :
You can install the package via composer:
composer require rmsramos/activitylogAfter that run the install command:
php artisan activitylog:installThis will publish the config & migrations from spatie/laravel-activitylog
And run migrates
php artisan migrateYou can manually publish the configuration file with:
php artisan vendor:publish --tag="activitylog-config"This is the contents of the published config file:
…Optionally, you can publish the views using
php artisan vendor:publish --tag="activitylog-views"Tailwind v4 only generates CSS for classes it can find by scanning your own project files. Since this package's Blade views live in vendor/, your panel's Tailwind build won't see them unless you tell it to. Without this step, the Timeline Action modal will render without its icon badges, timeline line, and spacing.
Add this @source directive to your panel's theme.css (e.g. resources/css/filament/admin/theme.css), alongside any other vendor package sources:
@source '../../../../vendor/rmsramos/activitylog/resources/**/*';Then rebuild your assets:
npm run buildIn you Model add Spatie\Activitylog\Traits\LogsActivity trait, and configure getActivitylogOption function
For more configuration, Please review Spatie Docs
use Illuminate\Database\Eloquent\Model;
use Spatie\Activitylog\Traits\LogsActivity;
use Spatie\Activitylog\LogOptions;
class NewsItem extends Model
{
use LogsActivity;
protected $fillable = ['name', 'text'];
public function getActivitylogOptions(): LogOptions
{
return LogOptions::defaults()
->logOnly(['name', 'text']);
}
}In your Panel ServiceProvider (App\Providers\Filament) active the plugin
Add the Rmsramos\Activitylog\ActivitylogPlugin to your panel config
use Rmsramos\Activitylog\ActivitylogPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
ActivitylogPlugin::make(),
]);
}You can swap out the ActivitylogResource used by updating the ->resource() value. Use this to create your own CustomResource class and extend the original at \Rmsramos\Activitylog\Resources\Activitylog\ActivitylogResource::class. This will allow you to customise everything such as the views, table, form and permissions.
[!NOTE] If you wish to change the resource on List and View page be sure to replace the
getPagesmethod on the new resource and create your own version of theListPageandViewPageclasses to reference the customCustomResource.
use Rmsramos\Activitylog\ActivitylogPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
ActivitylogPlugin::make()
->resource(\Path\For\Your\CustomResource::class),
]);
}You can swap out the Resource label used by updating the ->label() and ->pluralLabel() value.
use Rmsramos\Activitylog\ActivitylogPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
ActivitylogPlugin::make()
->label('Log')
->pluralLabel('Logs'),
]);
}You can enable or disable the Resource navigation item by updating the ->navigationItem() value.
use Rmsramos\Activitylog\ActivitylogPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
ActivitylogPlugin::make()
->navigationItem(false), // by default is true
]);
}You can add a Resource navigation group updating the ->navigationGroup() value.
use Rmsramos\Activitylog\ActivitylogPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
ActivitylogPlugin::make()
->navigationGroup('Activity Log'),
]);
}You can swap out the Resource navigation icon used by updating the ->navigationIcon() value.
use Rmsramos\Activitylog\ActivitylogPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
ActivitylogPlugin::make()
->navigationIcon('heroicon-o-shield-check'),
]);
}You can active Count Badge updating the ->navigationCountBadge() value.
use Rmsramos\Activitylog\ActivitylogPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
ActivitylogPlugin::make()
->navigationCountBadge(true),
]);
}You can set the Resource navigation sort used by updating the ->navigationSort() value.
use Rmsramos\Activitylog\ActivitylogPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
ActivitylogPlugin::make()
->navigationSort(3),
]);
}If you would like to prevent certain users from accessing the logs resource, you should add a authorize callback in the ActivitylogPlugin chain.
use Rmsramos\Activitylog\ActivitylogPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
ActivitylogPlugin::make()
->authorize(
fn () => auth()->user()->id === 1
),
]);
}To translate resource names in the activity log, add a translateSubject callback within the ActivitylogPlugin chain
use Rmsramos\Activitylog\ActivitylogPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
ActivitylogPlugin::make()
->translateSubject(fn($label) => __("yourCustomLangFile.".$label)),
]);
}To translate the names of the keys in the activity log, add a translateLogKey callback within the ActivitylogPlugin chain
use Rmsramos\Activitylog\ActivitylogPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
ActivitylogPlugin::make()
->translateLogKey(fn($label) => __("yourCustomLangFile.".$label)),
]);
}To customize how dates are parsed, depending on user preferences or settings:
use Rmsramos\Activitylog\ActivitylogPlugin;
use Morilog\Jalali\Jalalian;
use Carbon\Carbon;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
ActivitylogPlugin::make()
->dateParser(
fn($date) => auth()->user()->isJalaliCalendar() ?
Jalalian::fromDateTime($date) :
Carbon::parse($date)
)
]);
}To customize the format of dates and datetime columns based on user settings:
use Rmsramos\Activitylog\ActivitylogPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
ActivitylogPlugin::make()
->dateFormat('Y-m-d')
->datetimeFormat(fn() => auth()->user()->getFilamentDateTimeFormat())
]);
}
To conditionally customize datetime columns in the UI, depending on the user's calendar preference:
use Rmsramos\Activitylog\ActivitylogPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
ActivitylogPlugin::make()
->customizeDatetimeColumn(function ($column) {
return $column->when(
auth()->user()->isJalaliCalendar(),
function ($column) {
return $column->jalaliDateTime();
}
);
})
]);
}To customize date picker fields in forms, depending on user preferences:
use Rmsramos\Activitylog\ActivitylogPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
ActivitylogPlugin::make()
->customizeDatePicker(function ($field) {
return $field->when(
auth()->user()->isJalaliCalendar(),
function ($field) {
return $field->jalali();
}
);
})
]);
}Implement getFilamentActualResourceModel in the trait HasCustomActivityResource to determine the actual model related to the activity record for generating valid URLs.
…To hide the restore / view action globally for a resource within the ActivitylogPlugin, you can use the isRestoreActionHidden and isResourceActionHidden method. these are particularly useful in scenarios where you do not want users to have the ability to restore or view entries from the activity log. you can also customize the label of view action:
use Rmsramos\Activitylog\ActivitylogPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
ActivitylogPlugin::make()
->isRestoreActionHidden(true)
->isResourceActionHidden(true)
->resourceActionLabel("Sample Label")
]);
}In the laravel-activitylog configuration file config/activitylog.php:
return [
'subject_returns_soft_deleted_models' => true,
]To globally display the restore (soft delete) action of a resource within the ActivitylogPlugin, you can use the isRestoreModelActionHidden method. This is particularly useful in scenarios where you do not want users to have the ability to restore activity log entries:
use Rmsramos\Activitylog\ActivitylogPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
ActivitylogPlugin::make()
->isRestoreModelActionHidden(false)
]);
}To ensure ActivitylogResource access via RolePolicy you would need to add the following to your AppServiceProvider:
use App\Policies\ActivityPolicy;
use Illuminate\Support\Facades\Gate;
use Spatie\Activitylog\Models\Activity;
class AppServiceProvider extends ServiceProvider
{
public function boot(): void
{
Gate::policy(Activity::class, ActivityPolicy::class);
}
}…If you
No open issues yet, or sync has not completed.