spatie / menu
Html menu generator
Installs: 2 163 189
Dependents: 9
Suggesters: 0
Security: 0
Stars: 736
Watchers: 23
Forks: 100
Open Issues: 0
Requires
- php: ^8.0
- spatie/url: ^2.0.0
Requires (Dev)
- larapack/dd: ^1.0
- pestphp/pest: ^1.22
- phpunit/phpunit: ^9.0
- vimeo/psalm: ^4.0
- dev-main
- 3.2.0
- 3.1.1
- 3.1.0
- 3.0.1
- 3.0.0
- v2.x-dev
- 2.10.3
- 2.10.2
- 2.10.1
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.1
- 2.4.0
- 2.3.1
- 2.3.0
- 2.2.2
- 2.2.1
- 2.2.0
- 2.1.3
- 2.1.2
- 2.1.1
- 2.1.0
- 2.0.1
- 2.0.0
- 2.0.0-beta.4
- 2.0.0-beta.3
- 2.0.0-beta.2
- 2.0.0-beta.1
- v1.x-dev
- 1.4.0
- 1.3.0
- 1.2.1
- 1.2.0
- 1.1.1
- 1.1.0
- 1.0.0
- 0.6.6
- 0.6.5
- 0.6.4
- 0.6.3
- 0.6.2
- 0.6.1
- 0.6.0
- 0.5.3
- 0.5.2
- 0.5.1
- 0.5.0
- 0.4.1
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1
This package is auto-updated.
Last update: 2024-10-17 07:27:35 UTC
README
The spatie/menu
package provides a fluent interface to build menus of any size in your php application. If you're building your app with Laravel, the spatie/laravel-menu
provides some extra treats.
If you're looking for a more flexible and renderless solution, maybe our spiritual successor Laravel Navigation is what you're looking for.
Documentation is available at https://docs.spatie.be/menu.
Upgrading from version 1? There's a guide for that!
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Human Readable, Fluent Interface
All classes provide a human readable, fluent interface (no array configuration). Additionally, you can opt for a more verbose and flexible syntax, or for convenience methods that cover most use cases.
Menu::new() ->add(Link::to('/', 'Home')) ->add(Link::to('/about', 'About')) ->add(Link::to('/contact', 'Contact')) ->add(Html::empty()) ->render(); // Or just... Menu::new() ->link('/', 'Home') ->link('/about', 'About') ->link('/contact', 'Contact') ->empty()
<ul> <li><a href="/">Home</a></li> <li><a href="/about">About</a></li> <li><a href="/contact">Contact</a></li> <li></li> </ul>
Or a More Programmatic Approach
Menus can also be created through a reduce-like callable.
$pages = [ '/' => 'Home', '/about' => 'About', '/contact' => 'Contact', ]; Menu::build($pages, function ($menu, $label, $url) { $menu->add($url, $label); })->render();
<ul> <li><a href="/">Home</a></li> <li><a href="/about">About</a></li> <li><a href="/contact">Contact</a></li> </ul>
Strong Control Over the Html Output
You can programatically add html classes and attributes to any item in the menu, or to the menu itself.
Menu::new() ->addClass('navigation') ->add(Link::to('/', 'Home')->addClass('home-link')) ->add(Link::to('/about', 'About')) ->add(Link::to('/contact', 'Contact')->addParentClass('float-right')) ->wrap('div.wrapper')
<div class="wrapper"> <ul class="navigation"> <li><a href="/" class="home-link">Home</a></li> <li><a href="/about">About</a></li> <li class="float-right"><a href="/contact">Contact</a></li> </ul> </div
Adding id to elements
You can add id, so you can easily target some of these elements with CSS or JS.
Menu::new() ->id('navigation') ->add(Link::to('/', 'Home')->id('home-link')) ->add(Link::to('/about', 'About')) ->add(Link::to('/contact', 'Contact'))
<ul id="navigation"> <li><a href="/" id="home-link">Home</a></li> <li><a href="/about">About</a></li> <li><a href="/contact">Contact</a></li> </ul>
Not Afraid of Depths
The menu supports submenus, which in turn can be nested infinitely.
Menu::new() ->link('/', 'Home') ->submenu('More', Menu::new() ->addClass('submenu') ->link('/about', 'About') ->link('/contact', 'Contact') );
<ul> <li><a href="/">Home</a></li> <li> More <ul class="submenu"> <li><a href="/about">About</a></li> <li><a href="/contact">Contact</a></li> </ul> </li> </ul>
Some Extra Treats for Laravel Apps
The Laravel version of the menu package adds some extras like convenience methods for generating URLs and macros.
Menu::macro('main', function () { return Menu::new() ->action('HomeController@index', 'Home') ->action('AboutController@index', 'About') ->action('ContactController@index', 'Contact') ->setActiveFromRequest(); });
<nav class="navigation"> {{ Menu::main() }} </nav>
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
Install
You can install the package via composer:
composer require spatie/menu
Usage
Documentation is available at https://docs.spatie.be/menu.
Upgrading to 2.0
Upgrading to 2.0 should be pretty painless for most use cases.
If you're just building menus...
- The
void
andvoidIf
have been removed. These can be replaced byhtml
andhtmlIf
, with empty strings as their first arguments - The
prefixLinks
andprefixUrls
methods have been removed because they were too unpredictable in some case. There currently isn't an alternative for these, besides writing your own logic and applying it withapplyToAll
.
If you're using custom Item
implementations...
- The
HtmlAttributes
andParentAttributes
traits have been renamed toHasHtmlAttributes
andHasParentAttributes
. - The
HasUrl
interface and trait has been removed. Url-related methods now also are part of theActivatable
interface and trait.
New features...
- Added the static
Menu::build
and non-staticMenu::fill
methods to create menu's from arrays. - The
setActive
method onActivatable
now also accepts a non-strict boolean or callable parameter to set$active
to true or false. Menu::html
andMenu::htmlIf
now accept a$parentAttributes
array as their second arguments.
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
phpunit
Contributing
Please see CONTRIBUTING for details.
Security
If you've found a bug regarding security please mail security@spatie.be instead of using the issue tracker.
Postcardware
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.
We publish all received postcards on our company website.
Credits
License
The MIT License (MIT). Please see License File for more information.