Laravel Breadcrumbs

You can avoid calling Breadcrumbs::render('name', $params) on every page by naming your breadcrumbs to match your Laravel route names. When you call Breadcrumbs::render() with no arguments, it automatically resolves the breadcrumb for the current route.

Implementation Steps:

1. Name your routes in routes/web.php (e.g., Route::name('post')->get(...)).
2. Define breadcrumbs with matching names in routes/breadcrumbs.php (e.g., Breadcrumbs::for('post', ...)).
3. Render in your layout using {{ Breadcrumbs::render() }}.

Handling Exceptions

If a route doesn't have a corresponding breadcrumb, an InvalidBreadcrumbException is thrown. You can disable this in config/breadcrumbs.php:

• 'missing-route-bound-breadcrumb-exception' => false
• 'unnamed-route-exception' => false (to prevent errors when a route has no name).

Route Model Binding

Breadcrumbs supports Laravel's route model binding. If your route is post/{post}, you can inject the Post model directly into the breadcrumb closure, ensuring the database is only queried once.

{{-- resources/views/app.blade.php --}}

{{ Breadcrumbs::render() }}

To migrate from the original davejamesmiller/laravel-breadcrumbs package to this repository (requires at least Laravel 6), follow these steps:

1. Swap the libraries via Composer:

composer remove davejamesmiller/laravel-breadcrumbs
composer require diglactic/laravel-breadcrumbs

2. Update your code references. While most classes are backwards-compatible, you should update the following namespaces to avoid future breakage:

Note: Pay close attention to class name changes, such as BreadcrumbsManager becoming simply Manager.

Breadcrumbs are defined using the Breadcrumbs::for() method. You typically create a file at routes/breadcrumbs.php. Each definition takes a unique name and a closure that receives a BreadcrumbTrail object (aliased as $trail).

Inside the closure, you use $trail->push() to add a link and $trail->parent() to establish hierarchy.

Static Pages

Breadcrumbs::for('home', function (BreadcrumbTrail $trail) {
    $trail->push('Home', route('home'));
});

Parent Links

Breadcrumbs::for('blog', function (BreadcrumbTrail $trail) {
    $trail->parent('home');
    $trail->push('Blog', route('blog'));
});

Dynamic Titles and Links

You can pass models or other variables into the closure to generate dynamic breadcrumbs.

Breadcrumbs::for('post', function (BreadcrumbTrail $trail, Post $post) {
    $trail->parent('blog');
    $trail->push($post->title, route('post', $post));
});

<?php // routes/breadcrumbs.php

use Diglacticreadcrubs// Breadcrumbs;
use Diglacticreadcrumbs// Generator as BreadcrumbTrail;

// Home
Breadcrumbs::for('home', function (BreadcrumbTrail $trail) {
    $trail->push('Home', route('home'));
});

// Home > Blog
Breadcrumbs::for('blog', function (BreadcrumbTrail $trail) {
    $trail->parent('home');
    $trail->push('Blog', route('blog'));
});

// Home > Blog > [Category]
Breadcrumbs::for('category', function (BreadcrumbTrail $trail, $category) {
    $trail->parent('blog');
    $trail->push($category->title, route('category', $category));
});

Custom Data in push()

You can pass an associative array as a third parameter to $trail->push() to attach arbitrary data to a breadcrumb. This data is available in your custom templates via the $breadcrumb object.

$trail->push('Home', '/', ['icon' => 'home.png']);

Note: Do not use title or url as keys in this array, as they will be overwritten.

Before and After Callbacks

Use Breadcrumbs::after() to append breadcrumbs to the end of every trail (e.g., for pagination).

Breadcrumbs::after(function (BreadcrumbTrail $trail) {
    $page = (int) request('page', 1);
    if ($page > 1) {
        $trail->push("Page {$page}");
    }
});

Getting the Current Breadcrumb

Use Breadcrumbs::current() to retrieve the last breadcrumb in the current trail.

<title>{{ ($breadcrumb = Breadcrumbs::current()) ? $breadcrumb->title : 'Fallback' }}</title>

Macros

The Manager class is macroable. You can add custom methods to the Breadcrumbs facade:

Breadcrumbs::macro('pageTitle', function () {
    return 'Custom Title';
});