README.md

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:"^2.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 1.x

Follow the steps in the Upgrade Guide.

Compatibility

Peek	Status	Filament	PHP
1.x	Bugfixes only	^2.0	^8.0
2.x	Current version	^3.0	^8.1

Please feel free to report any issues you encounter with Peek in this repository. I'll work with you to determine where the issue is coming from.

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.
filament-peek-demo-with-astro	Content previews on a more complex project with Filament as "headless CMS", and Astro on the front-end. (Work in progress)
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:

• Configuration
  • Publishing the Config File
  • Available Options
  • Integrating With a Custom Theme
• Page Previews
  • Overview
  • Using the Preview Modal on Edit pages
  • Using the Preview Modal on List pages
  • Detecting the Preview Modal
  • Using a Preview URL
  • Embedding a Preview Action into the Form
  • Preview Pointer Events
  • Adding Extra Data to Previews
  • Alternate Templating Engines
• Builder Previews
  • Overview
  • Using Builder Previews on Edit pages
  • Using Multiple Builder Fields
  • Using Custom Fields
  • Customizing the Preview Action
  • Automatically Updating the Builder Preview
  • Adding Extra Data to the Builder Editor State
  • Adding Extra Data to the Builder Preview
  • Alternate Templating Engines
• JavaScript Hooks
• Upgrading from v1.x

FAQ and Known Issues

I've started compiling some notes and solutions to common issues in Discussions. Feel free to contribute your own tips and tricks.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Patrick Boivin
• All Contributors

Acknowledgements

The initial idea is heavily inspired by module previews in Twill CMS.

License

The MIT License (MIT). Please see License File for more information.