Laravel Breadcrumbs

https://github.com/diglactic/laravel-breadcrumbs
Admin
Laravel Breadcrumbs is a simple Laravel package for creating and rendering breadcrumb navigation...
Tokens:14,606
Snippets:106
Trust Score:6.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install package from source with Composer

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Use the --prefer-source flag to install the package from Git for development. This removes the existing package and reinstalls it from source.

```bash
rm -rf vendor/diglactic/laravel-breadcrumbs
composer install --prefer-source
```

--------------------------------

### Load breadcrumbs file from a package service provider

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Loads a breadcrumbs definition file from a custom package's service provider boot() method. It checks if the 'Breadcrumbs' class exists before requiring the file, ensuring compatibility when the package is not installed.

```php
use Illuminate\Support\ServiceProvider;

class MyServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        if (class_exists('Breadcrumbs')) {
            require __DIR__ . '/breadcrumbs.php';
        }
    }
}
```

--------------------------------

### Render breadcrumbs with Breadcrumbs::render()

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Render breadcrumbs in a Blade template. The first example renders the 'home' breadcrumb with no parameters; the second passes a 'category' parameter to the 'category' breadcrumb.

```blade
{{ Breadcrumbs::render('home') }}
```

```blade
{{ Breadcrumbs::render('category', $category) }}
```

--------------------------------

### Render breadcrumbs in Blade views

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Call Breadcrumbs::render() in your Blade views, passing the breadcrumb name and any additional parameters. The first example renders the 'home' breadcrumb; the second renders the 'category' breadcrumb with a $category parameter.

```blade
{{-- resources/views/home.blade.php --}}
{{ Breadcrumbs::render('home') }}

{{-- resources/views/categories/show.blade.php --}}
{{ Breadcrumbs::render('category', $category) }}
```

--------------------------------

### Manually include custom breadcrumbs view with generate()

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Manually loads a custom breadcrumbs view by calling Breadcrumbs::generate() to get the breadcrumbs Collection and passing it to the view via @include. This gives full control over the rendering.

```blade
@include('partials.breadcrumbs2', ['breadcrumbs' => Breadcrumbs::generate('category', $category)])
```

--------------------------------

### Filter breadcrumbs with generate() and Collection where()

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Uses Breadcrumbs::generate() to get the breadcrumbs Collection and applies Laravel's Collection where() method to filter out breadcrumbs marked with 'current' => false, then gets the last one. This provides more advanced filtering than Breadcrumbs::current().

```php
<?php

use Diglactic\Breadcrumbs\Breadcrumbs;

$current = Breadcrumbs::generate()->where('current', '!==', false)->last();
```

--------------------------------

### Output current page breadcrumb title with fallback

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Uses Breadcrumbs::current() to get the last breadcrumb for the current page and outputs its title, with a fallback title if no breadcrumb exists. This is useful for setting the page title in the <title> tag.

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

--------------------------------

### Upgrade to 6.x from 5.x

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/UPGRADE.md

Swap the legacy library for the current package using Composer.

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

--------------------------------

### Run unit tests

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Run the unit tests to verify your changes are working.

```bash
vendor/bin/phpunit
```

--------------------------------

### Checkout main branch and create a local branch

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Navigate to the package directory, checkout the main branch, and create a new local branch for your work.

```bash
cd vendor/diglactic/laravel-breadcrumbs
git checkout -t origin/main
git checkout -b YOUR_BRANCH
```

--------------------------------

### Run unit tests with snapshot updates

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Run the unit tests and rebuild snapshots by setting the UPDATE_SNAPSHOTS environment variable.

```bash
UPDATE_SNAPSHOTS=true vendor/bin/phpunit
```

--------------------------------

### Upgrade to 10.x from 9.x

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/UPGRADE.md

Re-run the composer require command if you are on Laravel v10+.

```shell
composer require diglactic/laravel-breadcrumbs
```

--------------------------------

