Download the PHP package web-id/breadcrumb without Composer
On this page you can find all versions of the php package web-id/breadcrumb. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download web-id/breadcrumb
More information about web-id/breadcrumb
Files in web-id/breadcrumb
Package breadcrumb
Short Description Make breadcrumbs using a route macro
License MIT
Homepage https://github.com/web-id-fr/breadcrumb
Informations about the package breadcrumb
Breadcrumb
Installation
You can install the package via composer:
Publish config file
Usage
This package uses Spatie's Laravel Navigation package (https://github.com/spatie/laravel-navigation).
Frontend
If you are using Inertia, update the frontend
key to the config file to inertia
.
If your project uses Blade templates, set the config to blade
.
Breadcrumb root element
Edit the breadcrumb_root
title and route name in your published breadcrumb.php
config file.
For instance, if your root element is your homepage:
Note\ Your route must be named.
Breadcrumb class
To create a new breadcrumb, create a class that extends the WebId\Breadcrumb\Breadcrumb
class.
In this example, we will create a breadcrumb for the blog page (list of all articles):
Notice that the add()
method only takes a name (blog). Indeed, the last element of a breadcrumb being
the active page, you don't need to attach a link to it.
In this example, your view should have a breadcrumb
key with this data:
If you want to create the breadcrumb for a single blog post, you probably want the parent element to be the blog page. In that case, add a method as follow:
Notice that your can Typehint a model in your breadcrumb methods as if you were in a controller method.
In this example, your view should have a breadcrumb
key with this data:
Register a breadcrumb to a route
In order for your breadcrumb to be accessible in your Inertia view, you have to register it to the associated route as follow:
Testing
License
The MIT License (MIT). Please see License File for more information.
All versions of breadcrumb with dependencies
spatie/laravel-package-tools Version ^1.18
illuminate/contracts Version ^11.0
spatie/laravel-navigation Version ^1.3
inertiajs/inertia-laravel Version ^2.0