PHPackages digitonic/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. digitonic/filament-navigation ActiveLibrary[Utility & Helpers](/categories/utility) digitonic/filament-navigation ============================= Build structured navigation menus in Filament. 3.0.0(3mo ago)01.8k—0%MITPHPPHP ^8.3|^8.4|^8.5CI passing Since May 12Pushed 3mo agoCompare [ Source](https://github.com/digitonic/filament-navigation)[ Packagist](https://packagist.org/packages/digitonic/filament-navigation)[ Docs](https://github.com/digitonic/filament-navigation)[ GitHub Sponsors](https://github.com/ryangjchandler)[ RSS](/packages/digitonic-filament-navigation/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (9)Dependencies (18)Versions (11)Used By (0) Build structured navigation menus in Filament. ============================================== [](#build-structured-navigation-menus-in-filament) [![Latest Version on Packagist](https://camo.githubusercontent.com/361bfdfaefd8eb4421a2b31095d01fd726e984d25c650a829045bdb9709b2df1/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f64696769746f6e69632f66696c616d656e742d6e617669676174696f6e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/digitonic/filament-navigation)[![GitHub Tests Action Status](https://camo.githubusercontent.com/0bc853a7d461ccf9699dd703f1575269ef6443becc34bf2343b32e5d45a2520a/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f776f726b666c6f772f7374617475732f64696769746f6e69632f66696c616d656e742d6e617669676174696f6e2f72756e2d74657374733f6c6162656c3d7465737473)](https://github.com/digitonic/filament-navigation/actions?query=workflow%3Arun-tests+branch%3Amain)[![GitHub Code Style Action Status](https://camo.githubusercontent.com/4e1f80879f79527fe77ef0b545b6b93432241d06516d0b37d77351b046a029b8/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f776f726b666c6f772f7374617475732f64696769746f6e69632f66696c616d656e742d6e617669676174696f6e2f436865636b253230262532306669782532307374796c696e673f6c6162656c3d636f64652532307374796c65)](https://github.com/digitonic/filament-navigation/actions?query=workflow%3A%22Check+%26+fix+styling%22+branch%3Amain)[![Total Downloads](https://camo.githubusercontent.com/14afa684b52bea5448f9fcbda4741d4643952e6d9d8fe1d2b2fcac19aa36e5e5/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f64696769746f6e69632f66696c616d656e742d6e617669676174696f6e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/digitonic/filament-navigation) This plugin for Filament provides a `Navigation` resource that lets you build structural navigation menus with a clean drag-and-drop UI. It is a direct replacement for the `filament-navigation` package by Ryan Chandler, which seems to be no longer maintained. Installation ------------ [](#installation) Begin by installing this package via Composer: ``` composer require digitonic/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 Digitonic\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 `Digitonic\FilamentNavigation\Models\Navigation::fromHandle()` method. ``` use Digitonic\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 Digitonic\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/digitonic) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 48 — FairBetter than 95% of packages Maintenance82 Actively maintained with recent releases Popularity21 Limited adoption so far Community19 Small or concentrated contributor base Maturity61 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits 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 ~34 days Recently: every ~42 days Total 9 Last Release 96d ago Major Versions 1.1.1 → 2.0.02025-08-26 2.1.0 → 3.0.02026-02-11 PHP version history (3 changes)1.0.0PHP ^8.1|^8.2 2.0.0PHP ^8.3|^8.4 3.0.0PHP ^8.3|^8.4|^8.5 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/1104549?v=4)[Steven Richardson](/maintainers/richdynamix)[@richdynamix](https://github.com/richdynamix) --- Top Contributors [![ryangjchandler](https://avatars.githubusercontent.com/u/41837763?v=4)](https://github.com/ryangjchandler "ryangjchandler (67 commits)")[![SOD96](https://avatars.githubusercontent.com/u/9489645?v=4)](https://github.com/SOD96 "SOD96 (22 commits)")[![richdynamix](https://avatars.githubusercontent.com/u/1104549?v=4)](https://github.com/richdynamix "richdynamix (12 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (8 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (8 commits)")[![bumbummen99](https://avatars.githubusercontent.com/u/4533331?v=4)](https://github.com/bumbummen99 "bumbummen99 (2 commits)")[![danielbehrendt](https://avatars.githubusercontent.com/u/283437?v=4)](https://github.com/danielbehrendt "danielbehrendt (2 commits)")[![blackmunk](https://avatars.githubusercontent.com/u/30363767?v=4)](https://github.com/blackmunk "blackmunk (2 commits)")[![howdu](https://avatars.githubusercontent.com/u/533658?v=4)](https://github.com/howdu "howdu (2 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-navigationdigitonic ### Code Quality TestsPest Static AnalysisPHPStan Code StyleLaravel Pint ### Embed Badge ![Health badge](/badges/digitonic-filament-navigation/health.svg) ``` [![Health](https://phpackages.com/badges/digitonic-filament-navigation/health.svg)](https://phpackages.com/packages/digitonic-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)