### Define Breadcrumbs in routes/breadcrumbs.php

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Create a routes/breadcrumbs.php file to define breadcrumbs. The imports are optional but help with IDE support. Each breadcrumb is defined with Breadcrumbs::for and uses push and parent to build the trail.

```php
<?php // routes/breadcrumbs.php

// Note: Laravel will automatically resolve `Breadcrumbs::` without
// this import. This is nice for IDE syntax and refactoring.
use Diglactic\Breadcrumbs\Breadcrumbs;

// This import is also not required, and you could replace `BreadcrumbTrail $trail`
//  with `$trail`. This is nice for IDE type checking and completion.
use Diglactic\Breadcrumbs\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));
});
```

--------------------------------

### Publish breadcrumbs config

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Initializes the breadcrumbs configuration file so you can customize the view template.

```bash
php artisan vendor:publish --tag=breadcrumbs-config
```

--------------------------------

### Configure composer.json to use fork

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Update your project's composer.json to use your fork as a VCS repository and require your branch.

```json5
{
    // ADD THIS:
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/YOUR_USERNAME/laravel-breadcrumbs.git"
        }
    ],
    "require": {
        // UPDATE THIS:
        "diglactic/laravel-breadcrumbs": "dev-YOUR_BRANCH"
    }
}
```

--------------------------------

### Render blog breadcrumb

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Renders the 'blog' breadcrumb defined in routes/breadcrumbs.php. The output is '[Home](#) / Blog'.

```blade
{{ Breadcrumbs::render('blog') }}
```

--------------------------------

### Generate code coverage report

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Run PHPUnit with the --coverage-html flag to generate an HTML coverage report in the test-coverage directory.

```bash
vendor/bin/phpunit --coverage-html test-coverage
```

--------------------------------

### Name routes for route-bound breadcrumbs

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Name your routes so that breadcrumbs can be automatically bound to them. This is the first step for route-bound breadcrumbs.

```php
<?php // routes/web.php

use Illuminate\Support\Facades\Route;

// Home
Route::name('home')->get('/', 'HomeController@index');

// Home > [Post]
Route::name('post')->get('/post/{id}', 'PostController@show');
```

--------------------------------

### Add fork remote and push branch

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Add your fork as a remote and push your branch to it, preparing for a pull request.

```bash
git remote add YOUR_USERNAME git@github.com:YOUR_USERNAME/laravel-breadcrumbs.git
git push -u YOUR_USERNAME YOUR_BRANCH
```

--------------------------------

### Render home breadcrumb

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Renders the 'home' breadcrumb defined in routes/breadcrumbs.php. The output is simply 'Home'.

```blade
{{ Breadcrumbs::render('home') }}
```

--------------------------------

### Configure custom Manager and Generator classes

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Configure custom Manager and Generator classes by updating the breadcrumbs config file. Note that configuration syntax may change between releases.

```php
// breadcrumbs/config.php

'manager-class' => Diglactic\Breadcrumbs\Manager::class,

'generator-class' => Diglactic\Breadcrumbs\Generator::class,

```

--------------------------------

### Define post breadcrumb with arrow function

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Alternative concise syntax for defining the same 'post' breadcrumb using arrow functions, available in PHP 7.4 and above.

```php
Breadcrumbs::for(
    'post',
    fn (BreadcrumbTrail $trail, Post $post) => $trail
        ->parent('blog')
        ->push($post->title, route('post', $post))
);
```

--------------------------------

### Define breadcrumb with parent link

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Defines a 'blog' breadcrumb that first calls the 'home' breadcrumb closure via $trail->parent('home') and then pushes a 'Blog' link. The default templates do not link the last breadcrumb even when a URL is specified.

