{"id":15105721,"url":"https://github.com/benjpaddock/filament-peek","last_synced_at":"2025-10-23T01:30:43.241Z","repository":{"id":254312805,"uuid":"846149162","full_name":"benjpaddock/filament-peek","owner":"benjpaddock","description":"Full-screen page preview modal for Filament","archived":false,"fork":false,"pushed_at":"2025-01-27T16:45:38.000Z","size":3023,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"2.x","last_synced_at":"2025-01-27T17:39:15.182Z","etag":null,"topics":["filamentphp","laravel","livewire","plugin","preview"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/benjpaddock.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-22T16:16:06.000Z","updated_at":"2025-01-27T16:45:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"321c74b8-81bc-41d1-b97e-334c894b4cd5","html_url":"https://github.com/benjpaddock/filament-peek","commit_stats":null,"previous_names":["benjpaddock/filament-peek"],"tags_count":40,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benjpaddock%2Ffilament-peek","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benjpaddock%2Ffilament-peek/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benjpaddock%2Ffilament-peek/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benjpaddock%2Ffilament-peek/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/benjpaddock","download_url":"https://codeload.github.com/benjpaddock/filament-peek/tar.gz/refs/heads/2.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237759101,"owners_count":19361458,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["filamentphp","laravel","livewire","plugin","preview"],"created_at":"2024-09-25T20:42:24.264Z","updated_at":"2025-10-23T01:30:37.933Z","avatar_url":"https://github.com/benjpaddock.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Peek\n\n\u003cp\u003e\n\u003ca href=\"https://github.com/pboivin/filament-peek/actions\"\u003e\u003cimg src=\"https://github.com/pboivin/filament-peek/workflows/run-tests/badge.svg\" alt=\"Build Status\"\u003e\u003c/a\u003e\n\u003ca href=\"https://packagist.org/packages/pboivin/filament-peek\"\u003e\u003cimg src=\"https://img.shields.io/packagist/v/pboivin/filament-peek\" alt=\"Latest Stable Version\"\u003e\u003c/a\u003e\n\u003ca href=\"https://packagist.org/packages/pboivin/filament-peek\"\u003e\u003cimg src=\"https://img.shields.io/packagist/dt/pboivin/filament-peek\" alt=\"Total Downloads\"\u003e\u003c/a\u003e\n\u003ca href=\"https://packagist.org/packages/pboivin/filament-peek\"\u003e\u003cimg src=\"https://img.shields.io/packagist/l/pboivin/filament-peek\" alt=\"License\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nA 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.\n\n\u003cp class=\"filament-hidden\"\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/pboivin/filament-peek/2.x/art/01-page-preview.jpg\" alt=\"Screenshots of the edit page and preview modal\"\u003e\n\u003c/p\u003e\n\n## Installation\n\nYou can install the package via composer:\n\n```bash\ncomposer require pboivin/filament-peek:\"^2.0\"\n```\n\nRegister a `FilamentPeekPlugin` instance in your Panel provider:\n\n```php\nuse Pboivin\\FilamentPeek\\FilamentPeekPlugin;\n\npublic function panel(Panel $panel): Panel\n{\n    return $panel\n        // ...\n        -\u003eplugins([\n            FilamentPeekPlugin::make(),\n        ]);\n}\n```\n\nThen, publish the assets:\n\n```bash\nphp artisan filament:assets\n```\n\n#### Upgrading from `1.x`\n\nFollow the steps in the [Upgrade Guide](https://github.com/pboivin/filament-peek/tree/2.x/docs/upgrade-guide.md).\n\n## Compatibility\n\n| Peek | Status | Filament | PHP |\n|------|----------|-----|--------|\n| [1.x](https://github.com/pboivin/filament-peek/tree/1.x) | Bugfixes only | ^2.0 | ^8.0 |\n| [2.x](https://github.com/pboivin/filament-peek/tree/2.x) | Current version | ^3.0 | ^8.1 |\n\nPlease feel free to report any issues you encounter with Peek [in this repository](https://github.com/pboivin/filament-peek/issues). I'll work with you to determine where the issue is coming from.\n\n## Demo Projects\n\nHere are a few example projects available to give this plugin a try:\n\n| Repository | Description |\n|------|----------|\n| [filament-peek-demo](https://github.com/pboivin/filament-peek-demo) | Content previews on a simple Filament project with Laravel Blade views. |\n| [filament-peek-demo-with-astro](https://github.com/pboivin/filament-peek-demo-with-astro) | Content previews on a more complex project with Filament as \"headless CMS\", and [Astro](https://astro.build/) on the front-end. (Work in progress) |\n| [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. |\n\n## Documentation\n\nThe documentation is available in the ['docs' directory](https://github.com/pboivin/filament-peek/tree/2.x/docs) on GitHub:\n\n\u003c!-- BEGIN_TOC --\u003e\n\n- [Configuration](https://github.com/pboivin/filament-peek/blob/2.x/docs/configuration.md)\n    - [Publishing the Config File](https://github.com/pboivin/filament-peek/blob/2.x/docs/configuration.md#publishing-the-config-file)\n    - [Available Options](https://github.com/pboivin/filament-peek/blob/2.x/docs/configuration.md#available-options)\n    - [Integrating With a Custom Theme](https://github.com/pboivin/filament-peek/blob/2.x/docs/configuration.md#integrating-with-a-custom-theme)\n- [Page Previews](https://github.com/pboivin/filament-peek/blob/2.x/docs/page-previews.md)\n    - [Overview](https://github.com/pboivin/filament-peek/blob/2.x/docs/page-previews.md#overview)\n    - [Using the Preview Modal on Edit pages](https://github.com/pboivin/filament-peek/blob/2.x/docs/page-previews.md#using-the-preview-modal-on-edit-pages)\n    - [Using the Preview Modal on List pages](https://github.com/pboivin/filament-peek/blob/2.x/docs/page-previews.md#using-the-preview-modal-on-list-pages)\n    - [Detecting the Preview Modal](https://github.com/pboivin/filament-peek/blob/2.x/docs/page-previews.md#detecting-the-preview-modal)\n    - [Using a Preview URL](https://github.com/pboivin/filament-peek/blob/2.x/docs/page-previews.md#using-a-preview-url)\n    - [Embedding a Preview Action into the Form](https://github.com/pboivin/filament-peek/blob/2.x/docs/page-previews.md#embedding-a-preview-action-into-the-form)\n    - [Preview Pointer Events](https://github.com/pboivin/filament-peek/blob/2.x/docs/page-previews.md#preview-pointer-events)\n    - [Adding Extra Data to Previews](https://github.com/pboivin/filament-peek/blob/2.x/docs/page-previews.md#adding-extra-data-to-previews)\n    - [Alternate Templating Engines](https://github.com/pboivin/filament-peek/blob/2.x/docs/page-previews.md#alternate-templating-engines)\n- [Builder Previews](https://github.com/pboivin/filament-peek/blob/2.x/docs/builder-previews.md)\n    - [Overview](https://github.com/pboivin/filament-peek/blob/2.x/docs/builder-previews.md#overview)\n    - [Using Builder Previews on Edit pages](https://github.com/pboivin/filament-peek/blob/2.x/docs/builder-previews.md#using-builder-previews-on-edit-pages)\n    - [Using Multiple Builder Fields](https://github.com/pboivin/filament-peek/blob/2.x/docs/builder-previews.md#using-multiple-builder-fields)\n    - [Using Custom Fields](https://github.com/pboivin/filament-peek/blob/2.x/docs/builder-previews.md#using-custom-fields)\n    - [Customizing the Preview Action](https://github.com/pboivin/filament-peek/blob/2.x/docs/builder-previews.md#customizing-the-preview-action)\n    - [Automatically Updating the Builder Preview](https://github.com/pboivin/filament-peek/blob/2.x/docs/builder-previews.md#automatically-updating-the-builder-preview)\n    - [Adding Extra Data to the Builder Editor State](https://github.com/pboivin/filament-peek/blob/2.x/docs/builder-previews.md#adding-extra-data-to-the-builder-editor-state)\n    - [Adding Extra Data to the Builder Preview](https://github.com/pboivin/filament-peek/blob/2.x/docs/builder-previews.md#adding-extra-data-to-the-builder-preview)\n    - [Alternate Templating Engines](https://github.com/pboivin/filament-peek/blob/2.x/docs/builder-previews.md#alternate-templating-engines)\n- [JavaScript Hooks](https://github.com/pboivin/filament-peek/blob/2.x/docs/javascript-hooks.md)\n- [Upgrading from v1.x](https://github.com/pboivin/filament-peek/blob/2.x/docs/upgrade-guide.md)\n\n\u003c!-- END_TOC --\u003e\n\n## FAQ and Known Issues\n\nI've started compiling some notes and solutions to common issues in [Discussions](https://github.com/pboivin/filament-peek/discussions/categories/general). Feel free to contribute your own tips and tricks.\n\n## Changelog\n\nPlease see [CHANGELOG](https://github.com/pboivin/filament-peek/blob/2.x/CHANGELOG.md) for more information on what has changed recently.\n\n## Contributing\n\nPlease see [CONTRIBUTING](https://github.com/pboivin/filament-peek/blob/2.x/.github/CONTRIBUTING.md) for details.\n\n## Security Vulnerabilities\n\nPlease review [our security policy](https://github.com/pboivin/filament-peek/security/policy) on how to report security vulnerabilities.\n\n## Credits\n\n- [Patrick Boivin](https://github.com/pboivin)\n- [All Contributors](https://github.com/pboivin/filament-peek/contributors)\n\n## Acknowledgements\n\nThe initial idea is heavily inspired by module previews in [Twill CMS](https://twillcms.com/).\n\n## License\n\nThe MIT License (MIT). Please see [License File](https://github.com/pboivin/filament-peek/blob/2.x/LICENSE.md) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenjpaddock%2Ffilament-peek","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbenjpaddock%2Ffilament-peek","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenjpaddock%2Ffilament-peek/lists"}