Skip to content
Breadcrumbs for Laravel Nova
Vue JavaScript PHP CSS Shell
Branch: master
Clone or download

README.md

Nova Breadcrumbs

Breadcrumbs for Laravel Nova

Latest Stable Version Total Downloads License StyleCI

Current Supported Nova Version: 2.4.0

As new versions of Nova are released, if changes are made to any of the views that this package has to overwrite, a new version will need to be released. Composer version constraints should prevent installs on versions that aren't supported.

IMPORTANT
This is a work-in-progress package and is liable to change. Advised not to use in production environments unless you know what you are doing and have complete faith in the code working.

Installation

You can install the package in to a Laravel app that uses Nova via composer:

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.

// in app/Providers/NovaServiceProvder.php

// ...
public function tools()
{
    return [
        // ...
        \ChrisWare\NovaBreadcrumbs\NovaBreadcrumbs::make(),
    ];
}

Finally, add the Breadcrumbs trait to your App\Nova\Resource class.

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:

// 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.

Information

This package works on the following views:

  • Dashboard
  • Index
  • Detail
  • Create
  • Update
  • Attach
  • UpdateAttached

The Detail view makes use of of the custom header components that are currently available in the core Laravel Nova views. There are 2 new custom Vue components that are introduced for extensibility, for this view. They are custom-detail-pre-breadcrumbs and custom-detail-post-breadcrumbs.

The remaining views are hooked via an overwrite to the routes, forcing them to use custom extended views.

This package will work with either numeric IDs or UUIDs, whichever is set up as the ID field for your Models.

Screenshots

Screenshots can be seen here.

Contributors

@gaabora - Solved the duplicating API calls issue. Major thanks.

You can’t perform that action at this time.