Repository files navigation

There is now an official fork of Laravel Breadcrumbs:
https://github.com/diglactic/laravel-breadcrumbs

Blog post:
https://newsroom.diglactic.com/laravel-breadcrumbs/

Thanks to Sheng Slogar of Diglactic for volunteering to take this project forward.

—Dave

As of 18 April 2020, Laravel Breadcrumbs is not being maintained.

It will probably keep working for a while - Iremoved the version constraint fromcomposer.json, so it will keep working until a future version of Laravel makes breaking changes.

If you want to create your own fork, to fix bugs or add new features, please seethe instructions below. TheMIT license requires you to keep the copyright notice and license information, but otherwise you can do what you like with the code and documentation.

Thanks to thecontributors who helped maintain it and add features over the last 7 years - I just don't have the energy for maintaining open source projects (or writing blog posts, or for social media) that I did in 2013, and I've decided it's time to focus on new projects instead.

—Dave

A simpleLaravel-style way to create breadcrumbs.

• Compatibility Chart
• Getting Started
• Defining Breadcrumbs
• Custom Templates
• Outputting Breadcrumbs
• Structured Data
• Route-Bound Breadcrumbs
• Advanced Usage
• API Reference
• FAQ
• Troubleshooting
• Contributing
• No Technical Support
• Changelog
• License

Note: If you are using an older version, click it in the table above to see the documentation for that version.

Note 2: If you think this documentation can be improved in any way, pleaseedit this file and make a pull request.

Run this at the command line:

composer require davejamesmiller/laravel-breadcrumbs:5.x

This will updatecomposer.json and install the package into thevendor/ directory.

Create a file calledroutes/breadcrumbs.php that looks like this:

<?php// HomeBreadcrumbs::for('home',function ($trail) {$trail->push('Home',route('home'));});// Home > AboutBreadcrumbs::for('about',function ($trail) {$trail->parent('home');$trail->push('About',route('about'));});// Home > BlogBreadcrumbs::for('blog',function ($trail) {$trail->parent('home');$trail->push('Blog',route('blog'));});// Home > Blog > [Category]Breadcrumbs::for('category',function ($trail,$category) {$trail->parent('blog');$trail->push($category->title,route('category',$category->id));});// Home > Blog > [Category] > [Post]Breadcrumbs::for('post',function ($trail,$post) {$trail->parent('category',$post->category);$trail->push($post->title,route('post',$post->id));});

See theDefining Breadcrumbs section for more details.

By default aBootstrap-compatible ordered list will be rendered, so if you're using Bootstrap 4 you can skip this step.

First initialise the config file by running this command:

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

Then openconfig/breadcrumbs.php and edit this line:

'view' =>'breadcrumbs::bootstrap4',

The possible values are:

• breadcrumbs::bootstrap4 –Bootstrap 4
• breadcrumbs::bootstrap3 –Bootstrap 3
• breadcrumbs::bootstrap2 –Bootstrap 2
• breadcrumbs::bulma –Bulma
• breadcrumbs::foundation6 –Foundation 6
• breadcrumbs::materialize –Materialize
• breadcrumbs::uikit –UIkit
• breadcrumbs::json-ld –JSON-LD Structured Data (<script> tag, no visible output)
• The path to a custom view: e.g.partials.breadcrumbs

See theCustom Templates section for more details.

Finally, callBreadcrumbs::render() in the view for each page, passing it the name of the breadcrumb to use and any additional parameters – for example:

{{ Breadcrumbs::render('home')}}{{ Breadcrumbs::render('category',$category)}}

See theOutputting Breadcrumbs section for other output options, and seeRoute-Bound Breadcrumbs for a way to link breadcrumb names to route names automatically.

Breadcrumbs will usually correspond to actions or types of page. For each breadcrumb you specify a name, the breadcrumb title and the URL to link it to. Since these are likely to change dynamically, you do this in a closure, and you pass any variables you need into the closure.

The following examples should make it clear:

The most simple breadcrumb is probably going to be your homepage, which will look something like this:

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

