Filament Peek
Package docs status
Section titled “Package docs status”This page is generated from public package documentation in capell-4/packages and the package manifest checked into the source repository.
| Field | Value |
|---|---|
| Composer package | capell-app/filament-peek |
| Package slug | filament-peek |
| Product group | Capell Foundation |
| Tier | free |
| Bundle | foundation |
| Runtime contexts | admin, frontend |
| Capell version | ^4.0 |
| Source repository | capell-app/packages |
| Source path | packages/filament-peek |
| Docs source | packages/filament-peek/docs |
| Manifest | capell.json |
What This Plugin Adds
Section titled “What This Plugin Adds”Filament Peek is an Available, No schema impact Capell package in the Capell Foundation product group. It ships as capell-app/filament-peek and extends these surfaces: admin, frontend.
Preview unsaved page and Layout Builder edits exactly as they’ll render on your live theme - through a private, expiring, signed link, with nothing written to your content until you save.
After install, admins get package-owned management surfaces and public users may see package-owned frontend output or routes.
Status details:
- Status: Available
- Tier: free
- Bundle: foundation
- Composer package:
capell-app/filament-peek - Namespace:
Capell\FilamentPeek - Theme key: not applicable
Why It Matters
Section titled “Why It Matters”For developers: The package gives developers package-owned service providers, Actions, Data objects, Laravel routes, Filament classes, and Blade views instead of pushing this behaviour into core or application code.
For teams: Preview unsaved page and Layout Builder edits exactly as they’ll render on your live theme - through a private, expiring, signed link, with nothing written to your content until you save.
Screens And Workflow
Section titled “Screens And Workflow”Screenshot contract: docs/screenshots.json.
- Page edit preview actions (admin, required).
Technical Shape
Section titled “Technical Shape”- Service providers:
Capell\FilamentPeek\Providers\FilamentPeekServiceProvider. - Config files:
packages/filament-peek/config/capell-filament-peek.php. - Filament classes:
PeekPagePreviewAction,FilamentPeekPanelExtender,PagePeekPreviewActionExtender. - Route files:
packages/filament-peek/routes/web.php. - Actions:
CreatePagePreviewSnapshotAction,FindPagePreviewSnapshotAction,RegisterLayoutBuilderPreviewWidgetsAction,RenderPagePreviewSnapshotAction,StoreLayoutBuilderPreviewStateAction. - Data objects:
LayoutBuilderPreviewStateData,PagePreviewSnapshotData. - Manifest contributions:
route: Capell\FilamentPeek\Manifest\FilamentPeekRoutesContribution. - Health checks:
Capell\FilamentPeek\Health\FilamentPeekHealthCheck. - Blade views:
packages/filament-peek/resources/views/preview-error.blade.php,packages/filament-peek/resources/views/preview-ribbon.blade.php. - Cache tags:
filament-peek-preview.
Data Model
Section titled “Data Model”This package has no schema impact. It does not declare package-owned migrations or required tables.
Docs gap: document extension points here if the package delegates persistence to a host package.
Install Impact
Section titled “Install Impact”- Admin navigation: adds package-owned Filament classes when registered.
- Permissions: none declared in
capell.json. - Public routes: route files exist and must be reviewed before public enablement.
- Database changes: no package migrations declared.
- Settings: no package settings declared.
- Queues or schedules: none detected in standard package paths.
- Cache tags:
filament-peek-preview. - Commands: none declared.
Common Pitfalls
Section titled “Common Pitfalls”- Review route middleware, throttling, signed URLs, and public-output safety before exposing routes.
- Keep public Blade and cached HTML free of authoring markers, model IDs, permissions, signed editor URLs, and lazy database queries.
- Keep
composer.json,composer.local.json,capell.json, docs, screenshots, and tests aligned when the package surface changes.
Troubleshooting
Section titled “Troubleshooting”| Symptom | Likely cause | Check | Fix |
|---|---|---|---|
| Package surface is missing after install | Provider or manifest is not loaded | Confirm capell.json, package composer.json, and provider registration | Reinstall the package, refresh Composer autoload, and clear host caches |
| Route returns unexpected output | Route cache, middleware, or signed URL setup does not match the package route file | Check the route files listed in Technical Shape | Clear route cache and verify middleware before exposing public routes |
| Public output leaks unexpected state | Render data, cache variation, or authoring boundary has regressed | Check public Blade, cache tags, and public-output safety tests | Move data loading out of Blade and rerun the package public-output tests |
Quick Start
Section titled “Quick Start”- Install the package:
composer require capell-app/filament-peek. - Run the required setup: no package migrations are declared; clear cached config and routes if the host app uses caches.
- Open the related Capell admin surface and verify Filament Peek appears.
Next Steps
Section titled “Next Steps”- Package docs
- Overview
- Screenshot contract
- Marketplace assets
- Capell content language plan
- Capell documentation design system
- Capell and package ERD notes
- Related packages: Layout Builder, Publishing Studio.
- Focused tests:
vendor/bin/pest packages/filament-peek/tests --configuration=phpunit.xml.