```php
<?php // routes/breadcrumbs.php

use Diglactic\Breadcrumbs\Breadcrumbs;
use Diglactic\Breadcrumbs\Generator as BreadcrumbTrail;

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

--------------------------------

### Publish built-in breadcrumbs views

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Publishes the built-in breadcrumb templates into the project's resources/views/vendor/breadcrumbs/ directory for customization.

```bash
php artisan vendor:publish --tag=breadcrumbs-views
```

--------------------------------

### Set breadcrumbs files config to an array of paths

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Configures the 'files' option in config/breadcrumbs.php as an array of multiple file paths. This allows you to define breadcrumbs in separate files.

```php
'files' => [
    base_path('breadcrumbs/admin.php'),
    base_path('breadcrumbs/frontend.php'),
],
```

--------------------------------

### Define static homepage breadcrumb

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Defines a static homepage breadcrumb named 'home' that pushes a 'Home' link using the route() helper. Use any Laravel URL-generation method such as url(), secure_url(), route(), action(), or a plain string URL.

```php
<?php // routes/breadcrumbs.php

use Diglactic\Breadcrumbs\Breadcrumbs;
use Diglactic\Breadcrumbs\Generator as BreadcrumbTrail;

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

--------------------------------

### Configure breadcrumbs view in config/breadcrumbs.php

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Edit this line in config/breadcrumbs.php to change the default Bootstrap 5 breadcrumb view. Possible values include breadcrumbs::bootstrap5, breadcrumbs::bootstrap4, breadcrumbs::bulma, breadcrumbs::foundation6, breadcrumbs::json-ld, breadcrumbs::materialize, breadcrumbs::tailwind, breadcrumbs::uikit, or a custom view path like partials.breadcrumbs.

```php
// config/breadcrumbs.php

'view' => 'breadcrumbs::bootstrap5',
```

--------------------------------

### Define breadcrumbs matching route names

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Define breadcrumbs with names matching your routes so they can be rendered automatically. The 'post' breadcrumb uses parent('home') to create a trail.

```php
<?php // routes/breadcrumbs.php

use App\Models\Post;
use Diglactic\Breadcrumbs\Breadcrumbs;
use Diglactic\Breadcrumbs\Generator as BreadcrumbTrail;

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

// Home > [Post]
Breadcrumbs::for('post', function (BreadcrumbTrail $trail, Post $post) {
    $trail->parent('home');
    $trail->push($post->title, route('post', $post));
});
```

--------------------------------

### Set breadcrumbs files config to a single path

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Shows the default configuration line in config/breadcrumbs.php that sets the file path for defining breadcrumbs. You can change this to an absolute path or an array of paths.

```php
// config/breadcrumbs.php

'files' => base_path('routes/breadcrumbs.php'),
```

--------------------------------

### Breadcrumb with no URL

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Shows how to create a breadcrumb with no URL by omitting the second parameter to push(). In this case, $breadcrumb->url will be null. The default Bootstrap templates render this with a CSS class of 'active', the same as the last breadcrumb, because otherwise they default to black text not grey.

```php
$trail->push('Sample');
```

--------------------------------

### Define a breadcrumb trail with Breadcrumbs::for

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/tests/__snapshots__/IgnitionTest__testMissingRouteBoundBreadcrumbSolution with data set Multiple config files__2.txt

Registers a breadcrumb named 'home' with a single trail item containing a title and a route.

```php
Breadcrumbs::for('home', function ($trail) {
    $trail->push('Title Here', route('home'));
});
```

--------------------------------

### Inject Manager via dependency injection in service provider

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Use dependency injection in a service provider's boot method to access the Manager instance instead of the Breadcrumbs facade. The Manager is type-hinted and injected automatically by Laravel's container.

```php
<?php

use Diglactic\Breadcrumbs\Manager;
use Illuminate\Support\ServiceProvider;

class MyServiceProvider extends ServiceProvider
{
    public function boot(Manager $breadcrumbs): void
    {
        $breadcrumbs->for(...);
    }
}

```

--------------------------------

### Add image to breadcrumb with push() $data parameter

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Define a breadcrumb with an image by passing an 'image' key in the $data parameter of push(). The image is typically used for structured data (e.g., JSON-LD).

