PHPackages ryangjchandler/filament-navigation - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. ryangjchandler/filament-navigation AbandonedArchivedLibrary[Utility & Helpers](/categories/utility) ryangjchandler/filament-navigation ================================== Build structured navigation menus in Filament. v0.5.0(3y ago)180101.2k↓15%781MITPHPPHP ^8.1 Since Apr 19Pushed 8mo ago3 watchersCompare [ Source](https://github.com/ryangjchandler/filament-navigation)[ Packagist](https://packagist.org/packages/ryangjchandler/filament-navigation)[ Docs](https://github.com/ryangjchandler/filament-navigation)[ GitHub Sponsors](https://github.com/ryangjchandler)[ RSS](/packages/ryangjchandler-filament-navigation/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (10)Dependencies (16)Versions (23)Used By (1) Build structured navigation menus in Filament. ============================================== [](#build-structured-navigation-menus-in-filament) Warning This package is no longer maintained. Please feel free to fork the package and update accordingly and re-release. This plugin for Filament provides a `Navigation` resource that lets you build structural navigation menus with a clean drag-and-drop UI. Installation ------------ [](#installation) Begin by installing this package via Composer: ``` composer require ryangjchandler/filament-navigation ``` Run migrations. ``` php artisan migrate ``` Publish the package's assets: ``` php artisan filament:assets ``` Usage ----- [](#usage) You first need to register the plugin with Filament. This can be done inside of your `PanelProvider`, e.g. `AdminPanelProvider`. ``` use RyanChandler\FilamentNavigation\FilamentNavigation; return $panel ->plugin(FilamentNavigation::make()); ``` If you wish to customise the navigation group, sort or icon, you can use the `NavigationResource::navigationGroup()`, `NavigationResource::navigationSort()` and `NavigationResource::navigationIcon()` methods. ### Data structure [](#data-structure) Each navigation menu is required to have a `name` and `handle`. The `handle` should be unique and used to retrieve the menu. Items are stored inside of a JSON column called `items`. This is a recursive data structure that looks like: ``` [ { "label": "Home", "type": "external-link", "data": { "url": "/", "target": "_blank", }, "children": [ // ... ], } ] ``` The recursive structure makes it really simple to render nested menus / dropdowns: ``` @foreach($menu->items as $item) {{ $item['label'] }} @if($item['children']) {{-- Render the item's children here... --}} @endif @endforeach ``` ### Retrieving a navigation object [](#retrieving-a-navigation-object) To retrieve a navigation object, provide the handle to the `RyanChandler\FilamentNavigation\Models\Navigation::fromHandle()` method. ``` use RyanChandler\FilamentNavigation\Models\Navigation; $menu = Navigation::fromHandle('main-menu'); ``` ### Custom item types [](#custom-item-types) Out of the box, this plugin comes with a single "item type" called "External link". This item type expects a URL to be provided and an optional "target" (same tab or new tab). It's possible to extend the plugin with custom item types. Custom item types have a name and an array of Filament field objects (or a `Closure` that produces an array) that will be displayed inside of the "Item" modal. This API allows you to deeply integrate navigation menus with your application's own entities and models. ``` return $panel ->plugin( FilamentNavigation::make() ->itemType('post', [ Select::make('post_id') ->//... ]) ); ``` All custom fields for the item type can be found inside of the `data` property on the item. ### Global custom fields [](#global-custom-fields) There might be cases where you want all item types to have an additional set of fields. This is useful for classes, custom IDs and more. To register global custom fields, use the `withExtraFields()` method on the plugin object. ``` return $panel ->plugin( FilamentNavigation::make() ->withExtraFields([ TextInput::make('classes'), ]), ); ``` ### The `Navigation` field type [](#the-navigation-field-type) This plugin also provides a custom Filament field that can be used to search and select a navigation menu inside other forms and resources. ``` use RyanChandler\FilamentNavigation\Filament\Fields\NavigationSelect; ->schema([ NavigationSelect::make('navigation_id'), ]) ``` By default, this field will not be searchable and the value for each option will be the menu `id`. To make the field searchable, call the `->searchable()` method. ``` ->schema([ NavigationSelect::make('navigation_id') ->searchable(), ]) ``` If you wish to change the value for each option, call the `->optionValue()` method. ``` ->schema([ NavigationSelect::make('navigation_id') ->optionValue('handle'), ]) ``` Testing ------- [](#testing) ``` composer test ``` Changelog --------- [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details. Security Vulnerabilities ------------------------ [](#security-vulnerabilities) Please review [our security policy](../../security/policy) on how to report security vulnerabilities. Credits ------- [](#credits) - [Ryan Chandler](https://github.com/ryangjchandler) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 47 — FairBetter than 94% of packages Maintenance42 Moderate activity, may be stable Popularity50 Moderate usage in the ecosystem Community30 Small or concentrated contributor base Maturity57 Maturing project, gaining track record Bus Factor1 Top contributor holds 61.8% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~57 days Recently: every ~142 days Total 19 Last Release 442d ago Major Versions v0.5.0 → v1.0.0-beta12023-08-04 ### Community Maintainers ![](https://www.gravatar.com/avatar/568d485d441c691b0358b9091254a6a671fef8f76b73f28af1180ad568d142b2?d=identicon)[ryangjchandler](/maintainers/ryangjchandler) --- Top Contributors [![ryangjchandler](https://avatars.githubusercontent.com/u/41837763?v=4)](https://github.com/ryangjchandler "ryangjchandler (68 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (8 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (8 commits)")[![bumbummen99](https://avatars.githubusercontent.com/u/4533331?v=4)](https://github.com/bumbummen99 "bumbummen99 (2 commits)")[![blackmunk](https://avatars.githubusercontent.com/u/30363767?v=4)](https://github.com/blackmunk "blackmunk (2 commits)")[![danielbehrendt](https://avatars.githubusercontent.com/u/283437?v=4)](https://github.com/danielbehrendt "danielbehrendt (2 commits)")[![howdu](https://avatars.githubusercontent.com/u/533658?v=4)](https://github.com/howdu "howdu (2 commits)")[![ihahachi](https://avatars.githubusercontent.com/u/7762172?v=4)](https://github.com/ihahachi "ihahachi (1 commits)")[![justrau](https://avatars.githubusercontent.com/u/10882793?v=4)](https://github.com/justrau "justrau (1 commits)")[![koupisbean](https://avatars.githubusercontent.com/u/44702609?v=4)](https://github.com/koupisbean "koupisbean (1 commits)")[![Kristories](https://avatars.githubusercontent.com/u/774338?v=4)](https://github.com/Kristories "Kristories (1 commits)")[![laravel-shift](https://avatars.githubusercontent.com/u/15991828?v=4)](https://github.com/laravel-shift "laravel-shift (1 commits)")[![lordjoo](https://avatars.githubusercontent.com/u/11289152?v=4)](https://github.com/lordjoo "lordjoo (1 commits)")[![mrfade](https://avatars.githubusercontent.com/u/7377876?v=4)](https://github.com/mrfade "mrfade (1 commits)")[![mynamespace](https://avatars.githubusercontent.com/u/1635905?v=4)](https://github.com/mynamespace "mynamespace (1 commits)")[![neurotools](https://avatars.githubusercontent.com/u/6556055?v=4)](https://github.com/neurotools "neurotools (1 commits)")[![ralphmorris](https://avatars.githubusercontent.com/u/12704880?v=4)](https://github.com/ralphmorris "ralphmorris (1 commits)")[![atmonshi](https://avatars.githubusercontent.com/u/1952412?v=4)](https://github.com/atmonshi "atmonshi (1 commits)")[![sten](https://avatars.githubusercontent.com/u/180665?v=4)](https://github.com/sten "sten (1 commits)")[![devmatheus](https://avatars.githubusercontent.com/u/3445672?v=4)](https://github.com/devmatheus "devmatheus (1 commits)") --- Tags laravelryangjchandlerfilament-navigation ### Code Quality TestsPest Code StylePHP CS Fixer ### Embed Badge ![Health badge](/badges/ryangjchandler-filament-navigation/health.svg) ``` [![Health](https://phpackages.com/badges/ryangjchandler-filament-navigation/health.svg)](https://phpackages.com/packages/ryangjchandler-filament-navigation) ``` ### Alternatives [guava/calendar Adds support for vkurko/calendar to Filament PHP. 298241.0k3](/packages/guava-calendar)[pboivin/filament-peek Full-screen page preview modal for Filament 253319.6k12](/packages/pboivin-filament-peek)[dotswan/filament-map-picker Easily pick and retrieve geo-coordinates using a map-based interface in your Filament applications. 124139.3k2](/packages/dotswan-filament-map-picker)[creagia/filament-code-field A Filamentphp input field to edit or view code data. 58289.3k3](/packages/creagia-filament-code-field)[swisnl/filament-backgrounds Beautiful backgrounds for Filament auth pages 54149.2k6](/packages/swisnl-filament-backgrounds)[hydrat/filament-table-layout-toggle Filament plugin adding a toggle button to tables, allowing user to switch between Grid and Table layouts. 6292.3k1](/packages/hydrat-filament-table-layout-toggle) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)