Peek
Add a full-screen preview modal to your Panel pages.
Author:
Patrick Boivin
Documentation
- Installation
- Compatibility
- Demo Projects
- Documentation
- FAQ and Known Issues
- Changelog
- Contributing
- Security Vulnerabilities
- Credits
- Acknowledgements
- License
A Filament plugin to add a full-screen preview modal to your Panel pages. The modal can be used before saving to preview a modified record.
#Installation
You can install the package via composer:
composer require pboivin/filament-peek:"^4.1"
Register a FilamentPeekPlugin instance in your Panel provider:
use Pboivin\FilamentPeek\FilamentPeekPlugin;
public function panel(Panel $panel): Panel
{
return $panel
// ...
->plugins([
FilamentPeekPlugin::make(),
]);
}
Then, publish the assets:
php artisan filament:assets
#Upgrading from 3.x
Follow the steps in the Upgrade Guide.
#Compatibility
| Peek | Status | Filament | PHP |
|---|---|---|---|
| 4.x | Supported | ^5.0 | ^8.2 |
| 3.x | Supported | ^4.0 | ^8.2 |
| 2.x | Bugfixes only | ^3.0 | ^8.1 |
| 1.x | Unsupported | ^2.0 | ^8.0 |
Please feel free to report any issues you encounter with Peek in GitHub Issues.
#Demo Projects
Here are a few example projects available to give this plugin a try:
| Repository | Description |
|---|---|
| filament-peek-demo | Content previews on a simple Filament project with Laravel Blade views. |
| Log1x/filament-starter | A great starting point for TALL stack projects using Filament. Implements content previews using full-page Livewire components. |
#Documentation
The documentation is available in the 'docs' directory on GitHub:
#FAQ and Known Issues
You'll find some notes and solutions to common issues in GitHub Discussions. Feel free to contribute your own tips and tricks.
#Changelog
See CHANGELOG.md for more information on what has changed recently.
#Contributing
See CONTRIBUTING.md for details.
#Security Vulnerabilities
Review the security policy on how to report security vulnerabilities.
#Credits
#Acknowledgements
The initial idea was inspired by module previews in Twill.
#License
The MIT License (MIT). See LICENSE.md for more information.
Featured Plugins
A selection of plugins curated by the Filament team
Custom Dashboards
Let your users build and share their own dashboards with a drag-and-drop interface. Define your data sources in PHP and let them do the rest.
Filament
Data Lens
Advanced Data Visualization for Laravel Filament - a premium reporting solution enabling custom column creation, sophisticated filtering, and enterprise-grade data insights within admin panels.
Padmission
Advanced Tables (formerly Filter Sets)
Supercharge your tables with powerful features like user-customizable views, quick filters, multi-column sorting, advanced table searching, convenient view management, and more. Compatible with Resource Panel Tables, Relation Managers, Table Widgets, and Table Builder!
Kenneth Sese