```php
<?php // routes/breadcrumbs.php

use App\Models\Post;
use Diglactic\Breadcrumbs\Breadcrumbs;
use Diglactic\Breadcrumbs\Generator as BreadcrumbTrail;

Breadcrumbs::for('post', function (BreadcrumbTrail $trail, Post $post) {
    $trail->parent('home');
    $trail->push($post->title, route('post', $post), ['image' => asset($post->image)]);
});
```

--------------------------------

### Define and render dynamic post breadcrumb

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Defines a breadcrumb trail for a dynamic post page, using the post's title and URL. The view renders the breadcrumbs by passing the post object to the 'post' breadcrumb.

```php
<?php // routes/breadcrumbs.php

use App\Models\Post;
use Diglactic\Breadcrumbs\Breadcrumbs;
use Diglactic\Breadcrumbs\Generator as BreadcrumbTrail;

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

```blade
{{ Breadcrumbs::render('post', $post) }}
```

--------------------------------

### Use glob() to auto-discover breadcrumbs files

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Uses PHP's glob() function to automatically find all PHP files in the breadcrumbs directory and set them as the breadcrumbs files. This is useful for automatically loading multiple breadcrumb definition files.

```php
'files' => glob(base_path('breadcrumbs/*.php')),
```

--------------------------------

### Set custom breadcrumbs view in config

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Updates the breadcrumbs config to use the custom view file. The comment indicates the expected file path.

```php
// config/breadcrumbs.php

'view' => 'partials.breadcrumbs', // --> resources/views/partials/breadcrumbs.blade.php
```

--------------------------------

### Resourceful controller breadcrumbs

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Shows how to define breadcrumbs for a Laravel resourceful controller. The route:list output shows the generated route names (photo.index, photo.create, etc.) that the breadcrumb definitions use. The breadcrumbs file defines breadcrumbs for index, create, show, and edit actions, each with appropriate parent and push calls.

```php
<?php // routes/web.php

use App\Http\Controllers\PhotoController;
use Illuminate\Support\Facades\Route;

Route::resource('photo', PhotoController::class);
```

```bash
$ php artisan route:list
+--------+----------+--------------------+---------------+-------------------------+------------+
| Domain | Method   | URI                | Name          | Action                  | Middleware |
+--------+----------+--------------------+---------------+-------------------------+------------+
|        | GET|HEAD | photo              | photo.index   | PhotoController@index   |            |
|        | GET|HEAD | photo/create       | photo.create  | PhotoController@create  |            |
|        | POST     | photo              | photo.store   | PhotoController@store   |            |
|        | GET|HEAD | photo/{photo}      | photo.show    | PhotoController@show    |            |
|        | GET|HEAD | photo/{photo}/edit | photo.edit    | PhotoController@edit    |            |
|        | PUT      | photo/{photo}      | photo.update  | PhotoController@update  |            |
|        | PATCH    | photo/{photo}      |               | PhotoController@update  |            |
|        | DELETE   | photo/{photo}      | photo.destroy | PhotoController@destroy |            |
+--------+----------+--------------------+---------------+-------------------------+------------+
```

```php
<?php // routes/breadcrumbs.php

use App\Models\Photo;
use Diglactic\Breadcrumbs\Breadcrumbs;
use Diglactic\Breadcrumbs\Generator as BreadcrumbTrail;

// Photos
Breadcrumbs::for('photo.index', function (BreadcrumbTrail $trail) {
    $trail->parent('home');
    $trail->push('Photos', route('photo.index'));
});

// Photos > Upload Photo
Breadcrumbs::for('photo.create', function (BreadcrumbTrail $trail) {
    $trail->parent('photo.index');
    $trail->push('Upload Photo', route('photo.create'));
});

// Photos > [Photo Name]
Breadcrumbs::for('photo.show', function (BreadcrumbTrail $trail, Photo $photo) {
    $trail->parent('photo.index');
    $trail->push($photo->title, route('photo.show', $photo));
});

