Weave Code
Breacrumbs Bundle Laravel Package
in-square/breacrumbs-bundle
A PHP bundle from in-square for building and rendering breadcrumb navigation, giving Symfony-style applications a simple way to define breadcrumb trails and output them in templates with minimal configuration.
Breadcrumbs bundle for Symfony
Frequently asked questions about Breacrumbs Bundle
- What is in-square/breacrumbs-bundle and what does it do?
- It is a lightweight Symfony bundle for defining breadcrumb trails and rendering them consistently in your templates. It focuses only on breadcrumbs, so you get clear navigation trails without pulling in a full menu system. Typical use is a per-route or per-controller trail definition that a Twig template then outputs in your layout.
- How do I install in-square/breacrumbs-bundle with Composer?
- Install it with Composer using composer require in-square/breacrumbs-bundle. If your application does not use Symfony Flex auto-registration, register the bundle in your bundles or kernel configuration as described in the repository README. After that, define a trail and render it from your template.
- Does in-square/breacrumbs-bundle work with Laravel?
- No. This is a Symfony bundle, not a Laravel package, so it depends on Symfony bundle registration and services rather than Laravel service providers. For Laravel you should use a Laravel-specific breadcrumb package or build a small Blade partial that generates the trail yourself.
- Which Symfony and PHP versions does this bundle support?
- Version support is defined by the require constraints in the package composer.json, which is the authoritative source. Check those constraints against your Symfony and PHP versions before installing, especially when upgrading a major Symfony release. Running composer update in a staging branch is the quickest way to confirm compatibility.
- How do I render breadcrumbs in a Twig template?
- Once a trail is defined, you render it from your Twig template using the rendering approach documented in the bundle README, usually by including the bundle template or calling its Twig helper. Place the render call in your base layout so every page inherits the trail. You can then adjust the surrounding markup and CSS to match your site design.
- Can I customize breadcrumb labels and the trail structure?
- Yes, labels and structure are customizable when you define the trail, so you can use human-readable titles instead of raw route names. You can also adapt the rendered markup in your templates to change separators, wrapping elements, or schema.org attributes. Keep trail definitions close to the controller or route logic so labels stay in sync with the page.
- How is this different from KnpMenuBundle or other breadcrumb libraries?
- This bundle is deliberately narrow: it builds and renders breadcrumb trails and little else. KnpMenuBundle and similar libraries provide full menu trees, voters, and more rendering options, which is useful if you also need navigation menus. If breadcrumbs are all you need, the smaller scope here means less configuration and fewer concepts to learn.
- Is in-square/breacrumbs-bundle safe to use in production?
- Breadcrumb generation is cheap, so runtime overhead should be negligible compared with your controller and database work. If your trail labels come from the database on every request, cache those lookups rather than recomputing them per page. Before shipping, review the bundle source and confirm it has tests covering the behavior you rely on.
- How do I test breadcrumb output in a Symfony application?
- Unit test the code that builds your trail by asserting the expected labels and order, which keeps the logic independent of rendering. Then add a functional test with WebTestCase or KernelBrowser that requests a page and asserts the breadcrumb markup appears in the response. Testing the rendered HTML catches template and translation regressions that unit tests miss.
- Is the package actively maintained, and what are the alternatives?
- Check the GitHub repository for recent commits, tagged releases, and issue activity before adopting it, since maintenance status matters more than feature lists for a small bundle. If it looks stale, alternatives include whiteoctober/breadcrumbs-bundle, KnpMenuBundle with a breadcrumb menu, or a short custom Twig macro. For a simple site, a hand-rolled trail in a service plus a Twig partial is often enough.
Weaver
How can I help you explore Laravel packages today?