Weave Code
Menu Builder Bundle Laravel Package
happyr/menu-builder-bundle
A Symfony bundle that simplifies creating and managing navigation menus. Define menu items and hierarchies in configuration or code, then render them in Twig templates with a clean, flexible API. Useful for site navigation, admin sidebars, and reusable menu structures.
Build menus easily
Frequently asked questions about Menu Builder Bundle
- Can I use happyr/menu-builder-bundle in Laravel?
- No, happyr/menu-builder-bundle is a Symfony bundle built around Symfony's DI container, bundle registration, and KnpMenuBundle, and it ships no Laravel service provider, facade, or config stub. There is no bundle concept in Laravel, so installing it natively will not produce working menus. You could port it by hand-writing a service provider and config bridge, but because the codebase is small, rewriting the menu construction or adopting spatie/laravel-menu is usually cheaper than maintaining a fork.
- How do I install happyr/menu-builder-bundle?
- In a Symfony app you install it with Composer using composer require happyr/menu-builder-bundle, then register the bundle in config/bundles.php and make sure KnpMenuBundle is installed and configured. Menu definitions go under the bundle's configuration key, typically in config/packages/happyr_menu_builder.yaml. There is no php artisan vendor:publish step or Laravel package discovery, so Laravel installation is not supported out of the box.
- What Laravel versions are compatible with happyr/menu-builder-bundle?
- None officially. The bundle targets Symfony, and its Symfony component constraints are expected to be ^4 or ^5, while Laravel 10 and 11 pin Symfony ^6 or ^7, so Composer will usually refuse the install. Even with --ignore-platform-reqs or widened constraints, you still need a custom Laravel service provider and config bridge. For Laravel 10 or 11, treat it as incompatible unless you fork it.
- What is the best Laravel alternative to happyr/menu-builder-bundle?
- spatie/laravel-menu is the closest Laravel-native equivalent, offering declarative menu definitions, route and URL items, active-state handling, and Blade rendering without a Symfony dependency. It supports Laravel's authorization gates and macros, which covers most permission-aware navigation needs. If you only need a few static menus, a small custom service provider or Blade component can be enough.
- How are menus defined in happyr/menu-builder-bundle configuration?
- Menus are declared as nested arrays of items under the bundle configuration, with keys for labels, routes, URIs, and child items. That keeps navigation out of controllers and templates and lets a compiler pass or extension point add dynamic items later. In a Laravel port, you would typically move these arrays into config/menu.php and resolve them through a service provider.
- Can I render happyr/menu-builder-bundle menus in Blade instead of Twig?
- Not directly. The bundle produces KnpMenu Menu objects and is designed to be rendered with KnpMenu's Twig helper or any KnpMenu renderer, and Laravel does not ship Twig by default. You can still render the resulting menu tree in Blade if you write a custom renderer or recursively loop over the menu children, but that is extra integration work. Most Laravel teams prefer a native package or a simple recursive Blade component.
- How do I add dynamic or permission-aware items to happyr/menu-builder-bundle menus?
- The bundle exposes a compiler pass and extension points, so you can hook into menu construction and add items based on services, request data, or other runtime conditions. In a Laravel port, those hooks become service provider bindings, events, or middleware, and permission checks should run through Laravel's Gate and policy system. If the active method resolves against the current route or request, you will need to rebind that logic to Laravel's router.
- Is happyr/menu-builder-bundle maintained and production-ready?
- Maintenance signals are weak: the package has very few stars and dependents, and version 0.2.1 arrived after a multi-year gap, which is a pulse rather than a cadence. The code itself is small and low-risk, but shipping new functionality such as the active method in a patch release suggests loose semver discipline. For production Laravel work, audit the source and prefer a maintained Laravel-native package unless you are prepared to own a fork.
- Which PHP versions does happyr/menu-builder-bundle support?
- Release 0.2.1 asserts PHP 8 support, but the notes do not clarify whether that means 8.0 only or 8.1 and newer. Laravel 10 and 11 require PHP 8.1 and 8.2 respectively, so confirm the exact constraint in composer.json before assuming compatibility. If only PHP 8.0 is covered, you will need to widen the constraint or run on an unsupported version.
- How do I test a Laravel menu ported from happyr/menu-builder-bundle?
- Test the menu tree rather than the rendering layer: build the menu through your service provider or menu class and assert labels, routes, children, and active flags with PHPUnit or Pest. For permission-aware menus, use Laravel's Gate::forUser or actingAs helpers to verify which items appear for each user. Add one feature test that renders the menu in Blade so you catch template or URL-generation regressions.
Weaver
How can I help you explore Laravel packages today?