step2dev/lazy-breadcrumb

A simple, convenient, and flexible package for generating breadcrumbs in Laravel — minimal code, maximum flexibility, and automation.

dev-main 2025-08-02 12:30 UTC

Requires

• php: ^8.1
• illuminate/contracts: ^v10.17.1|^v11.0|^12.0
• spatie/laravel-package-tools: ^1.16

Requires (Dev)

• larastan/larastan: ^2.9||^3.0
• laravel/pint: ^1.14
• nunomaduro/collision: ^8.1.1||^7.10.0
• orchestra/testbench: ^10.0.0||^9.0.0||^8.22.0
• pestphp/pest: ^2.0||^3.0
• pestphp/pest-plugin-arch: ^2.0||^3.0
• pestphp/pest-plugin-laravel: ^2.0||^3.0
• phpstan/extension-installer: ^1.3||^2.0
• phpstan/phpstan-deprecation-rules: ^1.1||^2.0
• phpstan/phpstan-phpunit: ^1.3||^2.0

MIT

• CrazyBoy49z

• breadcrumbs
• navigation
• laravel
• Step2Dev
• lazy-breadcrumbs
• navigation-path

README

A modern, developer-first breadcrumb generator for Laravel with Blade components, SEO-ready JSON-LD, Artisan tooling, and flexible DSL/macros.

🚀 Installation

composer require step2dev/lazy-breadcrumb

Optional: Publish config and views

php artisan vendor:publish --tag=lazy-breadcrumb-config
php artisan vendor:publish --tag=lazy-breadcrumb-views

✨ Features

• Breadcrumbs::for() API
• Blade components (<x-breadcrumbs />, <x-breadcrumbs-json-ld />)
• Auto-title support: $trail->model($model)
• Custom push: $trail->push('Title', 'url')
• Replacing last item: $trail->replaceLast('New Title')
• Copy parent trail: $trail->import([...])
• Macro support: Breadcrumbs::macro('key', fn ($trail) => ...)
• SEO-ready: JSON-LD output for search engines
• Auto-discovery: optional route:breadcrumbs:sync
• Full Artisan tooling

📌 Defining Breadcrumbs

Create a routes/breadcrumbs.php file:

use Step2dev\LazyBreadcrumb\Breadcrumbs;
use Step2dev\LazyBreadcrumb\Breadcrumbs\Trail;

Breadcrumbs::for('dashboard', function (Trail $trail) {
    $trail->push(__('Dashboard'), route('dashboard'));
});

Breadcrumbs::for('profile', function (Trail $trail) {
    $trail->push(__('Dashboard'), route('dashboard'))
          ->push(__('Profile'), route('profile'));
});

You can also use:

$trail->model($user); // Auto title from $user->name, title, or slug
$trail->replaceLast('Editing');
$trail->import([...]); // Reuse a parent breadcrumb

🧩 Blade Components

Use directly in any view:

<x-breadcrumbs />
<x-breadcrumbs-json-ld /> {{-- SEO only --}}

To customize the view, publish and modify resources/views/components/breadcrumbs.blade.php.

🧪 Artisan Commands

Command	Description
make:breadcrumb name	Add breadcrumb entry to routes/breadcrumbs.php
breadcrumbs:list	List all route-to-breadcrumb matches
breadcrumbs:list --missing	Show named routes without breadcrumbs
breadcrumbs:test	Run tests against all definitions
route:breadcrumbs:sync	Autogenerate missing breadcrumb stubs

🧠 View Sharing

To make breadcrumbs available globally:

// Middleware registration
\Step2dev\LazyBreadcrumb\Middleware\ShareBreadcrumbs::class

Then in views:

@foreach ($breadcrumbs as $crumb)
    <a href="{{ $crumb['url'] }}">{{ $crumb['title'] }}</a>
@endforeach

📦 Preset (Optional)

Register the service provider:

\Step2dev\LazyBreadcrumb\LazyBreadcrumbPresetServiceProvider::class

Then run:

php artisan preset lazy-breadcrumb

🧪 Testing

composer test

📝 License

MIT