Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fragkp/laravel-route-breadcrumb
Laravel: Add breadcrumbs to your routes
https://github.com/fragkp/laravel-route-breadcrumb
breadcrumb laravel
Last synced: 14 days ago
JSON representation
Laravel: Add breadcrumbs to your routes
- Host: GitHub
- URL: https://github.com/fragkp/laravel-route-breadcrumb
- Owner: fragkp
- License: mit
- Created: 2018-05-12T20:15:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-27T19:12:58.000Z (over 3 years ago)
- Last Synced: 2024-09-22T16:36:54.445Z (about 2 months ago)
- Topics: breadcrumb, laravel
- Language: PHP
- Homepage:
- Size: 71.3 KB
- Stars: 69
- Watchers: 3
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Add breadcrumbs to your routes
[](https://github.com/fragkp/laravel-route-breadcrumb/releases)
[](https://packagist.org/packages/fragkp/laravel-route-breadcrumb)
This package tries to give a simple solution for breadcrumbs. Add breadcrumbs direct to your routes and display them in your views.
## Installation
You can install the package via composer:
```bash
composer require fragkp/laravel-route-breadcrumb
```
If you want also use the facade to access the main breadcrumb class, add this line to your facades array in config/app.php:
```php
'Breadcrumb' => Fragkp\LaravelRouteBreadcrumb\Facades\Breadcrumb::class,
```
This package contains some pre-built views for the most active css-frameworks:
- [Bootstrap 3](https://github.com/fragkp/laravel-route-breadcrumb/tree/master/resources/views/bootstrap3.blade.php)
- [Bootstrap 4](https://github.com/fragkp/laravel-route-breadcrumb/tree/master/resources/views/bootstrap4.blade.php)
- [Bulma](https://github.com/fragkp/laravel-route-breadcrumb/tree/master/resources/views/bulma.blade.php)
- [Foundation 6](https://github.com/fragkp/laravel-route-breadcrumb/tree/master/resources/views/foundation6.blade.php)
If you want to use one of these views, include it in this way:
```php
@include('laravel-breadcrumb::bootstrap3')
```
To customize the pre-built views, run this command:
```bash
php artisan vendor:publish Fragkp\LaravelRouteBreadcrumb\BreadcrumbServiceProvider --tag=views
```
> Note: You could also create your own [custom view](#view-example) to display breadcrumb links.
## Usage
### Defining breadcrumbs
#### Basic
To add a breadcrumb title to your route, call the `breadcrumb` method and pass your title.
```php
Route::get('/')->breadcrumb('Your custom title');
```
#### Index
On some websites, you wish to have always an index inside your breadcrumbs. Use the `breadcrumbIndex` method.
**This method should only be used once.**
> Note: `breadcrumbIndex` sets also the breadcrumb title for this route.
```php
Route::get('/')->breadcrumbIndex('Start');
Route::get('/foo')->breadcrumb('Your custom title');
```
#### Inside groups
The `breadcrumb` method will also work inside route groups.
```php
Route::get('/')->breadcrumbIndex('Start');
Route::prefix('/foo')->group(function () {
Route::get('/bar')->breadcrumb('Your custom title');
});
```
#### Group index
Also, it is possible to specify a group index title by calling `breadcrumbGroup`.
**This method should only be used once inside a group.**
> Note: `breadcrumbGroup` sets also the breadcrumb title for this route.
```php
Route::get('/')->breadcrumbIndex('Start');
Route::prefix('/foo')->group(function () {
Route::get('/')->breadcrumbGroup('Foo group index');
Route::get('/bar')->breadcrumb('Your custom title');
});
```
#### Custom title resolver
If you want to customize your breadcrumb title, you could pass a closure to all breadcrumb methods.
```php
Route::get('/')->breadcrumb(function () {
return 'Your custom title';
});
```
You could also pass a fully qualified class name. This will invoke your class.
```php
Route::get('/')->breadcrumb(YourCustomTitleResolver::class);
class YourCustomTitleResolver
{
public function __invoke()
{
return 'Your custom title';
}
}
```
You may also pass a callable.
```php
Route::get('/foo/{id}')->breadcrumb([app('my_breadcrumb_resolver'), 'resolve']);
// my_breadcrumb_resolver
class MyBreadcrumbResolver
{
public function resolve($id)
{
$title = $this->repo->findById($id);
return $title->getName();
}
}
```
##### Route parameters
All route parameters will be passed to your resolver. Route model binding is also supported.
```php
Route::get('/{foo}')->breadcrumb(YourCustomTitleResolver::class);
class YourCustomTitleResolver
{
public function __invoke(Foo $foo)
{
return "Title: {$foo->title}";
}
}
```
### Accessing breadcrumb
#### Links
The `links` method will return a `Collection` of `BreadcrumbLink`.
> Note: The array is indexed by the uri.
```php
app(Breadcrumb::class)->links(); // or use here the facade
```
Example result:
```php
Illuminate\Support\Collection {#266
#items: array:2 [
"/" => Fragkp\LaravelRouteBreadcrumb\BreadcrumbLink {#41
+uri: "/"
+title: "Start"
}
"foo" => Fragkp\LaravelRouteBreadcrumb\BreadcrumbLink {#262
+uri: "foo"
+title: "Your custom title"
}
]
}
```
#### Index
The `index` method will return a single instance of `BreadcrumbLink`. If you haven't defined any index, null is returned.
```php
app(Breadcrumb::class)->index(); // or use here the facade
```
Example result:
```php
Fragkp\LaravelRouteBreadcrumb\BreadcrumbLink {#36
+uri: "/"
+title: "Start"
}
```
#### Current
The `current` method will return a single instance of `BreadcrumbLink`. If no route is provided (e.g. on errors), null is returned.
```php
app(Breadcrumb::class)->current(); // or use here the facade
```
Example result:
```php
Fragkp\LaravelRouteBreadcrumb\BreadcrumbLink {#36
+uri: "/"
+title: "Your custom title"
}
```
#### View example
A good way to access the breadcrumb inside your views is to bound it via a View Composer.
> For more information about View Composers, have a look at the [Laravel docs](https://laravel.com/docs/5.6/views#view-composers).
```php
// app/Providers/AppServiceProvider.php
class AppServiceProvider extends ServiceProvider
{
public function boot()
{
View::composer('your-view', function ($view) {
$view->with('breadcrumb', app(Breadcrumb::class)->links());
});
}
}
```
```php
// resources/views/breadcrumb.blade.php
-
{{ $link->title }}
@foreach ($breadcrumb as $link)
@endforeach
```
## Testing
``` bash
./vendor/bin/phpunit
```
## License
MIT License (MIT). Please see [License File](LICENSE.md) for more information.