[](https://packagist.org/packages/spatie/menu)
[](https://github.com/spatie/menu/actions?query=workflow%3ATests+branch%3Amaster)
[](https://packagist.org/packages/spatie/menu)
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`](https://github.com/spatie/laravel-menu) provides some extra treats.
If you're looking for a more flexible and renderless solution, maybe our spiritual successor [Laravel Navigation](https://github.com/spatie/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](https://github.com/spatie/menu#upgrading-to-20) for that!
## Support us
[](https://spatie.be/github-ad-click/menu)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
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](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## 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.
```php
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()
```
```html
```
## Or a More Programmatic Approach
Menus can also be created through a reduce-like callable.
```php
$pages = [
'/' => 'Home',
'/about' => 'About',
'/contact' => 'Contact',
];
Menu::build($pages, function ($menu, $label, $url) {
$menu->add($url, $label);
})->render();
```
```html
```
## 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.
```php
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')
```
```html
```
## Not Afraid of Depths
The menu supports submenus, which in turn can be nested infinitely.
```php
Menu::new()
->link('/', 'Home')
->submenu('More', Menu::new()
->addClass('submenu')
->link('/about', 'About')
->link('/contact', 'Contact')
);
```
```html
```
## Some Extra Treats for Laravel Apps
The Laravel version of the menu package adds some extras like convenience methods for generating URLs and macros.
```php
Menu::macro('main', function () {
return Menu::new()
->action('HomeController@index', 'Home')
->action('AboutController@index', 'About')
->action('ContactController@index', 'Contact')
->setActiveFromRequest();
});
```
```html
```
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects [on our website](https://spatie.be/opensource).
## Install
You can install the package via composer:
``` bash
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` and `voidIf` have been removed. These can be replaced by `html` and `htmlIf`, with empty strings as their first arguments
- The `prefixLinks` and `prefixUrls` 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 with `applyToAll`.
### If you're using custom `Item` implementations...
- The `HtmlAttributes` and `ParentAttributes` traits have been renamed to `HasHtmlAttributes` and `HasParentAttributes`.
- The `HasUrl` interface and trait has been removed. Url-related methods now also are part of the `Activatable` interface and trait.
### New features...
- Added the static `Menu::build` and non-static `Menu::fill` methods to create menu's from arrays.
- The `setActive` method on `Activatable` now also accepts a non-strict boolean or callable parameter to set `$active` to true or false.
- `Menu::html` and `Menu::htmlIf` now accept a `$parentAttributes` array as their second arguments.
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
phpunit
```
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security
If you've found a bug regarding security please mail [security@spatie.be](mailto: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](https://spatie.be/en/opensource/postcards).
## Credits
- [Sebastian De Deyne](https://github.com/sebastiandedeyne)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
](https://spatie.be/github-ad-click/menu)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
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](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## 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.
```php
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()
```
```html
```
## Or a More Programmatic Approach
Menus can also be created through a reduce-like callable.
```php
$pages = [
'/' => 'Home',
'/about' => 'About',
'/contact' => 'Contact',
];
Menu::build($pages, function ($menu, $label, $url) {
$menu->add($url, $label);
})->render();
```
```html
```
## 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.
```php
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')
```
```html