Convenience Methods | menu | Spatie

 SPATIE

  HTML Menu Generator
======================

spatie.be/open-source

  [Docs](https://spatie.be/docs)  [Menu](https://spatie.be/docs/menu/v2)  Menus-in-your-laravel-app  Convenience Methods

 Version   v3   v2   v1

 Other versions for crawler [v3](https://spatie.be/docs/menu/v3) [v2](https://spatie.be/docs/menu/v2) [v1](https://spatie.be/docs/menu/v1)

- [ Introduction ](https://spatie.be/docs/menu/v2/introduction)
- [ Postcardware ](https://spatie.be/docs/menu/v2/postcardware)
- [ Requirements ](https://spatie.be/docs/menu/v2/requirements)
- [ Installation and Setup ](https://spatie.be/docs/menu/v2/installation-and-setup)
- [ Questions & Issues ](https://spatie.be/docs/menu/v2/questions-and-issues)
- [ Changelog ](https://spatie.be/docs/menu/v2/changelog)
- [ About Us ](https://spatie.be/docs/menu/v2/about-us)

Basic usage
-----------

- [ Your First Menu ](https://spatie.be/docs/menu/v2/basic-usage/your-first-menu)
- [ Adding Items ](https://spatie.be/docs/menu/v2/basic-usage/adding-items)
- [ Building a menu from a data source ](https://spatie.be/docs/menu/v2/basic-usage/building-a-menu-from-a-data-source)

Items in depth
--------------

- [ Active Items ](https://spatie.be/docs/menu/v2/items-in-depth/active-items)
- [ Manipulating Items ](https://spatie.be/docs/menu/v2/items-in-depth/manipulating-items)
- [ Conditionally Adding Items ](https://spatie.be/docs/menu/v2/items-in-depth/conditionally-adding-items)

Controlling the html output
---------------------------

- [ Item Attributes ](https://spatie.be/docs/menu/v2/controlling-the-html-output/item-attributes)
- [ Parent Attributes ](https://spatie.be/docs/menu/v2/controlling-the-html-output/parent-attributes)
- [ Appending and Prepending Html ](https://spatie.be/docs/menu/v2/controlling-the-html-output/appending-and-prepending-html)
- [ Non-list Menus ](https://spatie.be/docs/menu/v2/controlling-the-html-output/non-list-menus)

Menus in your Laravel app
-------------------------

- [ Convenience Methods ](https://spatie.be/docs/menu/v2/menus-in-your-laravel-app/convenience-methods)
- [ Views as Menu Items ](https://spatie.be/docs/menu/v2/menus-in-your-laravel-app/views-as-menu-items)
- [ Conditional Items Based on Permissions ](https://spatie.be/docs/menu/v2/menus-in-your-laravel-app/conditional-items-based-on-permissions)
- [ Using Macros ](https://spatie.be/docs/menu/v2/menus-in-your-laravel-app/using-macros)

Examples
--------

- [ Bootstrap Menu ](https://spatie.be/docs/menu/v2/examples/bootstrap-menu)

      You are viewing the documentation for **an older version** of this package. You can check the version you are using with the following command:

 `                                    composer show spatie/menu                                                                                                                                                                                                                                    `

Convenience Methods
===================

###  On this page

1. [ Link ](#content-link)
2. [ Menu ](#content-menu)

The items provided in the `laravel-menu` package have some added convenience methods linked to Laravel's url generator.

Link
--------------------------------------------------------------------

`Spatie\Menu\Laravel\Link`

The `Link` class has three added factory methods, `toUrl`, `toRoute` and `toAction`. The methods require the same parameters as their Laravel helper function counterparts, with a `$text` parameter squished between as the second one.

```
Link::toUrl('/', 'Home');
Link::toRoute('contact', 'Contact');
Link::toAction('PageController@about', 'About');
```

Menu
--------------------------------------------------------------------

`Spatie\Menu\Laravel\Menu`

The `Menu` class has convenience methods for all of the above link factory methods.

```
Menu::new()
    ->url('/', 'Home')
    ->route('contact', 'Contact')
    ->action('PageController@about', 'About');
```