README

Notice: In favor of using Filament, I have no need for this package anymore. As a result, I will no longer commit any more changes to it.

Breadcrumbs for Laravel

With Breadcrumbs for Laravel, you can easily add breadcrumbs to your Laravel applications. This package works very similar to the breadcrumbs package created by James Mills. I created my own version of the package because that one has been abandoned, and I want to continue to provide this kind of functionality in my own Laravel apps.

Here's a simple example of how you can define breadcrumbs, and then render them in a view:

// somewhere in a file defined in config/breadcrumbs.php. default = 'view' => base_path('routes/breadcrumbs.php')
Breadcrumbs::for('home', function (Generator $trail) {
    $trail->push('Home', route('home'));
});

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

<!-- will render a view with links for Home > About -->
<nav>{!! Breadcrumbs::render('about') !!}</nav>

Installation

You can install the package via composer:

composer require rawilk/laravel-breadcrumbs

You can publish the config file with:

php artisan vendor:publish --tag="breadcrumbs-config"

You can view the default configuration here: https://github.com/rawilk/laravel-breadcrumbs/blob/main/config/breadcrumbs.php

Documentation

For more documentation, please visit: https://randallwilk.dev/docs/laravel-breadcrumbs

Testing

On a fresh install, run the setup bin script first, otherwise certain DOM assertions won't work.

./bin/setup.sh

For convenience, a composer script is setup to run the pest test suite in parallel.

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email randall@randallwilk.dev instead of using the issue tracker.

Credits

Disclaimer

This package is not affiliated with, maintained, authorized, endorsed or sponsored by Laravel or any of its affiliates.

License

The MIT License (MIT). Please see License File for more information.

rawilk / laravel-breadcrumbs

Maintainers

Details