Laravel Breadcrumbs
Laravel Breadcrumbs stats
- Downloads
- 2.9M
- Stars
- 718
- Open Issues
- 0
- Forks
- 54
A simple Laravel-style way to create breadcrumbs.
Laravel Breadcrumbs by Diglactic
Laravel Breadcrumbs is a package designed to manage breadcrumb navigation in Laravel applications effortlessly. It is an official fork of Dave James Miller's Laravel Breadcrumbs, enhanced and maintained by Diglactic.
Features
- Easy Integration: Quickly add breadcrumb functionality to your Laravel applications.
- Template Customization: Comes with built-in support for Bootstrap 4/5, Bulma, Foundation 6, Materialize, Tailwind CSS, UIkit, and JSON-LD structured data. It also allows for custom templates.
- Dynamic Breadcrumb Generation: Define breadcrumbs using closures, allowing for dynamic generation based on application state or database content.
- Route-Bound Breadcrumbs: Automatically generate breadcrumbs based on route names, reducing redundancy and enhancing maintainability.
- Structured Data Support: Supports JSON-LD structured data format, enhancing SEO.
- Extensive Configuration: Customize and configure breadcrumb templates and behavior directly from Laravel's config files.
Installation
-
Install via composer:
composer require diglactic/laravel-breadcrumbs -
Define breadcrumbs in
routes/breadcrumbs.php. Example:Breadcrumbs::for('home', function ($trail) {$trail->push('Home', route('home'));}); -
Customize the breadcrumb style by publishing and editing the configuration:
php artisan vendor:publish --tag=breadcrumbs-config -
Output breadcrumbs in your views:
{{ Breadcrumbs::render('home') }}
Usage Tips
- Defining Breadcrumbs: Breadcrumbs are defined based on routes, making it straightforward to link breadcrumb trails to controller actions or views.
- Custom Templates: Modify the appearance of your breadcrumbs by creating custom views or using one of the many predefined templates.
- Advanced Features: Utilize advanced options like route model binding, dynamic breadcrumb titles, and custom data attributes within breadcrumbs for enhanced control.
Documentation
For more detailed information on usage and advanced features, refer to the official GitHub repository.
This package streamlines breadcrumb management in Laravel projects, making it an essential tool for improving navigation and SEO through structured data integration and dynamic breadcrumb generation.