Peek
CommunityAdd a full-screen preview modal to your Panel pages.
Author:
Patrick Boivin
Package health
BetaAutomated checks of this plugin's Composer package
13 checks
-
Passed:
Current Laravel version supported
—
Package dependencies resolve together with current Laravel
13.0. -
Passed:
Current PHP version supported
—
Constraint
^8.2supports current PHP8.5. - Skipped: Current Symfony version supported
- Passed: Abandoned or archived — No consulted source marks the package abandoned (packagist, github).
- Passed: Commit and release recency — Active: last commit 21 days ago; last release 109 days ago.
-
Passed:
composer.lock not committed by library
—
composer.lockis absent from the released dist archive. - Passed: Dist archive is lean
- Failed: GitHub Actions pinned to SHA — View details on Plumb
- Passed: Open security advisories
- Passed: Dependabot PR responsiveness — No open Dependabot PRs.
- Warning: Dependabot or Renovate configured — Updater does not cover the JavaScript ecosystem, which has a committed lockfile.
-
Failed:
Dependency update cooldown configured
—
No cooldown configured in
.github/dependabot.yml. View details on Plumb - Passed: Provides a security policy
filament/
namespace. Review the source and install at your own risk. Found
malware or an unresolved security issue the author won't
address?
Report it
.
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
Blueprint
Filament Blueprint is a premium Laravel Boost extension that helps AI agents produce accurate, detailed implementation plans and security reports for Filament apps.
Filament
Spotlight Pro
Browse your Filament Panel with ease. Filament Spotlight Pro adds a Spotlight/Raycast like Command Palette to your Filament Panel.
Dennis Koch
Custom Fields
Eliminate custom field migrations forever. Let your users create and manage form fields directly in Filament admin panels with 20+ built-in field types, validation, and zero database changes.
Relaticle