lamalamaNL / laravel-breadcrumbs

SEO proof breadcrumbs for Laravel

Laravel Breadcrumbs

⚠️ This package is in a preliminary development phase and not stable: Do not use in production!

Create SEO proof breadcrumbs.

Install

Via Composer

$ composer require lamalama/laravel-breadcrumbs

You can optionally publish the config file with:

php artisan vendor:publish --provider="LamaLama\Breadcrumbs\BreadcrumbsServiceProvider" --tag="config"

Use

You can use the Breadcrumbs::trail() method to set the trail for the breadcrumbs of the specific page.

Breadcrumbs::trail([
    'Work' => '/work',
    'Commerce' => '/work/commerce',
    'Sneaker District' => '/work/commerce/sneaker-district'
]);

You can use the Breadcrumbs::generate() method to render the html in your Blade templates.

{!! Breadcrumbs::generate() !!}

You can check if breadcrumbs exists in order to render a specific partial on your page.

@if(Breadcrumbs::exists())
    <section>
        {!! Breadcrumbs::generate() !!}
    </section>
@endif

Based on props given in the Controller the package generates SEO proof html containing microdata to support rich results.

<ol itemscope itemtype="https://schema.org/BreadcrumbList">
  <li itemprop="itemListElement" itemscope
      itemtype="https://schema.org/ListItem">
    <a itemprop="item" href="https://lamalama.nl/work">
        <span itemprop="name">Work</span></a>
    <meta itemprop="position" content="1" />
  </li>
  <li>›</li>
  <li itemprop="itemListElement" itemscope
      itemtype="https://schema.org/ListItem">
    <a itemscope itemtype="https://schema.org/WebPage"
       itemprop="item" itemid="https://lamalama.nl/work/commerce"
       href="https://lamalama.nl/work/commerce">
      <span itemprop="name">Commerce</span></a>
    <meta itemprop="position" content="2" />
  </li>
  <li>›</li>
  <li itemprop="itemListElement" itemscope
      itemtype="https://schema.org/ListItem">
    <span itemprop="name">Sneaker District</span>
    <meta itemprop="position" content="3" />
  </li>
</ol>

Change log

Please see CHANGELOG for more information on what has changed recently.

Credits

• Lama Lama
• Mark de Vries

License

The MIT License (MIT). Please see License File for more information.