README

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

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:

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
  • Using a Preview URL
  • Embedding a Preview Action into the Form
  • Preview Pointer Events
  • Adding Extra Data to Previews
  • Alternate Templating Engines
  • Opening the Preview in a New Tab
• Builder Previews (deprecated)
• JavaScript Hooks
• Upgrading from Peek 2.x

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

• Patrick Boivin
• All Contributors

Acknowledgements

The initial idea was inspired by module previews in Twill.

License

The MIT License (MIT). See LICENSE.md for more information.