Hero
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/hero |
| Package slug | hero |
| Product group | Capell Foundation |
| Tier | free |
| Bundle | foundation |
| Runtime contexts | admin, frontend, console |
| Capell version | ^4.0 |
| Source repository | capell-app/packages |
| Source path | packages/hero |
| Docs source | packages/hero/docs |
| Manifest | capell.json |
What This Plugin Adds
Section titled “What This Plugin Adds”Hero is an Available, No schema impact Capell package in the Capell Foundation product group. It ships as capell-app/hero and extends these surfaces: admin, frontend, console.
A polished, responsive home hero for every Capell theme - autoplay video or decorative overlay backgrounds, multi-slide carousel, and theme-level styling that pages inherit automatically.
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/hero - Namespace:
Capell\Hero - 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, Filament classes, and Blade views instead of pushing this behaviour into core or application code.
For teams: A polished, responsive home hero for every Capell theme - autoplay video or decorative overlay backgrounds, multi-slide carousel, and theme-level styling that pages inherit automatically.
Screens And Workflow
Section titled “Screens And Workflow”Screenshot contract: docs/screenshots.json.
- Insights consent priming capture (frontend, optional).
- Hero home widget rendered on a public page (frontend, required).
Technical Shape
Section titled “Technical Shape”- Service providers:
Capell\Hero\Providers\HeroServiceProvider. - Filament classes:
HeroBackgroundSchema,HeroBackgroundThemeSchemaExtender,HeroBackgroundWidgetAssetSchemaExtender,HeroBackgroundWidgetSchemaExtender. - Actions:
InstallHeroLayoutDefaultsAction,ResolveHeroBackgroundDataAction,ResolveHeroMediaDataAction. - Data objects:
HeroAssetSlideData,HeroBackgroundData,HeroMediaData,HeroWidgetRenderData. - Command signatures:
capell:hero-setup. - Console command classes:
SetupCommand. - Health checks:
Capell\Hero\Health\HeroHealthCheck. - Blade views:
packages/hero/resources/views/components/hero/background.blade.php,packages/hero/resources/views/components/hero/content.blade.php,packages/hero/resources/views/components/hero/media.blade.php,packages/hero/resources/views/components/hero/related.blade.php,packages/hero/resources/views/components/hero/slide.blade.php,packages/hero/resources/views/components/hero/wrapper.blade.php,packages/hero/resources/views/components/widget/default.blade.php,packages/hero/resources/views/components/widget/hero.blade.php. - Cache tags:
hero.
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: none detected in package route files.
- Database changes: no package migrations declared.
- Settings: no package settings declared.
- Queues or schedules: none detected in standard package paths.
- Cache tags:
hero. - Commands:
capell:hero-setup.
Common Pitfalls
Section titled “Common Pitfalls”- Keep public Blade and cached HTML free of authoring markers, model IDs, permissions, signed editor URLs, and lazy database queries.
- Run package commands from the host app; in this repository use
vendor/bin/pestfor package tests. - 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 |
| Background work does not run | Queue worker or scheduled command is not active | Check package jobs, commands, and host scheduler configuration | Start the queue or scheduler, then run the focused command or package test |
| 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/hero. - Run the required setup:
php artisan capell:hero-setup. - Open the related Capell admin surface and verify Hero 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.
- Focused tests:
vendor/bin/pest packages/hero/tests --configuration=phpunit.xml.