// Photos > [Photo Name] > Edit Photo
Breadcrumbs::for('photo.edit', function (BreadcrumbTrail $trail, Photo $photo) {
    $trail->parent('photo.show', $photo);
    $trail->push('Edit Photo', route('photo.edit', $photo));
});
```

--------------------------------

### Define a Breadcrumbs::resource() macro in routes/breadcrumbs.php

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Defines a Breadcrumbs::resource() macro to generate index, create, show, and edit breadcrumbs for a resource. It assumes models have a title attribute and does not handle translations or nested resources; adapt as needed.

```php
<?php // routes/breadcrumbs.php

use App\Models\SomeModel;
use Diglactic\Breadcrumbs\Breadcrumbs;
use Diglactic\Breadcrumbs\Generator as BreadcrumbTrail;

Breadcrumbs::macro('resource', function (string $name, string $title) {
    // Home > Blog
    Breadcrumbs::for("{$name}.index", function (BreadcrumbTrail $trail) use ($name, $title) {
        $trail->parent('home');
        $trail->push($title, route("{$name}.index"));
    });

    // Home > Blog > New
    Breadcrumbs::for("{$name}.create", function (BreadcrumbTrail $trail) use ($name) {
        $trail->parent("{$name}.index");
        $trail->push('New', route("{$name}.create"));
    });

    // Home > Blog > Post 123
    Breadcrumbs::for("{$name}.show", function (BreadcrumbTrail $trail, SomeModel $model) use ($name) {
        $trail->parent("{$name}.index");
        $trail->push($model->title, route("{$name}.show", $model));
    });

    // Home > Blog > Post 123 > Edit
    Breadcrumbs::for("{$name}.edit", function (BreadcrumbTrail $trail, SomeModel $model) use ($name) {
        $trail->parent("{$name}.show", $model);
        $trail->push('Edit', route("{$name}.edit", $model));
    });
});

Breadcrumbs::resource('blog', 'Blog');
Breadcrumbs::resource('photos', 'Photos');
Breadcrumbs::resource('users', 'Users');
```

--------------------------------

### Register after callback to add page number breadcrumb

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Registers an 'after' callback that automatically appends the current page number to the end of the breadcrumb trail. The callback receives a BreadcrumbTrail instance and uses request('page', 1) to determine the page number, only pushing a breadcrumb when the page is greater than 1.

```php
<?php // routes/breadcrumbs.php

use Diglactic\Breadcrumbs\Breadcrumbs;
use Diglactic\Breadcrumbs\Generator as BreadcrumbTrail;

Breadcrumbs::after(function (BreadcrumbTrail $trail) {
    $page = (int) request('page', 1);

    if ($page > 1) {
        $trail->push("Page {$page}");
    }
});
```

--------------------------------

### Render JSON-LD structured data with Breadcrumbs::view()

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Render breadcrumbs as JSON-LD structured data for SEO by using Breadcrumbs::view() with the 'breadcrumbs::json-ld' template in the head, while also rendering the normal breadcrumbs in the body. Note: if using Laravel Page Speed, you may need to disable the TrimUrls middleware.

```blade
<html>
    <head>
        ...
        {{ Breadcrumbs::view('breadcrumbs::json-ld', 'category', $category) }}
        ...
    </head>
    <body>
        ...
        {{ Breadcrumbs::render('category', $category) }}
        ...
    </body>
</html>
```

--------------------------------

### Output route-bound breadcrumbs in layout

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Render breadcrumbs automatically in your layout by calling Breadcrumbs::render() with no parameters. This outputs breadcrumbs corresponding to the current route. The same applies to Breadcrumbs::generate() and Breadcrumbs::view().

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

{{ Breadcrumbs::render() }}
```

--------------------------------

### Render breadcrumbs with custom view using Breadcrumbs::view()

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Renders breadcrumbs using a custom view instead of the default one by calling Breadcrumbs::view() in place of Breadcrumbs::render(). The first argument is the view name, followed by the route name and parameters.

```blade
{{ Breadcrumbs::view('partials.breadcrumbs2', 'category', $category) }}
```

--------------------------------

