hiiicomtw/breadcrumb-for-laravel

There is no license information available for the latest version (dev-master) of this package.

A simple breadcrumb for laravel.

Installs: 4 828

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 0

Open Issues: 0

pkg:composer/hiiicomtw/breadcrumb-for-laravel

dev-master 2018-09-11 02:47 UTC

This package is auto-updated.

Last update: 2025-12-08 12:38:06 UTC


README

A simple breadcrumb for laravel.

Installation

composer require hiiicomtw/breadcrumb-for-laravel:dev-master

Configuration

config/app.php

providers:

Hiiicomtw\Breadcrumb\BreadcrumbServiceProvider::class

aliases:

'Breadcrumb' => Hiiicomtw\Breadcrumb\BreadcrumbFacade::class

config/breadcrumb.php

You can change the "default-template" key by value 'breadcrumb::template''breadcrumb::sample' or 'breadcrumb::backend'

php artisan vendor:publish
return [
    'breadcrumb-file-path' => app_path('Http/breadcrumb.php'),
    'default-template' => 'breadcrumb::template',
    'ignore-undefined-breadcrumb' => false
];

views/vendor/breadcrumb

You can edit the views where in "resources/views/vendor"

Base Usage

  1. Create the breadcrumb file in the "breadcrumb-file-path".

  2. Define breadcrumbs in the breadcrumb file.

    Without parameters:

    // Home
    Breadcrumb::define('home', function ($breadcrumb) {
        $breadcrumb->add('Home', action('HomeController@index'));
    });

    With a parameter:

    // Home > $category->title
    Breadcrumb::define('category', function ($breadcrumb, $category) {
        $breadcrumb->add('Home', action('HomeController@index'));
        $breadcrumb->add($category->title, $category->url);
    });

    With parameters:

    // Home > $category['title'] > $content->title
    Breadcrumb::define('content', function ($breadcrumb, $category, $content) {
        $breadcrumb->add('Home', action('HomeController@index'));
        $breadcrumb->add($category['title'], $category['id']);
        $breadcrumb->add($content->title, $content->url);
    });
  3. Render breadcrumbs.

    Without parameters:

    {!! Breadcrumbs::render('home') !!}

    With a parameter:

    {!! Breadcrumbs::render('home', $category) !!}

    With parameters:

    {!! Breadcrumbs::render('home', $category, $content) !!}

Advanced Usage

  1. The breadcrumb use the special template.blade.php in resources/views.

    {!! Breadcrumbs::setTemplate('path/to/view')->render('home') !!}