menu.md

Menu

---

go back to Table of contents

1. Configuration

By default, Admingenerator sets the knp_menu.twig.template parameter to AdmingeneratorGeneratorBundle:KnpMenu:knp_menu_trans.html.twig.

This template enables:

• prepending menu items with icons
• appending caret to dropdown menu items
• translation of menu item labels

If you change the template to a custom one, you will have to copy some lines from AdmingeneratorGeneratorBundle:KnpMenu:knp_menu_trans.html.twig to have these features.

2. Installation

By default Admingenerator base templates render the default menu.

This is done in Resources\base_admin_navbar.html.twig in menu block:

{% block menu %}{{ knp_menu_render('AdmingeneratorGeneratorBundle:DefaultMenu:navbarMenu') }}{% endblock %}

Create new menu builder

To overwrite this, you need to create a new menu builder class. To make things easier Admingenerator ships a base class which you can extend (see default menu builder to an example).

Note: In case of extending the default builder, your own menu builder has to be defined as a service (see Creating Menus as Services).

Overwrite menu block

When you have your builder class ready, simply overwrite the menu block to render your class:

{% block menu %}{{ knp_menu_render('AcmeDemoBundle:MyBuilder:myMenu') }}{% endblock %}

The menu block is defined in Resources\base_admin_navbar.html.twig, which is included by the base_admin_template (Resources\base_admin.html.twig). To overwrite the menu block, you should:

• set your own base_admin template

# config.yml
admingenerator_generator:
    ...
    base_admin_template:    AcmeDemoBundle::base_admin.html.twig
    ...

• include your own base_admin_navbar template in your base_admin template

{# AcmeDemoBundle::base_admin.html.twig #}

{% extends 'AdmingeneratorGeneratorBundle::base_admin_assetic_less.html.twig' %}
{# OR #}
{% extends 'AdmingeneratorGeneratorBundle::base_admin.html.twig' %}

{% block navbar %}
    {% include 'AcmeDemoBundle::base_admin_navbar.html.twig' %}
{% endblock navbar %}

• overwrite the menu block in your base_admin_navbar template, which extends the original admingenerator base_admin_navbar

{# AcmeDemoBundle::base_admin_navbar.html.twig #}

{% extends 'AdmingeneratorGeneratorBundle::base_admin_navbar.html.twig' %}

{% block menu %}{{ knp_menu_render('AcmeDemoBundle:MyBuilder:myMenu') }}{% endblock %}

Note: your base_admin and base_admin_navbar template must extend the original admingenerator templates.

3. Example

public function navbarMenu(FactoryInterface $factory, array $options)
{
    // create root item
    $menu = $factory->createItem('root');
    // set id for root item, and class for nice twitter bootstrap style
    $menu->setChildrenAttributes(array('id' => 'main_navigation', 'class' => 'nav navbar-nav'));

    // add links $menu
    $this->addLinkURI($menu, 'Item1', 'http://www.google.com');
    $this->addLinkRoute($menu, 'Item2', 'Your_RouteName');

    // add dropdown to $menu
    $dropdown = $this->addDropdown($menu, 'Item 3', true);

    // add header to $dropdown
    $this->addHeader($dropdown, 'Heading');

    // add links to $dropdown
    $this->addLinkRoute($dropdown, 'Subitem 3.1', 'Your_RouteName');
    $this->addLinkURI($dropdown, 'Subitem 3.2', 'http://www.google.com');
    
    // add divider to $dropdown
    $this->addDivider($dropdown);

    // add more links to $dropdown
    $this->addLinkRoute($dropdown, 'Subitem 3.3', 'Your_RouteName');

    return $menu;
}