### Define and render nested category breadcrumb

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Defines a breadcrumb trail for nested categories by iterating over ancestors and pushing each one. The view renders the breadcrumbs by passing the category object.

```php
<?php // routes/breadcrumbs.php

use App\Models\Category;
use Diglactic\Breadcrumbs\Breadcrumbs;
use Diglactic\Breadcrumbs\Generator as BreadcrumbTrail;

Breadcrumbs::for('category', function (BreadcrumbTrail $trail, Category $category) {
    $trail->parent('blog');

    foreach ($category->ancestors as $ancestor) {
        $trail->push($ancestor->title, route('category', $ancestor));
    }

    $trail->push($category->title, route('category', $category));
});
```

```blade
{{ Breadcrumbs::render('category', $category) }}
```

--------------------------------

### Pass custom data to breadcrumb with push() and use in Blade template

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Shows how to pass custom data to a breadcrumb via the third parameter of push() and then use that data in a custom Blade template. The $data array entries become properties on the breadcrumb object. Avoid using the keys 'title' or 'url' because they will be overwritten.

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

```blade
<li>
    <a href="{{ $breadcrumb->url }}">
        <img src="/images/icons/{{ $breadcrumb->icon }}">
        {{ $breadcrumb->title }}
    </a>
</li>
```

--------------------------------

### Define breadcrumb for custom 404 page

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Define a breadcrumb for a custom 404 error page using the name 'errors.404'. It sets the parent to 'home' and pushes 'Page Not Found'.

```php
Breadcrumbs::for('errors.404', function (BreadcrumbTrail $trail) {
    $trail->parent('home');
    $trail->push('Page Not Found');
});
```

--------------------------------

### Route model binding with breadcrumbs

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Shows how to use Laravel's route model binding with breadcrumbs. The route, controller, and breadcrumb definition all reference the same Post model, so the post is loaded only once. The breadcrumb uses the injected Post to set the title and URL.

```php
<?php // routes/web.php

use Illuminate\Support\Facades\Route;

Route::name('post')->get('/post/{post}', 'PostController@show');
```

```php
<?php // app/Http/Controllers/PostController.php

use App\Http\Controllers\Controller;
use App\Models\Post;
use Illuminate\Contracts\View\View;

class PostController extends Controller
{
    public function show(Post $post): View // <-- Route bound model is injected here
    {
        return view('post/show', ['post' => $post]);
    }
}
```

```php
<?php // routes/breadcrumbs.php

use App\Models\Post;
use Diglactic\Breadcrumbs\Breadcrumbs;
use Diglactic\Breadcrumbs\Generator as BreadcrumbTrail;

Breadcrumbs::for('post', function (BreadcrumbTrail $trail, Post $post) { // <-- The same Post model is injected here
    $trail->parent('home');
    $trail->push($post->title, route('post', $post));
});
```

--------------------------------

### Disable unnamed route exception

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Prevent the UnnamedRouteException when the current route has no name by setting this config value to false.

```php
// config/breadcrumbs.php

'unnamed-route-exception' => false,
```

--------------------------------

### Create custom breadcrumbs view

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Custom Blade view for rendering breadcrumbs as an ordered list. It checks if the breadcrumb has a URL and is not the last item to render a link; otherwise, it renders an active item.

```blade
 {{-- resources/views/partials/breadcrumbs.blade.php --}}

@unless ($breadcrumbs->isEmpty())
    <ol class="breadcrumb">
        @foreach ($breadcrumbs as $breadcrumb)

            @if (!is_null($breadcrumb->url) && !$loop->last)
                <li class="breadcrumb-item"><a href="{{ $breadcrumb->url }}">{{ $breadcrumb->title }}</a></li>
            @else
                <li class="breadcrumb-item active">{{ $breadcrumb->title }}</li>
            @endif

        @endforeach
    </ol>
@endunless
```

--------------------------------

### Generate breadcrumbs collection directly

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Skips the custom view and directly iterates over the breadcrumbs collection using Breadcrumbs::generate().

