pboivin / filament-peek by pboivin

Full-screen page preview modal for Filament
252,454
236
4
Package Data
Maintainer Username: pboivin
Maintainer Contact: pboivin@gmail.com (Patrick Boivin)
Package Create Date: 2023-05-20
Package Last Update: 2025-10-14
Home Page:
Language: PHP
License: MIT
Last Refreshed: 2025-11-18 15:00:03
Package Statistics
Total Downloads: 252,454
Monthly Downloads: 13,969
Daily Downloads: 520
Total Stars: 236
Total Watchers: 4
Total Forks: 17
Total Open Issues: 1

Peek

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:"^3.0"

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 2.x

Follow the steps in the Upgrade Guide.

Compatibility

| Peek | Status | Filament | PHP | |------|----------|-----|--------| | 3.x | Current version | ^4.0 | ^8.2 | | 2.x | Bugfixes only | ^3.0 | ^8.1 | | 1.x | Bugfixes only | ^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.