PHPackages shuxx/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. shuxx/filament-navigation ActiveLibrary[Utility & Helpers](/categories/utility) shuxx/filament-navigation ========================= Configure Filament navigation via a simple PHP config file with groups, links, and 24+ separator styles - no manual navigation building required! v1.0.0(5mo ago)6833[3 PRs](https://github.com/shuxx/filament-navigation/pulls)MITPHPPHP ^8.1|^8.2|^8.3CI passing Since Nov 11Pushed 1mo agoCompare [ Source](https://github.com/shuxx/filament-navigation)[ Packagist](https://packagist.org/packages/shuxx/filament-navigation)[ Docs](https://github.com/shuxx/filament-navigation)[ GitHub Sponsors](https://github.com/:vendor_name)[ RSS](/packages/shuxx-filament-navigation/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependencies (13)Versions (5)Used By (0) Filament Navigation =================== [](#filament-navigation) [![Filament Navigation Banner](https://raw.githubusercontent.com/shuxx/filament-navigation/main/.github/images/banner.png)](https://raw.githubusercontent.com/shuxx/filament-navigation/main/.github/images/banner.png) [![Latest Version](https://camo.githubusercontent.com/11e8e42ec0c2f09c2a1909216df2589da5c78c2607d43b958da53bd3553e7f86/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f73687578782f66696c616d656e742d6e617669676174696f6e2e7376673f7374796c653d666f722d7468652d6261646765)](https://packagist.org/packages/shuxx/filament-navigation) [![Total Downloads](https://camo.githubusercontent.com/f6e2de5ebf954c3ded5bad4ef08c561c4dcf436b387605a81cd6fc097e637a27/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f73687578782f66696c616d656e742d6e617669676174696f6e2e7376673f7374796c653d666f722d7468652d6261646765)](https://packagist.org/packages/shuxx/filament-navigation) [![License](https://camo.githubusercontent.com/0b6804e5634345aaf6ed8c72cfb6403180e7257461f5e7e91c5f5da13987dc42/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f73687578782f66696c616d656e742d6e617669676174696f6e2e7376673f7374796c653d666f722d7468652d6261646765)](https://packagist.org/packages/shuxx/filament-navigation) [![Tests](https://camo.githubusercontent.com/fe44d8398eb500165ea143b05a205308c11a1b3349f66a461001ccc149b6e019/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f73687578782f66696c616d656e742d6e617669676174696f6e2f72756e2d74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d5465737473267374796c653d666f722d7468652d6261646765)](https://github.com/shuxx/filament-navigation/actions/workflows/run-tests.yml) [![PHPStan](https://camo.githubusercontent.com/b25cff240a333aeefacf571c89bd8ee0b00267890633db8007e104f2d0a8d2d1/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f73687578782f66696c616d656e742d6e617669676174696f6e2f7068707374616e2e796d6c3f6272616e63683d6d61696e266c6162656c3d5048505374616e267374796c653d666f722d7468652d6261646765)](https://github.com/shuxx/filament-navigation/actions/workflows/phpstan.yml) Configure your Filament navigation via a simple PHP configuration file - no manual navigation building required! Perfect for applications where navigation needs to be easily manageable, version-controlled, and consistent across environments. --- ✨ Features ---------- [](#-features) - ✅ **Simple Configuration** - Define navigation in a clean PHP config file - ✅ **Full Control** - Groups, direct links, and visual separators - ✅ **24 Separator Styles** - From classic lines to hearts and stars - ✅ **Order Preservation** - Array order = display order - ✅ **External Links** - Support for external URLs with `target="_blank"` - ✅ **Icon Support** - Full Heroicon support for groups and items - ✅ **No Hover on Separators** - Automatically disables hover effects - ✅ **Filament 4 Compatible** - Built specifically for Filament 4.x 📦 Installation -------------- [](#-installation) Install via composer: ``` composer require shuxx/filament-navigation ``` Publish the configuration file: ``` php artisan vendor:publish --tag="filament-navigation-config" ``` This creates `config/filament-navigation.php`. 🚀 Quick Start ------------- [](#-quick-start) ### 1. Register the plugin [](#1-register-the-plugin) In `app/Providers/Filament/AdminPanelProvider.php`: ``` use Shuxx\FilamentNavigation\FilamentNavigationPlugin; public function panel(Panel $panel): Panel { return $panel ->plugin(FilamentNavigationPlugin::make()); } ``` ### 2. Configure your navigation [](#2-configure-your-navigation) Edit `config/filament-navigation.php`: ``` return [ 'items' => [ // Dashboard [ 'type' => 'link', 'label' => 'Dashboard', 'url' => '/admin', 'icon' => 'heroicon-o-home', ], // Separator ['type' => 'separator', 'style' => 'default'], // Users Group [ 'type' => 'group', 'label' => 'Users', 'icon' => 'heroicon-o-user-group', 'collapsible' => true, 'items' => [ ['type' => 'link', 'label' => 'All Users', 'url' => '/admin/users'], ['type' => 'link', 'label' => 'Roles', 'url' => '/admin/roles'], ], ], ['type' => 'separator', 'style' => 'dots'], // External link [ 'type' => 'link', 'label' => 'Documentation', 'url' => 'https://filamentphp.com/docs', 'icon' => 'heroicon-o-book-open', 'external' => true, ], ], ]; ``` That's it! Your navigation is now configured. 🎉 📖 Documentation --------------- [](#-documentation) ### Available Types [](#available-types) #### Group [](#group) Creates a collapsible navigation group: ``` [ 'type' => 'group', 'label' => 'Settings', 'icon' => 'heroicon-o-cog-6-tooth', 'collapsible' => true, // optional, default: true 'items' => [ // ... sub-items ], ] ``` #### Link [](#link) Creates a navigation link: ``` [ 'type' => 'link', 'label' => 'Dashboard', 'url' => '/admin/dashboard', 'icon' => 'heroicon-o-home', // optional 'external' => false, // optional, opens in new tab if true ] ``` #### Separator [](#separator) Creates a visual separator: ``` [ 'type' => 'separator', 'style' => 'default', // optional, see styles below ] ``` ### 🎨 Separator Styles (24 options) [](#-separator-styles-24-options) #### Classic Lines [](#classic-lines) - `default` → ─────────── - `long` → ──────────────── - `double` → ═══════════ - `thick` → ━━━━━━━━━━━ - `dash` → - - - - - - - - - `underscore` → \_\_\_\_\_\_\_\_\_\_\_ #### Dots and Circles [](#dots-and-circles) - `dots` → • • • • • • • • - `circle` → ○ ○ ○ ○ ○ ○ - `circle-filled` → ● ● ● ● ● ● - `ellipsis` → ⋯ ⋯ ⋯ ⋯ ⋯ #### Geometric Shapes [](#geometric-shapes) - `square` → ▪ ▪ ▪ ▪ ▪ ▪ - `diamond` → ◆ ◆ ◆ ◆ ◆ - `triangle` → ▸ ▸ ▸ ▸ ▸ ▸ - `arrow` → → → → → → - `chevron` → › › › › › › #### Special Symbols [](#special-symbols) - `stars` → ★ ★ ★ ★ ★ - `hearts` → ♥ ♥ ♥ ♥ ♥ - `plus` → + + + + + + + - `cross` → ✕ ✕ ✕ ✕ ✕ #### Waves and Curves [](#waves-and-curves) - `wave` → ～～～～～～～ - `wavy` → 〰〰〰〰〰 - `zigzag` → ﹏﹏﹏﹏﹏ #### Spaces [](#spaces) - `space` → (large empty space) - `blank` → · (minimal visible space) ### Plugin Options [](#plugin-options) #### Disable Separator Hover [](#disable-separator-hover) By default, separators have hover effects disabled. You can enable them: ``` FilamentNavigationPlugin::make() ->disableSeparatorHover(false) ``` ⚠️ Important Notes ------------------ [](#️-important-notes) ### Filament 4 Icon Limitation [](#filament-4-icon-limitation) In Filament 4, you **cannot** have icons on both the group AND its items. Choose one: **Option 1 - Icons on groups (recommended):** ``` [ 'type' => 'group', 'icon' => 'heroicon-o-user-group', // ✅ Icon here 'items' => [ ['label' => 'Users', 'url' => '...'], // ❌ No icons ], ] ``` **Option 2 - Icons on items:** ``` [ 'type' => 'group', // ❌ No icon on group 'items' => [ ['label' => 'Users', 'icon' => 'heroicon-o-users'], // ✅ Icons here ], ] ``` ### Navigation Order [](#navigation-order) The order of items in your config array **is** the display order. The plugin transforms everything into navigation groups internally to maintain order control (a Filament 4 requirement). 🧪 Testing --------- [](#-testing) ``` composer test ``` 📝 Changelog ----------- [](#-changelog) Please see [CHANGELOG](CHANGELOG.md) for recent changes. 📚 Documentation --------------- [](#-documentation-1) - **[Installation Guide](#-quick-start)** - Get started in minutes - **[Usage Examples](EXAMPLES.md)** - Real-world navigation configs (Blog, E-commerce, SaaS, CRM, etc.) - **[Separator Styles](#-separator-styles-24-options)** - All 24 available styles - **[API Reference](#-documentation)** - Complete configuration options - **[Changelog](CHANGELOG.md)** - Version history and updates 🤝 Contributing -------------- [](#-contributing) Contributions are welcome! Please see [CONTRIBUTING](CONTRIBUTING.md) for details on: - Reporting bugs - Suggesting features - Submitting pull requests - Development guidelines 💬 Support --------- [](#-support) Need help or have questions? - **📖 Documentation** - Check [EXAMPLES.md](EXAMPLES.md) for common use cases - **🐛 Issues** - [Report bugs or request features](https://github.com/shuxx/filament-navigation/issues) - **💡 Discussions** - [Ask questions or share ideas](https://github.com/shuxx/filament-navigation/discussions) - **📧 Email** - Contact the author at [github.com/shuxx](https://github.com/shuxx) 🔒 Security ---------- [](#-security) If you discover any security-related issues, please email the author directly instead of using the issue tracker. All security vulnerabilities will be promptly addressed. 💝 Credits --------- [](#-credits) - **Author**: [Shuxx](https://github.com/shuxx) - **Contributors**: [All Contributors](https://github.com/shuxx/filament-navigation/contributors) - **Inspired by**: [Filament](https://filamentphp.com) navigation system - **Built with**: [spatie/laravel-package-tools](https://github.com/spatie/laravel-package-tools) 📄 License --------- [](#-license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. --- **Made with ❤️ for the Filament community** [⭐ Star this repo](https://github.com/shuxx/filament-navigation) if you find it helpful! ### Health Score 46 — FairBetter than 93% of packages Maintenance88 Actively maintained with recent releases Popularity18 Limited adoption so far Community19 Small or concentrated contributor base Maturity53 Maturing project, gaining track record 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 Unknown Total 1 Last Release 179d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/d790e7f07c9df10629ee337df855f7e9af1c653c518bc512daedf76191034ba3?d=identicon)[shuxx](/maintainers/shuxx) --- Top Contributors [![awcodes](https://avatars.githubusercontent.com/u/3596800?v=4)](https://github.com/awcodes "awcodes (69 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (27 commits)")[![zepfietje](https://avatars.githubusercontent.com/u/44533235?v=4)](https://github.com/zepfietje "zepfietje (22 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (19 commits)")[![ryangjchandler](https://avatars.githubusercontent.com/u/41837763?v=4)](https://github.com/ryangjchandler "ryangjchandler (7 commits)")[![shuxx](https://avatars.githubusercontent.com/u/1872781?v=4)](https://github.com/shuxx "shuxx (5 commits)")[![saade](https://avatars.githubusercontent.com/u/14329460?v=4)](https://github.com/saade "saade (4 commits)")[![maartenpaauw](https://avatars.githubusercontent.com/u/4550875?v=4)](https://github.com/maartenpaauw "maartenpaauw (3 commits)")[![AlexisSerneels](https://avatars.githubusercontent.com/u/287688?v=4)](https://github.com/AlexisSerneels "AlexisSerneels (2 commits)")[![lucasgiovanny](https://avatars.githubusercontent.com/u/4853801?v=4)](https://github.com/lucasgiovanny "lucasgiovanny (1 commits)")[![rahat1994](https://avatars.githubusercontent.com/u/25553141?v=4)](https://github.com/rahat1994 "rahat1994 (1 commits)")[![Z3d0X](https://avatars.githubusercontent.com/u/75579178?v=4)](https://github.com/Z3d0X "Z3d0X (1 commits)")[![ArielMejiaDev](https://avatars.githubusercontent.com/u/31971074?v=4)](https://github.com/ArielMejiaDev "ArielMejiaDev (1 commits)")[![a21ns1g4ts](https://avatars.githubusercontent.com/u/11599205?v=4)](https://github.com/a21ns1g4ts "a21ns1g4ts (1 commits)")[![atmonshi](https://avatars.githubusercontent.com/u/1952412?v=4)](https://github.com/atmonshi "atmonshi (1 commits)")[![bebo2xd](https://avatars.githubusercontent.com/u/44145987?v=4)](https://github.com/bebo2xd "bebo2xd (1 commits)")[![cheesegrits](https://avatars.githubusercontent.com/u/934456?v=4)](https://github.com/cheesegrits "cheesegrits (1 commits)")[![darmshot](https://avatars.githubusercontent.com/u/29179227?v=4)](https://github.com/darmshot "darmshot (1 commits)")[![Abdulmajeed-Jamaan](https://avatars.githubusercontent.com/u/41128358?v=4)](https://github.com/Abdulmajeed-Jamaan "Abdulmajeed-Jamaan (1 commits)") --- Tags filamentfilament-pluginfilament-v4laravelnavigationphplaravelmenunavigationfilamentfilament-pluginsidebar ### Code Quality TestsPest Code StyleLaravel Pint ### Embed Badge ![Health badge](/badges/shuxx-filament-navigation/health.svg) ``` [![Health](https://phpackages.com/badges/shuxx-filament-navigation/health.svg)](https://phpackages.com/packages/shuxx-filament-navigation) ``` ### Alternatives [pboivin/filament-peek Full-screen page preview modal for Filament 253319.6k12](/packages/pboivin-filament-peek)[croustibat/filament-jobs-monitor Background Jobs monitoring like Horizon for all drivers for FilamentPHP 254255.2k6](/packages/croustibat-filament-jobs-monitor)[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)[schmeits/filament-character-counter This is a Filament character counter TextField and Textarea form field for Filament v4 and v5 33184.7k6](/packages/schmeits-filament-character-counter)[tapp/filament-google-autocomplete-field Filament plugin that provides a Google Autocomplete field 3098.1k](/packages/tapp-filament-google-autocomplete-field) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)