PHPackages                             pboivin/filament-peek - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. pboivin/filament-peek

ActiveLibrary[Utility &amp; Helpers](/categories/utility)

pboivin/filament-peek
=====================

Full-screen page preview modal for Filament

v4.1.2(1mo ago)253319.6k—4.5%209MITPHPPHP ^8.2CI passing

Since May 22Pushed 3mo ago4 watchersCompare

[ Source](https://github.com/pboivin/filament-peek)[ Packagist](https://packagist.org/packages/pboivin/filament-peek)[ Docs](https://github.com/pboivin/filament-peek)[ RSS](/packages/pboivin-filament-peek/feed)WikiDiscussions 4.x Synced 1mo ago

READMEChangelog (10)Dependencies (30)Versions (66)Used By (9)

Peek
====

[](#peek)

[![Build Status](https://github.com/pboivin/filament-peek/workflows/run-tests/badge.svg)](https://github.com/pboivin/filament-peek/actions)[![Latest Stable Version](https://camo.githubusercontent.com/244cb473d40ba95f166ff4ea13a773735de84c801f72b7306678baf96535f971/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f70626f6976696e2f66696c616d656e742d7065656b)](https://packagist.org/packages/pboivin/filament-peek)[![Total Downloads](https://camo.githubusercontent.com/de6945915a02cd4d641a1896b9e9f46ed447240c0b64c464cc2a6ec8fb185b4a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f70626f6976696e2f66696c616d656e742d7065656b)](https://packagist.org/packages/pboivin/filament-peek)[![License](https://camo.githubusercontent.com/e2fdf19772b58b11e8b6a62efffec25def8b0d5182a82ad411d5cb3b68c1f9d1/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f70626f6976696e2f66696c616d656e742d7065656b)](https://packagist.org/packages/pboivin/filament-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.

[![Screenshots of the edit page and preview modal](https://raw.githubusercontent.com/pboivin/filament-peek/4.x/art/01-page-preview.jpg)](https://raw.githubusercontent.com/pboivin/filament-peek/4.x/art/01-page-preview.jpg)

Installation
------------

[](#installation)

You can install the package via composer:

```
composer require pboivin/filament-peek:"^4.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 `3.x`

[](#upgrading-from-3x)

Follow the steps in the [Upgrade Guide](https://github.com/pboivin/filament-peek/tree/4.x/docs/upgrade-guide.md).

Compatibility
-------------

[](#compatibility)

PeekStatusFilamentPHP[4.x](https://github.com/pboivin/filament-peek/tree/4.x)Supported^5.0^8.2[3.x](https://github.com/pboivin/filament-peek/tree/3.x)Supported^4.0^8.2[2.x](https://github.com/pboivin/filament-peek/tree/2.x)Bugfixes only^3.0^8.1[1.x](https://github.com/pboivin/filament-peek/tree/1.x)Unsupported^2.0^8.0Please feel free to report any issues you encounter with Peek in [GitHub Issues](https://github.com/pboivin/filament-peek/issues).

Demo Projects
-------------

[](#demo-projects)

Here are a few example projects available to give this plugin a try:

RepositoryDescription[filament-peek-demo](https://github.com/pboivin/filament-peek-demo)Content previews on a simple Filament project with Laravel Blade views.[Log1x/filament-starter](https://github.com/Log1x/filament-starter)A great starting point for TALL stack projects using Filament. Implements content previews using full-page Livewire components.Documentation
-------------

[](#documentation)

The documentation is available in the ['docs' directory](https://github.com/pboivin/filament-peek/tree/3.x/docs) on GitHub:

- [Configuration](https://github.com/pboivin/filament-peek/blob/4.x/docs/configuration.md)
    - [Publishing the Config File](https://github.com/pboivin/filament-peek/blob/4.x/docs/configuration.md#publishing-the-config-file)
    - [Available Options](https://github.com/pboivin/filament-peek/blob/4.x/docs/configuration.md#available-options)
    - [Integrating With a Custom Theme](https://github.com/pboivin/filament-peek/blob/4.x/docs/configuration.md#integrating-with-a-custom-theme)
- [Page Previews](https://github.com/pboivin/filament-peek/blob/4.x/docs/page-previews.md)
    - [Overview](https://github.com/pboivin/filament-peek/blob/4.x/docs/page-previews.md#overview)
    - [Using the Preview Modal on Edit pages](https://github.com/pboivin/filament-peek/blob/4.x/docs/page-previews.md#using-the-preview-modal-on-edit-pages)
    - [Using the Preview Modal on List pages](https://github.com/pboivin/filament-peek/blob/4.x/docs/page-previews.md#using-the-preview-modal-on-list-pages)
    - [Using a Preview URL](https://github.com/pboivin/filament-peek/blob/4.x/docs/page-previews.md#using-a-preview-url)
    - [Embedding a Preview Action into the Form](https://github.com/pboivin/filament-peek/blob/4.x/docs/page-previews.md#embedding-a-preview-action-into-the-form)
    - [Preview Pointer Events](https://github.com/pboivin/filament-peek/blob/4.x/docs/page-previews.md#preview-pointer-events)
    - [Adding Extra Data to Previews](https://github.com/pboivin/filament-peek/blob/4.x/docs/page-previews.md#adding-extra-data-to-previews)
    - [Alternate Templating Engines](https://github.com/pboivin/filament-peek/blob/4.x/docs/page-previews.md#alternate-templating-engines)
    - [Opening the Preview in a New Tab](https://github.com/pboivin/filament-peek/blob/4.x/docs/page-previews.md#opening-the-preview-in-a-new-tab)
- [JavaScript Hooks](https://github.com/pboivin/filament-peek/blob/4.x/docs/javascript-hooks.md)
- [Upgrading from Peek 3.x](https://github.com/pboivin/filament-peek/blob/4.x/docs/upgrade-guide.md)

FAQ and Known Issues
--------------------

[](#faq-and-known-issues)

You'll find some notes and solutions to common issues in [GitHub Discussions](https://github.com/pboivin/filament-peek/discussions/categories/general). Feel free to contribute your own tips and tricks.

Changelog
---------

[](#changelog)

See [CHANGELOG.md](https://github.com/pboivin/filament-peek/blob/4.x/CHANGELOG.md) for more information on what has changed recently.

Contributing
------------

[](#contributing)

See [CONTRIBUTING.md](https://github.com/pboivin/filament-peek/blob/4.x/.github/CONTRIBUTING.md) for details.

Security Vulnerabilities
------------------------

[](#security-vulnerabilities)

Review [the security policy](https://github.com/pboivin/filament-peek/security/policy) on how to report security vulnerabilities.

Credits
-------

[](#credits)

- [Patrick Boivin](https://github.com/pboivin)
- [All Contributors](https://github.com/pboivin/filament-peek/contributors)

Acknowledgements
----------------

[](#acknowledgements)

The initial idea was inspired by module previews in [Twill](https://twillcms.com/).

License
-------

[](#license)

The MIT License (MIT). See [LICENSE.md](https://github.com/pboivin/filament-peek/blob/4.x/LICENSE.md) for more information.

###  Health Score

63

—

FairBetter than 99% of packages

Maintenance85

Actively maintained with recent releases

Popularity54

Moderate usage in the ecosystem

Community31

Small or concentrated contributor base

Maturity71

Established project with proven stability

 Bus Factor1

Top contributor holds 94.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~16 days

Recently: every ~1 days

Total

64

Last Release

53d ago

Major Versions

v2.4.0 → v3.0.0-alpha12025-07-08

2.x-dev → v4.0.0-alpha12026-01-26

v3.1.0 → v4.1.02026-03-17

v3.1.1 → v4.1.12026-03-24

3.x-dev → v4.1.22026-03-26

PHP version history (3 changes)v0.1PHP ^8.0

v2.0.0-alpha1PHP ^8.1

v3.0.0-alpha1PHP ^8.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/c628fdf7c95af7c4f84ec8867232fdb75a92dca434c327616abc45071b190dfc?d=identicon)[pboivin](/maintainers/pboivin)

---

Top Contributors

[![pboivin](https://avatars.githubusercontent.com/u/7805679?v=4)](https://github.com/pboivin "pboivin (761 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (21 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (12 commits)")[![laravel-shift](https://avatars.githubusercontent.com/u/15991828?v=4)](https://github.com/laravel-shift "laravel-shift (2 commits)")[![FDT2k](https://avatars.githubusercontent.com/u/5261645?v=4)](https://github.com/FDT2k "FDT2k (2 commits)")[![bambamboole](https://avatars.githubusercontent.com/u/8823695?v=4)](https://github.com/bambamboole "bambamboole (1 commits)")[![kennyhorna](https://avatars.githubusercontent.com/u/16125117?v=4)](https://github.com/kennyhorna "kennyhorna (1 commits)")[![AzizEmir](https://avatars.githubusercontent.com/u/101357256?v=4)](https://github.com/AzizEmir "AzizEmir (1 commits)")[![JarkaP](https://avatars.githubusercontent.com/u/3973865?v=4)](https://github.com/JarkaP "JarkaP (1 commits)")[![atmonshi](https://avatars.githubusercontent.com/u/1952412?v=4)](https://github.com/atmonshi "atmonshi (1 commits)")

---

Tags

filamentphplaravellivewirepluginpreviewpluginlaravelpreviewmodalfilamentpreviewer

###  Code Quality

TestsPest

Static AnalysisPHPStan

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/pboivin-filament-peek/health.svg)

```
[![Health](https://phpackages.com/badges/pboivin-filament-peek/health.svg)](https://phpackages.com/packages/pboivin-filament-peek)
```

###  Alternatives

[dotswan/filament-map-picker

Easily pick and retrieve geo-coordinates using a map-based interface in your Filament applications.

124139.3k2](/packages/dotswan-filament-map-picker)[creagia/filament-code-field

A Filamentphp input field to edit or view code data.

58289.3k3](/packages/creagia-filament-code-field)[swisnl/filament-backgrounds

Beautiful backgrounds for Filament auth pages

54149.2k6](/packages/swisnl-filament-backgrounds)[tapp/filament-google-autocomplete-field

Filament plugin that provides a Google Autocomplete field

3098.1k](/packages/tapp-filament-google-autocomplete-field)[jibaymcs/filament-tour

Bring the power of DriverJs to your Filament panels and start a tour !

12247.8k](/packages/jibaymcs-filament-tour)[hydrat/filament-table-layout-toggle

Filament plugin adding a toggle button to tables, allowing user to switch between Grid and Table layouts.

6292.3k1](/packages/hydrat-filament-table-layout-toggle)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
