igdr/config-knp-menu-bundle

Configure your knp menus with yaml files accross your project bundles

dev-master 2017-01-26 12:04 UTC

Requires

• knplabs/knp-menu-bundle: 2.*

MIT

• symfony
• menu
• ui
• knp
• navigation
• user interface

README

Introduction

This bundle provides a way to configure your knp menus in your bundles yml configuration.

For more information on knp menu, read :

• The Knp Menu Documentation
• The Knp Menu Bundle Documentation

Installation

You can use composer for installation.

Add the repository to the composer.json file of your project and run the update or install command.

{
    "require": {
        "igdr/config-knp-menu-bundle": "dev-master"
    }
}

Then enable it in your AppKernel.php with the KnpMenuBundle :

$bundles = array(
    ...
    new Knp\Bundle\MenuBundle\KnpMenuBundle(),
    new Igdr\Bundle\ConfigKnpMenuBundle\IgdrConfigKnpMenuBundle(),
);

Documentation

In order to use this bundle, you must define your menu configuration in a navigation.yml file in your bundle.

Example :

my_mega_menu:
    tree:
        first_level_item:
            label: My first label
            children:
                second_level_item:
                    label: My second level

Then you need to define a service.

my_project.menu.admin:
    class: Knp\Menu\MenuItem
    factory_service: igdr_config_menu.menu.builder
    factory_method: createMenu
    arguments:
      - "@request"
      - "my_mega_menu"
    scope: request
    tags:
        - { name: knp_menu.menu, alias: my_menu }

The second argument must match the name of the menu in navigation.yml. The tag alias will be used in your twig template.

{{ knp_menu_render('my_menu') }}

Configuration

This is the available configuration definition for an item.

my_mega_menu:
    tree:
        first_level_item:
            uri: "An uri. Use it if you do not define route parameter"
            route: "A sf2 route without @"
            routeParameters: "an array of parameters to pass to the route"
            label: "My first label"
            order: An integer to sort the item in his level.
            attributes: An array of attributes passed to the knp item
            linkAttributes: An array of attributes passed to the a tag
            childrenAttributes: An array of attributes passed to the chidlren block
            display: boolean to hide the item
            displayChildren: boolean to hide the children
            children: # An array of subitems
                second_level_item:
                    label: My second level

This configuration matches the methods available in the Knp Menu Item class