README

Filament Navigation

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

Quick start

Compatibility

For certain Filament versions, changes have to be made that render the package backwards incompatible with the previous version. Please see the table below to determine which version you need.

Version	Filament
v2 (current)	>=4.0
v1	<4.0

Please note: the main branch will always be the latest major version.

Installation

Start by installing the package via Composer:

composer require van-ons/filament-navigation:^2.0

Next, run the migrations:

php artisan migrate

Finally, publish the package's assets:

php artisan filament:assets

Usage

You first need to register the plugin with Filament. This can be done inside your PanelProvider, e.g. AdminPanelProvider:

use VanOns\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.

See Basic usage for more information.

Documentation

Please see the documentation for detailed information about installation and usage.

Contributing

Please see contributing for more information about how you can contribute.

Testing

composer test

Changelog

Please see changelog for more information about what has changed recently.

Upgrading

Please see upgrading for more information about how to upgrade.

Security

Please see security for more information about how we deal with security.

Credits

We would like to thank the following contributors for their contributions to this project:

Ryan Chandler (original author)
All Contributors

License

The scripts and documentation in this project are released under the MIT License.

van-ons / filament-navigation

Maintainers

Details