As you can see, you simply call$trail->push($title, $url) inside the closure.

For generating the URL, you can use any of the standard Laravel URL-generation methods, including:

• url('path/to/route') (URL::to())
• secure_url('path/to/route')
• route('routename') orroute('routename', 'param') orroute('routename', ['param1', 'param2']) (URL::route())
• action('controller@action') (URL::action())
• Or just pass a string URL ('http://www.example.com/')

This example would be rendered like this:

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

And results in this output:

Home

This is another static page, but this has a parent link before it:

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

It works by calling the closure for thehome breadcrumb defined above.

It would be rendered like this:

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

And results in this output:

Home / Blog

Note that the default templates do not create a link for the last breadcrumb (the one for the current page), even when a URL is specified. You can override this by creating your own template – seeCustom Templates for more details.

This is a dynamically generated page pulled from the database:

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

The$post object (probably anEloquent model, but could be anything) would simply be passed in from the view:

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

It results in this output:

Home /Blog / Post Title

Tip: You can pass multiple parameters if necessary.

Finally, if you have nested categories or other special requirements, you can call$trail->push() multiple times:

Breadcrumbs::for('category',function ($trail,$category) {$trail->parent('blog');foreach ($category->ancestorsas$ancestor) {$trail->push($ancestor->title,route('category',$ancestor->id));    }$trail->push($category->title,route('category',$category->id));});

Alternatively you could make a recursive function such as this:

Breadcrumbs::for('category',function ($trail,$category) {if ($category->parent) {$trail->parent('category',$category->parent);    }else {$trail->parent('blog');    }$trail->push($category->title,route('category',$category->slug));});

Both would be rendered like this:

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

And result in this:

Home /Blog /Grandparent Category /Parent Category / Category Title

To customise the HTML, create your own view file (e.g.resources/views/partials/breadcrumbs.blade.php) like this:

@if(count($breadcrumbs))    <olclass="breadcrumb">@foreach($breadcrumbsas$breadcrumb)@if($breadcrumb->url&&!$loop->last)                <liclass="breadcrumb-item"><ahref="{{$breadcrumb->url}}">{{$breadcrumb->title}}</a></li>@else                <liclass="breadcrumb-item active">{{$breadcrumb->title}}</li>@endif@endforeach    </ol>@endif

(See theviews/ directory for the built-in templates.)

The view will receive an array called$breadcrumbs.

Each breadcrumb is an object with the following keys:

• title – The breadcrumb title
• url – The breadcrumb URL, ornull if none was given
• Plus additional keys for each item in$data (seeCustom data)

Then update your config file (config/breadcrumbs.php) with the custom view name, e.g.:

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

Alternatively you can skip the custom view and callBreadcrumbs::generate() to get the breadcrumbsCollection directly:

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

CallBreadcrumbs::render() in the view for each page, passing it the name of the breadcrumb to use and any additional parameters.

In the page (e.g.resources/views/home.blade.php):

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

Or with a parameter:

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

In the page (e.g.resources/views/home.blade.php):

@extends('layout.name')@section('breadcrumbs'){{ Breadcrumbs::render('home')}}@endsection

Or using the shorthand syntax:

@extends('layout.name')@section('breadcrumbs', Breadcrumbs::render('home'))

And in the layout (e.g.resources/views/layout/name.blade.php):

@yield('breadcrumbs')

In the page (e.g.resources/views/home.php):

<?= Breadcrumbs::render('home')?>

Or use the longhand syntax if you prefer:

<?phpecho Breadcrumbs::render('home')?>

To render breadcrumbs as JSON-LDstructured data (usually for SEO reasons), useBreadcrumbs::view() to render thebreadcrumbs::json-ld template in addition to the normal one. For example:

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

(Note: If you useLaravel Page Speed you may need todisable theTrimUrls middleware.)

To specify an image, add it to the$data parameter inpush():

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

(If you prefer to use Microdata or RDFa you will need to create acustom template.)

