https://github.com/chris-ware/nova-breadcrumbs
Breadcrumbs for Laravel Nova
https://github.com/chris-ware/nova-breadcrumbs
hacktoberfest
Last synced: 6 months ago
JSON representation
Breadcrumbs for Laravel Nova
- Host: GitHub
- URL: https://github.com/chris-ware/nova-breadcrumbs
- Owner: chris-ware
- Archived: true
- Created: 2018-12-04T14:11:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-04-26T15:55:49.000Z (about 4 years ago)
- Last Synced: 2025-11-27T14:47:23.307Z (8 months ago)
- Topics: hacktoberfest
- Language: PHP
- Homepage:
- Size: 760 KB
- Stars: 151
- Watchers: 11
- Forks: 44
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Nova Breadcrumbs
Breadcrumbs for Laravel Nova
[](https://packagist.org/packages/chris-ware/nova-breadcrumbs)
[](ttps://packagist.org/packages/chris-ware/nova-breadcrumbs)
[](https://packagist.org/packages/chris-ware/nova-breadcrumbs)
[](https://github.styleci.io/repos/160367785)
## Installation
You can install the package in to a Laravel app that uses [Nova](https://nova.laravel.com) via composer:
```bash
composer require chris-ware/nova-breadcrumbs
```
Next, you must register the tool with Nova. This is typically done in the `tools` method of the `NovaServiceProvider`.
```php
// in app/Providers/NovaServiceProvder.php
// ...
public function tools()
{
return [
// ...
\ChrisWare\NovaBreadcrumbs\NovaBreadcrumbs::make(),
];
}
```
Finally, add the Breadcrumbs trait to your App\Nova\Resource class.
```php
use ChrisWare\NovaBreadcrumbs\Traits\Breadcrumbs;
abstract class Resource extends NovaResource
{
use Breadcrumbs;
```
## Customisation
You can disable the bundled styles and load your own by adding the following method to the call:
```php
// in app/Providers/NovaServiceProvder.php
// ...
public function tools()
{
return [
// ...
\ChrisWare\NovaBreadcrumbs\NovaBreadcrumbs::make()->withoutStyles(),
];
}
```
You can also customise both the label and title for a Resource. Label refers to the Resource's Name, so a Users Resource would have a Users label. Title refers to the title of the Resource as set by the $title property on the resource, so by default it would be the resource ID. Both of these can be overwritten for Breadcrumbs only by overwriting the functions on the trait that start with breadcrumb.
You can also conditionally disable breadcrumbs, using the static breadcrumbs method presented in the trait.
## Information
This package works using the custom header elements available on all Nova views. Due to the fact that the data available to these views differ, the rendering of breadcrumbs is API powered, to ensure that for all views, the necessary data is available and displayed.
## Screenshots
Screenshots can be seen [here](screenshots.md).