PHPackages                             voltra/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. voltra/filament-navigation

ActiveLibrary[Utility & Helpers](/categories/utility)

voltra/filament-navigation
==========================

Build structured navigation menus in Filament.

v1.0.0(8mo ago)02MITPHPPHP ^8.1

Since Apr 19Pushed 8mo agoCompare

[ Source](https://github.com/Voltra/filament-navigation)[ Packagist](https://packagist.org/packages/voltra/filament-navigation)[ Docs](https://github.com/Voltra/filament-navigation)[ GitHub Sponsors](https://github.com/ryangjchandler)[ RSS](/packages/voltra-filament-navigation/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (17)Versions (21)Used By (0)

Build structured navigation menus in Filament.
==============================================

[](#build-structured-navigation-menus-in-filament)

Warning

This package is a fork of `ryangjchandler/filament-navigation` due to it no longer being maintained.

This plugin for Filament provides a `Navigation` resource that lets you build structural navigation menus with a clean drag-and-drop UI.

Migration
---------

[](#migration)

### From `ryangjchandler/filament-navigation` to `voltra/filament-navigation`

[](#from-ryangjchandlerfilament-navigation-to-voltrafilament-navigation)

To migrate from `ryangjchandler/filament-navigation` to `voltra/filament-navigation`, you will first need to install the new package:

```
composer require voltra/filament-navigation
```

Then replace all references of the `RyanChandler\FilamentNavigation` namespace with `Voltra\FilamentNavigation`.

Finally you'll be able to remove the unmaintained package:

```
composer remove ryangjchandler/filament-navigation
```

Installation
------------

[](#installation)

Begin by installing this package via Composer:

```
composer require voltra/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 Voltra\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 `Voltra\FilamentNavigation\Models\Navigation::fromHandle()` method.

```
use Voltra\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 Voltra\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)

- [Voltra](https://github.com/Voltra)
- [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

38

—

LowBetter than 85% of packages

Maintenance60

Regular maintenance activity

Popularity2

Limited adoption so far

Community18

Small or concentrated contributor base

Maturity66

Established project with proven stability

 Bus Factor1

Top contributor holds 56.2% 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 ~64 days

Recently: every ~187 days

Total

20

Last Release

256d ago

Major Versions

v0.5.0 → v1.0.0-beta12023-08-04

### Community

Maintainers

![](https://www.gravatar.com/avatar/802602e0aeb4b70b8385bfa34308b3d1aa55baa9b41d9216cbd824da0d7bcad0?d=identicon)[Voltra](/maintainers/Voltra)

---

Top Contributors

[![ryangjchandler](https://avatars.githubusercontent.com/u/41837763?v=4)](https://github.com/ryangjchandler "ryangjchandler (68 commits)")[![Voltra](https://avatars.githubusercontent.com/u/25990549?v=4)](https://github.com/Voltra "Voltra (11 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)")[![howdu](https://avatars.githubusercontent.com/u/533658?v=4)](https://github.com/howdu "howdu (2 commits)")[![blackmunk](https://avatars.githubusercontent.com/u/30363767?v=4)](https://github.com/blackmunk "blackmunk (2 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)")[![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)")[![sten](https://avatars.githubusercontent.com/u/180665?v=4)](https://github.com/sten "sten (1 commits)")[![ihahachi](https://avatars.githubusercontent.com/u/7762172?v=4)](https://github.com/ihahachi "ihahachi (1 commits)")[![devmatheus](https://avatars.githubusercontent.com/u/3445672?v=4)](https://github.com/devmatheus "devmatheus (1 commits)")

---

Tags

laravelfilamentlaravel-filamentfilament-navigationVoltra

###  Code Quality

TestsPest

Static AnalysisPHPStan

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/voltra-filament-navigation/health.svg)

```
[![Health](https://phpackages.com/badges/voltra-filament-navigation/health.svg)](https://phpackages.com/packages/voltra-filament-navigation)
```

###  Alternatives

[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)[guava/calendar

Adds support for vkurko/calendar to Filament PHP.

298241.0k3](/packages/guava-calendar)[tapp/filament-google-autocomplete-field

Filament plugin that provides a Google Autocomplete field

3098.1k](/packages/tapp-filament-google-autocomplete-field)[jibaymcs/filament-tour

Bring the power of DriverJs to your Filament panels and start a tour !

12247.8k](/packages/jibaymcs-filament-tour)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)