disjfa/menu-bundle

Menu bundle for symfony, can also be use in glynn-admin-symfony

0.5.0 2024-10-08 20:08 UTC

Requires

• knplabs/knp-menu-bundle: ^2|^3
• symfony/event-dispatcher: ^5|^6|^7

MIT

• disjfa

• symfony
• menu

README

What does it do

This bundle adds two menu builders for your project. One for the site side, and one for the admin. This can help it to make live easier to generate menu structures. You can take a look at glynn-admin-symfony4 for a simple working example. It is using the KnpMenuBundle.

It is opinionated, it is setup using the bootstrap4 template

Instalation

composer req disjfa/menu-bundle

Setup

In the template you have to add a menu.

{{ knp_menu_render('admin', {'currentClass': 'active', 'ancestorClass': 'active', 'depth':3, 'template': 'admin/menu.html.twig'}) }}

or

{{ knp_menu_render('site', {'currentClass': 'active', 'ancestorClass': 'active', 'depth':2, 'template': 'admin/menu.html.twig'}) }}

Resister a menu

And then, in your code you can just subscribe to the menus to add your own

<?php

namespace App\Menu;

use Disjfa\MenuBundle\Menu\ConfigureSiteMenu;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

class MenuListener implements EventSubscriberInterface
{
    public function onMenuConfigure(ConfigureSiteMenu $event)
    {
        $menu = $event->getMenu();

        $menu->addChild('my_route', [
            'route' => 'my_route',
            'label' => 'My route title',
        ])->setExtra('icon', 'fa-home');
    }

    /**
     * @return array
     */
    public static function getSubscribedEvents()
    {
        return [
            ConfigureSiteMenu::class => ['onMenuConfigure', 999]
        ];
    }
}

Or you can subscribe to the ConfigureAdminMenu event to do the same for the admin menu.

And done

And now we are done. Make menus, be awesome!