PHPackages duscarvalho/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. duscarvalho/filament-navigation ActiveLibrary[Utility & Helpers](/categories/utility) duscarvalho/filament-navigation =============================== Build structured navigation menus in Filament. 04PHP Since Sep 18Pushed 2y agoCompare [ Source](https://github.com/duscarvalho93/filament-navigation)[ Packagist](https://packagist.org/packages/duscarvalho/filament-navigation)[ RSS](/packages/duscarvalho-filament-navigation/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependenciesVersions (1)Used By (0) Build structured navigation menus in Filament. ============================================== [](#build-structured-navigation-menus-in-filament) [![Latest Version on Packagist](https://camo.githubusercontent.com/2f54926852424658b4f76d5066cfe5d11b11670ca6cd28835a968d2daf8e885e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7279616e676a6368616e646c65722f66696c616d656e742d6e617669676174696f6e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/ryangjchandler/filament-navigation)[![GitHub Tests Action Status](https://camo.githubusercontent.com/8128def88ecaf9c85b2eeac8a1c5b018e6c0c4e89afe5ff3f7c45145861f4a9e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f776f726b666c6f772f7374617475732f7279616e676a6368616e646c65722f66696c616d656e742d6e617669676174696f6e2f72756e2d74657374733f6c6162656c3d7465737473)](https://github.com/ryangjchandler/filament-navigation/actions?query=workflow%3Arun-tests+branch%3Amain)[![GitHub Code Style Action Status](https://camo.githubusercontent.com/53691a97fdd5e8d29370cdaca72467c6ff1dc54d4bf42af6e8183f4ba73219f5/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f776f726b666c6f772f7374617475732f7279616e676a6368616e646c65722f66696c616d656e742d6e617669676174696f6e2f436865636b253230262532306669782532307374796c696e673f6c6162656c3d636f64652532307374796c65)](https://github.com/ryangjchandler/filament-navigation/actions?query=workflow%3A%22Check+%26+fix+styling%22+branch%3Amain)[![Total Downloads](https://camo.githubusercontent.com/f99be89c140c3816075bc8e7d3652a1102e6a6fad6d222fd82d75e4378e0a982/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f7279616e676a6368616e646c65722f66696c616d656e742d6e617669676174696f6e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/ryangjchandler/filament-navigation) 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 duscarvalho\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 `duscarvalho\FilamentNavigation\Models\Navigation::fromHandle()` method. ``` use duscarvalho\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 duscarvalho\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 15 — LowBetter than 3% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity3 Limited adoption so far Community18 Small or concentrated contributor base Maturity21 Early-stage or recently created project Bus Factor1 Top contributor holds 59.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. ### Community Maintainers ![](https://www.gravatar.com/avatar/a72cc59c7c39f557abc34d3efc3ccfc84d56210ce1cb88f174133b9e74a78e86?d=identicon)[duscarvalho](/maintainers/duscarvalho) --- Top Contributors [![ryangjchandler](https://avatars.githubusercontent.com/u/41837763?v=4)](https://github.com/ryangjchandler "ryangjchandler (64 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)")[![eduardocode49](https://avatars.githubusercontent.com/u/49877305?v=4)](https://github.com/eduardocode49 "eduardocode49 (3 commits)")[![howdu](https://avatars.githubusercontent.com/u/533658?v=4)](https://github.com/howdu "howdu (2 commits)")[![danielbehrendt](https://avatars.githubusercontent.com/u/283437?v=4)](https://github.com/danielbehrendt "danielbehrendt (2 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)")[![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)")[![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)")[![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)")[![digitall-it](https://avatars.githubusercontent.com/u/3578378?v=4)](https://github.com/digitall-it "digitall-it (1 commits)")[![dood-](https://avatars.githubusercontent.com/u/10099592?v=4)](https://github.com/dood- "dood- (1 commits)") ### Embed Badge ![Health badge](/badges/duscarvalho-filament-navigation/health.svg) ``` [![Health](https://phpackages.com/badges/duscarvalho-filament-navigation/health.svg)](https://phpackages.com/packages/duscarvalho-filament-navigation) ``` ### Alternatives [edgaras/strsim Collection of string similarity and distance algorithms in PHP including Levenshtein, Damerau-Levenshtein, Jaro-Winkler, and more 2423.0k](/packages/edgaras-strsim)[benmanu/silverstripe-styleguide Generates a styleguide for a SilverStripe theme 108.1k1](/packages/benmanu-silverstripe-styleguide) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)