Easily track and access recently viewed records in your filament panels.
| Package Version | Filament Version |
|---|---|
| 1.x | 3.x |
| 2.x | 5.x |
| 3.x | 4.x & 5.x |
You can install the package via composer then run the installation command and follow the prompts:
composer require awcodes/recentlyphp artisan recently:installImportant
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 to your theme css file or your app's css file if using the standalone packages.
@source '../../../../vendor/awcodes/recently/resources/**/*.blade.php';The plugin adds a “Recently Viewed” functionality in your filament panel(s), letting users quickly access resources they’ve recently interacted with. It tracks views/visits to EditRecord and ViewRecord pages of resources where it’s enabled.
use Awcodes\Recently\RecentlyPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
RecentlyPlugin::make(),
])
}If you are using QuickCreatePlugin or OverlookPlugin you will need to exclude the RecentEntryResource from them.
OverlookPlugin::make()
->excludes([
RecentEntryResource::class,
]),
QuickCreatePlugin::make()
->excludes([
RecentEntryResource::class,
]),To record recent edits/views, include the trait on EditRecord or ViewRecord pages of the resources you want to monitor:
Recent Edits:
use Awcodes\Recently\Concerns\HasRecentHistoryRecorder;
class EditUser extends EditRecord
{
use HasRecentHistoryRecorder;
protected static string $resource = UserResource::class;
}Recent Views:
class ViewUser extends ViewRecord
{
use HasRecentHistoryRecorder;
protected static string $resource = UserResource::class;
}You can enable/disable or customize the plugin's features either globally through the config file or per panel.
// config/recently.php
return [
'user_model' => App\Models\User::class,
'max_items' => 20,
'width' => 'xs',
'global_search' => true,
'menu' => true,
'icon' => 'heroicon-o-arrow-uturn-left',
];By default, the plugin will list the recent visits/views as part of the global search results. To disable this feature, set the global_search option to false from the config or by passing false to the globalSearch() method per panel.
use Awcodes\Recently\RecentlyPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
RecentlyPlugin::make()
->globalSearch(condition: false),
])
}By default, the plugin will list the recent visits/views as a dropdown menu in the topbar using the PanelsRenderHook::USER_MENU_BEFORE render hook. To disable this feature, set the menu option to false in the config or by passing false to the menu() method per panel.
use Awcodes\Recently\RecentlyPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
RecentlyPlugin::make()
->menu(condition: false),
])
}Set a custom icon for the menu.
use Awcodes\Recently\RecentlyPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
RecentlyPlugin::make()
->icon('heroicon-o-clock'),
]);
}The menu icon is round you can opt out of this by passing false to the rounded() method.
use Awcodes\Recently\RecentlyPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
RecentlyPlugin::make()
->rounded(condition: false),
]);
}The menu has no label, but you can set a custom label by passing a string to the label() method.
use Awcodes\Recently\RecentlyPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
RecentlyPlugin::make()
->label('Recently Viewed Records'),
]);
}The dropdown menu uses the filament dropdown blade component, so you can use any of the options available, the default is xs.
use Awcodes\Recently\RecentlyPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
RecentlyPlugin::make()
->width('sm'),
]);
}Specify the maximum number of recently viewed items to display in the menu.
use Awcodes\Recently\RecentlyPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
RecentlyPlugin::make()
->maxItems(10),
]);
}The plugin will render the menu using the PanelsRenderHook::USER_MENU_BEFORE hook. However, you can change this using the renderUsingHook() method by providing one of the other available filament Render Hooks.
use Awcodes\Recently\RecentlyPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
RecentlyPlugin::make()
->renderUsingHook('PanelsRenderHook::USER_MENU_AFTER'),
]);
}composer testIf you want to contribute to this plugin, you may want to test it in a real Filament project:
- Fork this repository to your GitHub account.
- Create a Filament app locally.
- Clone your fork in your Filament app's root directory.
- In the
/recentlydirectory, create a branch for your fix, e.g.fix/error-message.
Install the plugin in your app's composer.json:
"require": {
"awcodes/recently": "dev-fix/error-message as main-dev",
},
"repositories": [
{
"type": "path",
"url": "recently"
}
]Now, run composer update.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.
