Navigation

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/navigation
Package slug	navigation
Product group	Capell Foundation
Tier	free
Bundle	foundation
Runtime contexts	admin, frontend, console
Capell version	^1.0
Catalogue role	extension
Release channel	Released
Source repository	capell-app/packages
Source path	packages/navigation
Docs source	packages/navigation/docs
Manifest	capell.json

What This Plugin Adds

Navigation is an Available, Schema-owning Capell package in the Capell Foundation product group. It ships as capell-app/navigation and extends these surfaces: admin, frontend, console.

Navigation adds site- and language-scoped menus with page links, external links, nested items, publication state, and reusable handles.

Editors build and order menus in admin, and public themes receive hydrated navigation with safe URLs, active states, and nested children.

Status details:

• Status: Available
• Tier: free
• Bundle: foundation
• Composer package: capell-app/navigation
• Namespace: Capell\Navigation
• Theme key: not applicable

Why It Matters

For developers: The navigable and handle registries let packages contribute linkable records and named menus without reaching into Navigation internals.

For teams: Editors can keep site menus current, reorder links, and reuse the same menu structure across theme output without code changes.

Screens And Workflow

Screenshot contract: docs/screenshots.json.

• Navigation admin index (admin, required evidence).
• Create/edit navigation form on desktop (admin, required evidence).
• Create/edit navigation form on tablet (admin, required evidence).
• Create/edit navigation form on mobile (admin, required evidence).
• Site relation manager for navigations (admin, supplementary evidence).
• Page form navigation tab (admin, required evidence).
• Frontend menu output (frontend, required evidence).
• Navigation admin index with admin sidebar menu open (admin, supplementary evidence).

Technical Shape

Service providers

• Capell\Navigation\Providers\NavigationServiceProvider
• Capell\Navigation\Providers\ConsoleServiceProvider

Config files

• packages/navigation/config/capell-navigation.php

Migrations

• packages/navigation/database/migrations/2026_05_10_190860_01_create_navigations_table.php
• packages/navigation/database/migrations/2026_06_04_000001_create_navigation_page_references_table.php
• packages/navigation/database/migrations/2026_08_28_000003_change_navigation_visibility_to_datetime.php

Models

• Navigation

Filament classes

• TypeSelect
• NavigationSelect
• NavigationTab
• NavigationItemsColumn
• DefaultNavigationConfigurator
• NavigationPageSchemaExtender
• NavigationSiteExtender
• NavigationResource
• CreateNavigation
• EditNavigation
• ListNavigations
• NavigationForm
• NavigationsTable
• NavigationsRelationManager

Route files

• packages/navigation/routes/web.php

Policies

• NavigationPolicy

Extension contracts

• NavigationNamesResolver
• NavigationPageSyncer

Events

• NavigationCreating

Listeners

• ReplicateSiteNavigationsListener

Actions

• AddPageToNavigationAction
• ApplyNavigationSiteSpecAction
• BuildNavigationBreadcrumbsAction
• BuildNavigationChildFragmentAction
• BuildNavigationImpactPreviewAction
• BuildNavigationRenderModelAction
• BuildNavigationStarterItemsAction
• BuildPageNavigationReferencesAction
• EnsureNavigationItemKeysAction
• RemovePageFromNavigationAction
• ReplicateSiteNavigationsAction
• ResolveNavigationCacheExpiryAction
• ResolveNavigationItemModelsAction
• ScalarizeNavigationDataAction
• SeedNavigationScreenshotFixtureAction
• SyncNavigationPageReferencesAction

Data objects

• NavigationItemData
• NavigationItemRenderData
• NavigationRenderContextData
• NavigationRenderData
• NavigationStarterItemsData
• NavigationStarterRequestData

Command signatures

• capell:navigation-demo
• capell:navigation-setup
• capell:navigation:screenshot-fixture

Console command classes

• DemoCommand
• SeedNavigationScreenshotFixtureCommand
• SetupCommand

Manifest contributions