```blade
@foreach (Breadcrumbs::generate('post', $post) as $breadcrumb)
    {{-- ... --}}
@endforeach
```

--------------------------------

### Add custom macro and use in Blade template

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Define a custom macro on the breadcrumbs Manager class to generate a page title, then use it in a Blade template. The macro checks the current breadcrumb and the 'page' query parameter to build the title.

```php
<?php

use Diglactic\Breadcrumbs\Breadcrumbs;

Breadcrumbs::macro('pageTitle', function () {
    $title = ($breadcrumb = Breadcrumbs::current()) ? "{$breadcrumb->title} – " : '';

    if (($page = (int) request('page')) > 1) {
        $title .= "Page $page – ";
    }

    return "{$title} - Demo App";
});

```

```blade
<title>{{ Breadcrumbs::pageTitle() }}</title>
```

--------------------------------

### Ignore breadcrumb from current() with 'current' => false and use in title

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Shows how to ignore a breadcrumb from Breadcrumbs::current() by passing 'current' => false in the $data parameter of push(). The Blade template then uses Breadcrumbs::current() and the page number to build a title, demonstrating the ignored pagination breadcrumb is not included.

```php
<?php // routes/breadcrumbs.php

use Diglactic\Breadcrumbs\Breadcrumbs;
use Diglactic\Breadcrumbs\Generator as BreadcrumbTrail;

Breadcrumbs::after(function (BreadcrumbTrail $trail) {
    $page = (int) request('page', 1);

    if ($page > 1) {
        $trail->push("Page {$page}", null, ['current' => false]);
    }
});
```

```blade
<title>
    {{ ($breadcrumb = Breadcrumbs::current()) ? "$breadcrumb->title –" : '' }}
    {{ ($page = (int) request('page')) > 1 ? "Page $page –" : '' }}
    Demo App
</title>
```

--------------------------------

### Override breadcrumbs.view config and render with custom view

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Overrides the breadcrumbs.view config setting at runtime to affect all future render() calls. The Blade template then uses Breadcrumbs::render() as usual, but it will use the custom view.

```php
<?php

use Illuminate\Support\Facades\Config;

Config::set('breadcrumbs.view', 'partials.breadcrumbs2');
```

```blade
{{ Breadcrumbs::render('category', $category) }}
```

--------------------------------

### Disable missing route-bound breadcrumb exception

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Disable the InvalidBreadcrumbException for missing route-bound breadcrumbs by setting this config value to false. Useful for pages without breadcrumbs.

```php
// config/breadcrumbs.php

'missing-route-bound-breadcrumb-exception' => false,
```

--------------------------------

### Define recursive category breadcrumb

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/README.md

Alternative recursive definition for nested category breadcrumbs, using a parent category if available. The view renders the breadcrumbs by passing the category object.

```php
<?php // routes/breadcrumbs.php

use App\Models\Category;
use Diglactic\Breadcrumbs\Breadcrumbs;
use Diglactic\Breadcrumbs\Generator as BreadcrumbTrail;

Breadcrumbs::for('category', function (BreadcrumbTrail $trail, Category $category) {
    if ($category->parent) {
        $trail->parent('category', $category->parent);
    } else {
        $trail->parent('blog');
    }

    $trail->push($category->title, route('category', $category->slug));
});
```

```blade
{{ Breadcrumbs::render('category', $category) }}
```

--------------------------------

### Define invalid breadcrumb with Breadcrumbs::for

Source: https://github.com/diglactic/laravel-breadcrumbs/blob/main/tests/__snapshots__/IgnitionTest__testInvalidBreadcrumbSolution with data set Multiple config files__2.txt

Defines a breadcrumb named 'invalid' that pushes a single breadcrumb with the title 'Title Here' and the URL from url('/'). This is used in the test to verify that a breadcrumb with an invalid name is handled correctly.

```php
Breadcrumbs::for('invalid', function ($trail) {
    $trail->push('Title Here', url('/'));
});
```
Tokens:
Raw