finished views; class implements Stringable;

Author: RyanNutt

composer.json

@@ -56,12 +56,9 @@
         "laravel": {
             "providers": [
                 "Aelora\\Breadcrumbs\\BreadcrumbsServiceProvider"
-            ],
-            "aliases": {
-                "Breadcrumbs": "Aelora\\Breadcrumbs\\Facades\\Breadcrumbs"
-            }
+            ]
         }
     },
     "minimum-stability": "dev",
     "prefer-stable": true
-}
+}

config/breadcrumbs.php

@@ -1,5 +1,26 @@
 <?php
-// config for Aelora/Breadcrumbs
 return [
+    'home' => [
 
+        // Should the home link be automatically included in the breadcrumbs? You can also manually include
+        // or exclude the home link when you build the breadcrumb class.
+        'include' => true,
+
+        'text' => 'Home',
+
+        'url' => url('/'),
+
+        'image' => '',
+    ],
+
+    // Which blade template to use. Currently only tailwind is supported. 
+    'theme' => 'tailwind',
+
+    // View to use to generate the HTML breadcrumbs. If defined, this will
+    // override the theme above.
+    'view' => '',
+
+    // Character to use as a separator between crumbs. Use and encoded entity
+    // if you want something like > 
+    'separator' => '/',
 ];

resources/views/breadcrumbs-tailwind.blade.php

@@ -0,0 +1,17 @@
+{{-- @see https://tailwind-elements.com/docs/standard/navigation/breadcrumbs/ --}}
+<nav class="rounded-md w-full">
+    <ol class="list-none flex">
+        @foreach ($crumbs as $crumb)
+            @if (!empty($crumb['url']))
+                <li>
+                    <a href="{{ $crumb['url'] }}" class="text-blue-600 hover:text-blue-700">{{ $crumb['title'] }}</a>
+                </li>
+            @else
+                <li class="text-gray-500">{{ $crumb['title'] }}</li>
+            @endif
+            @if (!$loop->last)
+                <li><span class="text-gray-500 mx-2">{{ config('breadcrumbs.separator', '/') }}</span></li>
+            @endif
+        @endforeach
+    </ol>
+</nav>

resources/views/jsonld.blade.php

@@ -0,0 +1,8 @@
+{{-- View partial for the breadcrumb schema --}}
+@if (count($crumbs) < 1)
+    <!-- no breadcrumbs defined -->
+@else
+    <script type="application/ld+json">
+        @json($jsonld)
+    </script>
+@endif

src/Breadcrumbs.php

@@ -2,6 +2,124 @@
 
 namespace Aelora\Breadcrumbs;
 
-class Breadcrumbs
+use Stringable;
+
+class Breadcrumbs implements Stringable
 {
+    private array $crumbs = [];
+    private $home = [];
+
+    public function __construct()
+    {
+        if (config('breadcrumbs.home.include', true)) {
+            $this->home = [
+                'title' => config('breadcrumbs.home.text', ''),
+                'url' => config('breadcrumbs.home.url', ''),
+                'image' => config('breadcrumbs.home.image', ''),
+            ];
+        } else {
+            $this->home = false;
+        }
+    }
+
+    public static function create(): self
+    {
+        return new self();
+    }
+
+    public function add(string $title, string $url = '', string $image = ''): self
+    {
+        $this->crumbs[] = [
+            'title' => $title,
+            'url' => $url,
+            'image' => $image,
+        ];
+        return $this;
+    }
+
+    public function setHome($title, string $url = '', string $image = ''): self
+    {
+        if ($title === false) {
+            $this->home = false;
+        } else {
+            $this->home = [
+                'title' => $title,
+                'url' => $url,
+                'image' => $image,
+            ];
+        }
+        return $this;
+    }
+
+    public function reverse(): self
+    {
+        $this->crumbs = array_reverse($this->crumbs);
+        return $this;
+    }
+
+    public function reset(): self
+    {
+        $this->crumbs = [];
+        return $this;
+    }
+
+    public function count(): int
+    {
+        return count($this->crumbs);
+    }
+
+    /**
+     * Returns the generated blade templates for the breadcrumbs, optionally
+     * echoing it out as well.
+     */
+    public function generate(bool $echo = false): string
+    {
+        $out = '';
+        if (is_array($this->home) && config('breadcrumbs.home.include', true)) {
+            array_unshift($this->crumbs, $this->home);
+        }
+
+        $view = config('breadcrumbs.view', '');
+        if (empty($view)) {
+            $theme = strtolower(config('breadcrumbs.theme', 'tailwind'));
+            $view = 'breadcrumbs::breadcrumbs-' . $theme;
+        }
+
+        $out .= view($view, ['crumbs' => $this->crumbs])->render();
+
+        $itemList = [];
+        foreach ($this->crumbs as $idx => $crumb) {
+            $item = [];
+            if (!empty($crumb['url'])) {
+                $item['@id'] = $crumb['url'];
+            }
+            if (!empty($crumb['title'])) {
+                $item['name'] = $crumb['title'];
+            }
+            if (!empty($crumb['image'])) {
+                $item['image'] = $crumb['image'];
+            }
+            $listItem = [
+                '@type' => 'ListItem',
+                'position' => $idx + 1,
+                'item' => $item,
+            ];
+            $itemList[] = $listItem;
+        }
+
+        $jsonld = [
+            '@context' => 'https://schema.org',
+            '@type' => 'BreadcrumbList',
+            'itemListElement' => $itemList,
+        ];
+
+        $out .= view('breadcrumbs::jsonld', ['jsonld' => $jsonld, 'crumbs' => $this->crumbs])->render();
+
+        return $out;
+    }
+
+    public function __toString(): string
+    {
+        return $this->generate(false);
+    }
 }