In normal usage you must callBreadcrumbs::render($name, $params...) to render the breadcrumbs on every page. If you prefer, you can name your breadcrumbs the same as your routes and avoid this duplication...

Make sure each of your routes has a name. For example (routes/web.php):

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

For more details seeNamed Routes in the Laravel documentation.

For each route, create a breadcrumb with the same name and parameters. For example (routes/breadcrumbs.php):

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

To add breadcrumbs to acustom 404 Not Found page, use the nameerrors.404:

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

CallBreadcrumbs::render() with no parameters in your layout file (e.g.resources/views/app.blade.php):

{{ Breadcrumbs::render()}}

This will automatically output breadcrumbs corresponding to the current route. The same applies toBreadcrumbs::generate():

$breadcrumbs = Breadcrumbs::generate();

And toBreadcrumbs::view():

{{ Breadcrumbs::view('breadcrumbs::json-ld')}}

It will throw anInvalidBreadcrumbException if the breadcrumb doesn't exist, to remind you to create one. To disable this (e.g. if you have some pages with no breadcrumbs), first initialise the config file, if you haven't already:

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

Then openconfig/breadcrumbs.php and set this value:

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

Similarly, to prevent it throwing anUnnamedRouteException if the current route doesn't have a name, set this value:

'unnamed-route-exception' => false,

Laravel Breadcrumbs uses the same model binding as the controller. For example:

// routes/web.phpRoute::name('post')->get('/post/{post}','PostController@show');

// app/Http/Controllers/PostController.phpuseApp\Post;class PostControllerextends Controller{publicfunctionshow(Post$post)// <-- Implicit model binding happens here    {returnview('post/show', ['post' =>$post]);    }}

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

This makes your code less verbose and more efficient by only loading the post from the database once.

For more details seeRoute Model Binding in the Laravel documentation.

Laravel automatically creates route names for resourceful controllers, e.g.photo.index, which you can use when defining your breadcrumbs. For example:

// routes/web.phpRoute::resource('photo', PhotoController::class);

$ 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 |            |+--------+----------+--------------------+---------------+-------------------------+------------+

// routes/breadcrumbs.php// PhotosBreadcrumbs::for('photo.index',function ($trail) {$trail->parent('home');$trail->push('Photos',route('photo.index'));});// Photos > Upload PhotoBreadcrumbs::for('photo.create',function ($trail) {$trail->parent('photo.index');$trail->push('Upload Photo',route('photo.create'));});// Photos > [Photo Name]Breadcrumbs::for('photo.show',function ($trail,$photo) {$trail->parent('photo.index');$trail->push($photo->title,route('photo.show',$photo->id));});// Photos > [Photo Name] > Edit PhotoBreadcrumbs::for('photo.edit',function ($trail,$photo) {$trail->parent('photo.show',$photo);$trail->push('Edit Photo',route('photo.edit',$photo->id));});

For more details seeResource Controllers in the Laravel documentation.

(Related FAQ:Why is there no Breadcrumbs::resource() method?.)

The second parameter topush() is optional, so if you want a breadcrumb with no URL you can do so:

$trail->push('Sample');

The$breadcrumb->url value will benull.

The default Bootstrap templates provided render this with a CSS class of "active", the same as the last breadcrumb, because otherwise they default to black text not grey which doesn't look right.

Thepush() method accepts an optional third parameter,$data – an array of arbitrary data to be passed to the breadcrumb, which you can use in your custom template. For example, if you wanted each breadcrumb to have an icon, you could do:

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

The$data array's entries will be merged into the breadcrumb as properties, so you would access the icon as$breadcrumb->icon in your template, like this:

<li><ahref="{{$breadcrumb->url}}">    <imgsrc="/images/icons/{{$breadcrumb->icon}}">{{$breadcrumb->title}}</a></li>

Do not use the keystitle orurl as they will be overwritten.

You can register "before" and "after" callbacks to add breadcrumbs at the start/end of the trail. For example, to automatically add the current page number at the end:

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