• admin-resource: Capell\Navigation\Manifest\NavigationAdminResourceContribution
• configurator: Capell\Navigation\Manifest\NavigationConfiguratorContribution
• configurator: Capell\Navigation\Manifest\NavigationContentGraphContribution
• configurator: Capell\Navigation\Manifest\NavigationFrontendRuntimeContribution
• console-command: Capell\Navigation\Manifest\NavigationConsoleCommandsContribution
• frontend-component: Capell\Navigation\Manifest\NavigationFrontendComponentsContribution
• health-check: Capell\Navigation\Manifest\NavigationHealthContribution
• migration: Capell\Navigation\Manifest\NavigationMigrationsContribution
• model: Capell\Navigation\Manifest\NavigationModelsContribution
• page-type: Capell\Navigation\Manifest\NavigationPageTypeContribution
• render-hook: Capell\Navigation\Manifest\NavigationRenderHookContribution
• route: Capell\Navigation\Manifest\NavigationFrontendRouteContribution
• schema-extender: Capell\Navigation\Manifest\NavigationSchemaExtendersContribution

Health checks

• Capell\Navigation\Health\NavigationHealthCheck

Blade views

• packages/navigation/resources/views/components/breadcrumbs.blade.php
• packages/navigation/resources/views/components/header/main-navigation.blade.php
• packages/navigation/resources/views/components/header/menu/dropdown.blade.php
• packages/navigation/resources/views/components/header/menu/item.blade.php
• packages/navigation/resources/views/components/header/navigation.blade.php
• packages/navigation/resources/views/components/menu-items.blade.php
• packages/navigation/resources/views/components/menu.blade.php
• packages/navigation/resources/views/components/page/navigations.blade.php
• packages/navigation/resources/views/filament/forms/navigation-impact-preview.blade.php

Cache tags

• navigation

Data Model

• Required tables: navigations, navigation_page_references.
• Models: Navigation.
• Core record references in migrations: sites via site_id, languages via language_id.
• Migration files: 2026_05_10_190860_01_create_navigations_table.php, 2026_06_04_000001_create_navigation_page_references_table.php, 2026_08_28_000003_change_navigation_visibility_to_datetime.php.
• Migration impact: run host migrations through the package install flow before opening package surfaces.
• Deletion/retention behaviour: migrations declare cascade-on-delete relationships; no timed pruning or retention schedule is declared in capell.json.

Install Impact

• Required packages: capell-app/admin, capell-app/core, capell-app/frontend.
• Admin navigation: declares admin-resource: NavigationAdminResourceContribution; each Filament page or resource controls its own navigation visibility.
• Admin/editor extensions: configurator: NavigationConfiguratorContribution, configurator: NavigationContentGraphContribution, configurator: NavigationFrontendRuntimeContribution, schema-extender: NavigationSchemaExtendersContribution.
• Permissions: ViewAny:Navigation, View:Navigation, Create:Navigation, Update:Navigation, Delete:Navigation, DeleteAny:Navigation, Restore:Navigation, RestoreAny:Navigation, ForceDelete:Navigation, ForceDeleteAny:Navigation, Reorder:Navigation; access also governed by package policies: NavigationPolicy.
• Public routes: loads routes/web.php; registers NavigationFrontendRouteContribution.
• Database changes: package migrations are declared.
• Config: config/capell-navigation.php.
• Settings: no package settings declared.
• Queues or schedules: none declared.
• Cache tags: navigation.
• Commands: capell:navigation-demo, capell:navigation-setup, capell:navigation:screenshot-fixture.

Common Pitfalls

• Keep required Capell packages on compatible v4 releases: capell-app/admin, capell-app/core, capell-app/frontend.
• Run migrations before opening package resources or public routes.
• Review package configuration before production-like verification: config/capell-navigation.php.
• Review middleware, throttling, signatures, and public-output safety in routes/web.php before exposing routes.
• 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 navigation cache tags.

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
Admin screen or command fails on missing table	Package migrations have not run	Check the tables listed in Data Model	Run host migrations and rerun the focused package test
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

1. Install the package: composer require capell-app/navigation.
2. Run the package setup: php artisan capell:navigation-setup.
3. See it working: run php artisan capell:navigation-demo.
4. Open the package admin surface at /admin/navigation/navigations and confirm Navigation is available.

Next Steps

• Package docs
• Overview
• Worked extension examples
• Admin guide
• Configuration files: config/capell-navigation.php.
• Troubleshooting
• Screenshot contract
• Marketplace assets
• Capell content language plan
• Capell documentation design system
• Capell and package ERD notes