Skip to content
Capell CMS

Hero

Package docs status

Section titled “Package docs status”

This page is generated from package source documentation in the Capell packages repository and the checked-in manifest. Source documentation is not distribution status. Before running a Composer command, verify that the exact package and compatible 1.x release are available through public Packagist or the authenticated marketplace account.

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 ^1.0
Catalogue role extension
Release channel Labs
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.

Hero adds a Layout Builder hero widget with page copy, actions, responsive images or video, multiple slides, and inherited theme background options.

Editors configure the hero through Layout Builder and theme or widget background fields, while visitors receive the responsive hero rendered by the active theme.

Evidence: capell.json, src/View/Components/Widget/Hero.php, src/Actions/ResolveHeroBackgroundDataAction.php, src/Providers/HeroServiceProvider.php, docs/overview.admin.md, docs/screenshots.json, src/Filament/Extenders/HeroBackgroundWidgetSchemaExtender.php, tests/Feature/HeroWidgetViewTest.php.

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: Prepared Data objects and resolution Actions keep media and background decisions outside Blade, and tests enforce query-free public rendering without editor metadata.

For teams: Teams can establish reusable home-page defaults and still change copy, media, slides, and background treatment per widget without replacing unrelated page content.

Evidence: src/Data/HeroWidgetRenderData.php, src/Actions/ResolveHeroMediaDataAction.php, tests/Feature/HeroAssetSlideDataTest.php, tests/Feature/HeroWidgetViewTest.php, src/Actions/InstallHeroLayoutDefaultsAction.php, tests/Feature/HeroSetupCommandTest.php, tests/Feature/HeroBackgroundSchemaTest.php.

Screens And Workflow

Section titled “Screens And Workflow”

Screenshot contract: docs/screenshots.json.

Hero home widget rendered on a public page

Insights consent priming capture

  • 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 registers runtime behaviour through Capell\Hero\Providers\HeroServiceProvider while persistence remains with Capell core or required packages.

Install Impact

Section titled “Install Impact”
  • Required packages: capell-app/admin, capell-app/core, capell-app/frontend, capell-app/layout-builder.
  • Admin navigation: no admin page or resource contribution is declared.
  • Admin/editor extensions: none declared.
  • Permissions: none declared in capell.json.
  • Public routes: none declared.
  • Database changes: no package migrations declared.
  • Config: no package config files.
  • Settings: no package settings declared.
  • Queues or schedules: none declared.
  • Cache tags: hero.
  • Commands: capell:hero-setup.

Common Pitfalls

Section titled “Common Pitfalls”
  • Keep required Capell packages on compatible v4 releases: capell-app/admin, capell-app/core, capell-app/frontend, capell-app/layout-builder.
  • Keep public Blade and cached HTML free of authoring markers, model IDs, permissions, signed editor URLs, and lazy database queries.
  • Custom write integrations must preserve invalidation for hero cache tags.

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
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”
  1. Install the package: composer require capell-app/hero.
  2. Run the required setup: php artisan capell:hero-setup.
  3. Open the Hero home widget rendered on a public page and confirm the public output renders without admin state.

Next Steps

Section titled “Next Steps”