To get the last breadcrumb for the current page, useBreadcrumb::current(). For example, you could use this to output the current page title:

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

To ignore a breadcrumb, add'current' => false to the$data parameter inpush(). This can be useful to ignore pagination breadcrumbs:

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

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

For more advanced filtering, useBreadcrumbs::generate() and Laravel'sCollection class methods instead:

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

You can useBreadcrumbs::view() in place ofBreadcrumbs::render() to render a template other than thedefault one:

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

Or you can override the config setting to affect all futurerender() calls:

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

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

Or you could callBreadcrumbs::generate() to get the breadcrumbs Collection and load the view manually:

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

If you callBreadcrumbs::render() orBreadcrumbs::generate() with no parameters, it will use the current route name and parameters by default (as returned by Laravel'sRoute::current() method).

You can override this by callingBreadcrumbs::setCurrentRoute($name, $param1, $param2...).

To check if a breadcrumb with a given name exists, callBreadcrumbs::exists('name'), which returns a boolean.

If you don't want to useroutes/breadcrumbs.php, you can change it in the config file. First initialise the config file, if you haven't already:

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

Then openconfig/breadcrumbs.php and edit this line:

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

It can be an absolute path, as above, or an array:

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

So you can useglob() to automatically find files using a wildcard:

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

Or return an empty array[] to disable loading.

If you are creating your own package, simply load your breadcrumbs file from your service provider'sboot() method:

useIlluminate\Support\ServiceProvider;class MyServiceProviderextends ServiceProvider{publicfunctionregister() {}publicfunctionboot()    {if (class_exists('Breadcrumbs')) {require__DIR__ .'/breadcrumbs.php';        }    }}

You can usedependency injection to access theBreadcrumbsManager instance if you prefer, instead of using theBreadcrumbs:: facade:

useDaveJamesMiller\Breadcrumbs\BreadcrumbsManager;useIlluminate\Support\ServiceProvider;class MyServiceProviderextends ServiceProvider{publicfunctionregister() {}publicfunctionboot(BreadcrumbsManager$breadcrumbs)    {$breadcrumbs->register(...);    }}

The BreadcrumbsManager class ismacroable, so you can add your own methods. For example:

Breadcrumbs::macro('pageTitle',function () {$title = ($breadcrumb = Breadcrumbs::current()) ?"{$breadcrumb->title} –" :'';if (($page = (int)request('page')) >1) {$title .="Page$page –";    }return$title .'Demo App';});

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

For more advanced customisations you can subclass BreadcrumbsManager and/or BreadcrumbsGenerator, then update the config file with the new class name:

// Manager'manager-class' =>DaveJamesMiller\Breadcrumbs\BreadcrumbsManager::class,// Generator'generator-class' =>DaveJamesMiller\Breadcrumbs\BreadcrumbsGenerator::class,

(Note: Anything that's not part of the public API (see below) may change between releases, so I suggest you write unit tests to ensure it doesn't break when upgrading.)

Source

useApp\Models\Post;useDaveJamesMiller\Breadcrumbs\BreadcrumbsGenerator;Breadcrumbs::before(function (BreadcrumbsGenerator$trail) {// ...});Breadcrumbs::for('name',function (BreadcrumbsGenerator$trail,Post$post) {// ...});Breadcrumbs::after(function (BreadcrumbsGenerator$trail) {// ...});

Source

@foreach($breadcrumbsas$breadcrumb){{-- ...--}}@endforeach

Source

config/breadcrumbs.php

Source

Since version 5.3.2, there is no maximum version of Laravel specified incomposer.json, so most of the time it will just work.

If it breaks for any reason, it will be fixed when (1) someonesubmits a pull request to fix it, or (2) I decide to upgrade my own applications - whichever comes first. In practice it's usually the former because I don't generally upgrade on day 1.

A few people have suggested addingBreadcrumbs::resource() to matchRoute::resource(), but no-one has come up with a good implementation that (a) is flexible enough to deal with translations, nested resources, etc., and (b) isn't overly complex as a result.

Personally I don't think there is a good all-round solution, so instead I recommend adding your own usingBreadcrumbs::macro(). Here's a starting point:

Breadcrumbs::macro('resource',function ($name,$title) {// Home > Blog    Breadcrumbs::for("$name.index",function ($trail)use ($name,$title) {$trail->parent('home');$trail->push($title,route("$name.index"));    });// Home > Blog > New    Breadcrumbs::for("$name.create",function ($trail)use ($name) {$trail->parent("$name.index");$trail->push('New',route("$name.create"));    });// Home > Blog > Post 123    Breadcrumbs::for("$name.show",function ($trail,$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 ($trail,$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');

Note that thisdoesn't deal with translations or nested resources, and it assumes that all models have atitle attribute (which users probably don't). Adapt it however you see fit.

• Re-read the instructions and make sure you did everything correctly.
• Start with the simple options and only use the advanced options (e.g. Route-Bound Breadcrumbs) once you understand how it works.

• Try runningcomposer update davejamesmiller/laravel-breadcrumbs to upgrade.
• Try runningphp artisan package:discover to ensure the service provider is detected by Laravel.

• Make sure you register the breadcrumbs in the right place (routes/breadcrumbs.php by default).
  • Try puttingdd(__FILE__) in the file to make sure it's loaded.
  • Try puttingdd($files) inBreadcrumbsServiceProvider::registerBreadcrumbs() to check the path is correct.
  • If not, try runningphp artisan config:clear (or manually deletebootstrap/cache/config.php) or update the path inconfig/breadcrumbs.php.
• Make sure the breadcrumb name is correct.
  • If using Route-Bound Breadcrumbs, make sure it matches the route name exactly.
• To suppress these errors when using Route-Bound Breadcrumbs (if you don't want breadcrumbs on some pages), either:
  • Register them with an empty closure (no push/parent calls), or
  • Setmissing-route-bound-breadcrumb-exception tofalse in the config file to disable the check (but you won't be warned if you miss any pages).

• Make sure the path is correct.
• If so, check the file ownership & permissions are correct.
• If not, try runningphp artisan config:clear (or manually deletebootstrap/cache/config.php) or update the path inconfig/breadcrumbs.php.

• Make sure you use{{ Breadcrumbs::render() }} or{{ Breadcrumbs::view() }}, not@include().

• You're probably using a versionolder than 5.1 - useBreadcrumbs::register() instead ofBreadcrumbs::for() (or upgrade).

Sorry I wasn't able to help this time, but once you have solved your problem, pleaseedit this file with the solution to help the next person!

Documentation: If you think the documentation can be improved in any way, please doedit this file and make a pull request.

Bug fixes: Please fix it and open apull request. (See below for more detailed instructions.) Bonus points if you add a unit test to make sure it doesn't happen again!

New features: Only features with a clear use case and well-considered API will be accepted. They must be documented and include unit tests. If in doubt, make a proof-of-concept (either code or documentation) and open apull request to discuss the details. (Tip: If you want a feature that's too specific to be included by default, seeMacros orAdvanced customisations for ways to add them.)

The easiest way to work on Laravel Breadcrumbs is to tell Composer to install it from source (Git) using the--prefer-source flag:

rm -rf vendor/davejamesmiller/laravel-breadcrumbscomposer install --prefer-source

Then checkout the master branch and create your own local branch to work on:

cd vendor/davejamesmiller/laravel-breadcrumbsgit checkout -t origin/mastergit checkout -b YOUR_BRANCH

Now make your changes, including unit tests and documentation (if appropriate). Run the unit tests to make sure everything is still working:

scripts/test.sh

Then commit the changes.Fork the repository on GitHub if you haven't already, and push your changes to it:

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

Finally, browse to the repository on GitHub and create a pull request.

(Alternatively, there is atest app that you can use.)

To use your own fork in a project, update thecomposer.json in your main project as follows:

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

ReplaceYOUR_USERNAME with your GitHub username andYOUR_BRANCH with the branch name (e.g.develop). This tells Composer to use your repository instead of the default one.

To run the unit tests:

scripts/test.sh

To check code coverage:

scripts/test-coverage.sh

Then opentest-coverage/index.html to view the results. Be aware of theedge cases in PHPUnit that can make it not-quite-accurate.

There is no maximum version specified incomposer.json, so there is no need for a new version of Laravel Breadcrumbs to be released every 6 months. However, this file will need to be updated to run tests against the new version:

• .travis.yml
  • matrix (Laravel versions)
  • php (PHP versions)
  • exclude (Unsupported combinations)

If changes are required, also update:

• README.md
  • Compatibility Chart
  • Changelog

If backwards-incompatible changes cause theminimum supported versions of Laravel or PHP to change, update:

• composer.json
  • php/*
  • illuminate/*

This section is for maintainers only.

• Ensure the unit tests are updated and have 100% coverage
• Update thetest app, if appropriate, and test it manually
• Ensure theREADME is up to date, including:
  • Document any new features
  • Compatibility Chart
  • Changelog
• Merge the changes into themaster branch (if necessary)
• Push the code changes to GitHub (git push)
• Make sureall tests are passing
• Tag the release (git tag 1.2.3)
• Push the tag (git push --tag)

Sorry, I don't offer any technical support, and GitHub Issues are disabled. That means I won't figure out why it's not working for you, I won't fix bugs for you, and I won't write new features on request - this isfree software after all.

But the beauty of open source is you can do whatever you want with it! You can fork it, fix it, improve it and extend it. If you don't want to maintain your own fork, and you think other people would benefit from your changes, you can submit apull request to have your changes included in the next release.

If you get really stuck, I suggest you:

1. Read and re-read both this file and theLaravel documentation to see if you missed something.
2. Dive into the source code and spend some time figuring out how it's meant to work and what's actually happening.
3. Try to reproduce the problem on a brand new Laravel project, in case it's an incompatibility with another package or your other code.
4. Ask your colleagues to help you debug it, if you work in a team.
5. Pay someone more experienced to help you (or if you work for a company, ask your boss to pay them).
6. Try posting onStack Overflow,Laravel.io Forum orLaracasts Forum (but I can't promise anyone will answer - they don't get paid either).
7. Use a different package instead.
8. Write your own.

Laravel Breadcrumbs usesSemantic Versioning.

• Remove the maximum Laravel version constraint from composer.json, to support Laravel 7+ without requiring a new release every 6 months

• Add a docblock to theBreadcrumbs facade (alternative toIDE Helper – thanks toAlexandr Chernyaev)

• Add Laravel 6.x support
• AddLaravel Ignition suggested solutions
• Changevendor:publish tag fromconfig tobreadcrumbs-config to match Horizon & Telescope and simplify the command

• Add Laravel 5.8 support (thanks toAndrew Dabich)

• AddUIkit template (breadcrumbs::uikit)(#198 byPieterHollevoet)

• Updatedefault config file with the full list of available views

• Add Laravel 5.7 support

• AddBreadcrumbs::for($name, $callback) as an alias forBreadcrumbs::register($name, $callback)
• Renamed$breadcrumbs to$trail in documentation (this doesn't affect the code)

These changes were inspired by (read: taken directly from)Dwight Watson's Breadcrumbs package.

No changes are required, but I recommend updating yourroutes/breadcrumbs.php to match the new documentation:

• ReplaceBreadcrumbs::register withBreadcrumbs::for
• Replace$breadcrumbs with$trail

• Add Laravel 5.6 support, and drop support for Laravel 5.5
• Drop PHP 7.0 support (addvoid return type hint, and use[] instead oflist())
• Fix class names in PhpDoc forBreadcrumbs facade when usingIDE Helper

• Upgrade to Laravel 5.6 (requires PHP 7.1.3+)
• If you are extending any classes, add: void return type hints where needed.

• Changelog for v4.x
• Changelog for v3.x
• Changelog for v2.x and below

MIT License

Copyright © 2013-2019 Dave James Miller

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.