Download the PHP package shuxx/filament-navigation without Composer

Filament Navigation

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

• ✅ 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

Install via composer:

Publish the configuration file:

This creates config/filament-navigation.php.

🚀 Quick Start

1. Register the plugin

In app/Providers/Filament/AdminPanelProvider.php:

2. Configure your navigation

Edit config/filament-navigation.php:

That's it! Your navigation is now configured. 🎉

📖 Documentation

Available Types

Group

Creates a collapsible navigation group:

Link

Creates a navigation link:

Separator

Creates a visual separator:

🎨 Separator Styles (24 options)

Classic Lines

• default → ───────────
• long → ────────────────
• double → ═══════════
• thick → ━━━━━━━━━━━
• dash → - - - - - - - -
• underscore → ___

Dots and Circles

• dots → • • • • • • • •
• circle → ○ ○ ○ ○ ○ ○
• circle-filled → ● ● ● ● ● ●
• ellipsis → ⋯ ⋯ ⋯ ⋯ ⋯

Geometric Shapes

• square → ▪ ▪ ▪ ▪ ▪ ▪
• diamond → ◆ ◆ ◆ ◆ ◆
• triangle → ▸ ▸ ▸ ▸ ▸ ▸
• arrow → → → → → →
• chevron → › › › › › ›

Special Symbols

• stars → ★ ★ ★ ★ ★
• hearts → ♥ ♥ ♥ ♥ ♥
• plus → + + + + + + +
• cross → ✕ ✕ ✕ ✕ ✕

Waves and Curves

• wave → ～～～～～～～
• wavy → 〰〰〰〰〰
• zigzag → ﹏﹏﹏﹏﹏

Spaces

• space → (large empty space)
• blank → · (minimal visible space)

Plugin Options

Disable Separator Hover

By default, separators have hover effects disabled. You can enable them:

⚠️ Important Notes

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):

Option 2 - Icons on items:

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

📝 Changelog

Please see CHANGELOG for recent changes.

📚 Documentation

• Installation Guide - Get started in minutes
• Usage Examples - Real-world navigation configs (Blog, E-commerce, SaaS, CRM, etc.)
• Separator Styles - All 24 available styles
• API Reference - Complete configuration options
• Changelog - Version history and updates

🤝 Contributing

Contributions are welcome! Please see CONTRIBUTING for details on:

• Reporting bugs
• Suggesting features
• Submitting pull requests
• Development guidelines

💬 Support

Need help or have questions?

• 📖 Documentation - Check EXAMPLES.md for common use cases
• 🐛 Issues - Report bugs or request features
• 💡 Discussions - Ask questions or share ideas
• 📧 Email - Contact the author at github.com/shuxx

🔒 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

• Author: Shuxx
• Contributors: All Contributors
• Inspired by: Filament navigation system
• Built with: spatie/laravel-package-tools

📄 License

The MIT License (MIT). Please see License File for more information.

Made with ❤️ for the Filament community

⭐ Star this repo if you find it helpful!