Refactor breadcrumb

data/structures/breadcrumb.yml

@@ -0,0 +1,16 @@
+comment: Displays a breadcrumb for a specific page.
+arguments:
+  page:
+    type:
+      - '*hugolib.pageState'
+      - '*hugolib.pageForShortcode'
+    optional: false
+    comment: Page to display the breadcrumb for.
+    group: partial
+  path:
+    type: string
+    optional: true
+    comment: Path of the page to display the breadcrumb for.
+    group: shortcode
+
+

layouts/_default/list.html

@@ -11,7 +11,7 @@
     <div class="container-xxl p-4 px-xxl-0">
         {{- if ne $layout "featured" -}}
             {{ if and (not $page.IsHome) site.Params.navigation.breadcrumb }}
-                <div>{{ partial "assets/breadcrumb.html" $page }}</div>
+                <div>{{ partial "assets/breadcrumb.html" (dict "page" $page) }}</div>
             {{ end -}}
         {{- end -}}
 

layouts/_default/single.html

@@ -1,6 +1,6 @@
 {{- define "partials/single-main.html" -}}
     {{- $breakpoint := $.Scratch.Get "breakpoint" -}}
-    {{ if .Site.Params.navigation.breadcrumb }}{{ partial "assets/breadcrumb.html" . }}{{ end -}}
+    {{ if .Site.Params.navigation.breadcrumb }}{{ partial "assets/breadcrumb.html" (dict "page" .) }}{{ end -}}
 
     {{ .Render "single/header" }}
 

layouts/partials/assets/breadcrumb.html

@@ -1,6 +1,24 @@
+<!-- 
+    Copyright © 2023 The Hinode Team / Mark Dumay. All rights reserved.
+    Use of this source code is governed by The MIT License (MIT) that can be found in the LICENSE file.
+    Visit gethinode.com/license for more details.
+-->
+
+{{ $error := false }}
+
+<!-- Validate arguments -->
+{{ if partial "utilities/IsInvalidArgs.html" (dict "structure" "breadcrumb" "args" . "group" "partial") }}
+    {{ errorf "Invalid arguments: %s" .Position -}}
+    {{ $error = true }}
+{{ end }}
+
+<!-- Initialize arguments -->
+{{ $page := .page }}
+
+<!-- Main code -->
 <nav aria-label="breadcrumb">
     <ol class="breadcrumb">
-        {{- range $index, $item := .Page.Ancestors.Reverse -}}
+        {{- range $index, $item := $page.Ancestors.Reverse -}}
             {{- $title := .LinkTitle -}}
             {{- if .IsHome }}{{ $title = T "home" }}{{ end -}} 
             {{- $address := or .RelPermalink (.Params.Redirect | relLangURL) -}}
@@ -10,6 +28,6 @@
                 <li class="breadcrumb-item">{{ $title }}</li>
             {{ end }}
         {{- end -}}
-        <li class="breadcrumb-item active" aria-current="page">{{ .Page.LinkTitle }}</li>
+        <li class="breadcrumb-item active" aria-current="page">{{ $page.LinkTitle }}</li>
     </ol>
 </nav>

layouts/partials/list/featured.html

@@ -64,7 +64,7 @@
 <div class="container-fluid p-0 {{ with site.Params.home.feature.color }} bg-{{ . }} bg-opacity-{{ site.Params.style.themeOpacity | default "25" | safeHTML }}{{ end }}">
     <div class="container-xxl p-4 px-xxl-0 {{ if site.Params.home.fullCover }} fullcover{{ end }} d-flex flex-column">
         {{ if $breadcrumb }}
-            <div>{{ partial "assets/breadcrumb.html" $page }}</div>
+            <div>{{ partial "assets/breadcrumb.html" (dict "page" $page) }}</div>
         {{ end -}}
 
         {{ if eq $orientation "stacked" }}

layouts/partials/utilities/IsInvalidArgs.html

@@ -35,6 +35,8 @@
     {{ end }}
 {{ end }}
 
+{{ $group := .group }}
+
 {{ $namedArgs := true }}
 
 {{ if not $error }}
@@ -111,7 +113,13 @@
     {{ $max := len $args }}
     {{ $expected := 0 }}
     {{ range $key, $val := $definitions }}
-        {{ if not $val.optional }}
+        {{ $skip := false }}
+        {{ $groups := slice | append $val.group }}
+        {{ if and $group $val.group }}
+            {{ $skip = not (in $groups $group )}}
+        {{ end }}
+
+        {{ if and (not $skip) (not $val.optional) }}
             {{ if $namedArgs }}
                 {{ if not (isset $args $key) }}
                     {{ warnf "[%s] argument '%s': expected value" $structure $key }}

layouts/shortcodes/breadcrumb.html

@@ -1,11 +1,20 @@
 <!-- 
-    Displays a breadcrum for a specific page. The shortcode supports the following arguments:
-    "path"          Optional path of the page, defaults to current page.
+    Copyright © 2023 The Hinode Team / Mark Dumay. All rights reserved.
+    Use of this source code is governed by The MIT License (MIT) that can be found in the LICENSE file.
+    Visit gethinode.com/license for more details.
 -->
 
-{{- $error := false -}}
+{{ $error := false }}
+
+<!-- Validate arguments -->
+{{ if partial "utilities/IsInvalidArgs.html" (dict "structure" "breadcrumb" "args" .Params "group" "shortcode") }}
+    {{ errorf "Invalid arguments: %s" .Position -}}
+    {{ $error = true }}
+{{ end }}
+
+<!-- Initialize arguments -->
 {{- $page := . -}}
-{{- $path := .Get "path" | default "" }}
+{{- $path := .Get "path" }}
 {{- if $path -}}
     {{- $page = .Site.GetPage $path -}}
     {{- if not $page -}}
@@ -14,6 +23,7 @@
     {{- end -}}
 {{- end -}}
 
+<!-- Main code -->
 {{- if not $error -}}
-    {{- partial "assets/breadcrumb.html" $page -}} 
+    {{- partial "assets/breadcrumb.html" (dict "page" $page) -}} 
 {{- end -}}

layouts/tags/list.html

@@ -10,7 +10,7 @@
             <div class="col col-{{ $breakpoint.prev }}-12 col-{{ $breakpoint.current }}-8">
                 {{- if ne $layout "featured" -}}
                     {{ if and (not $page.IsHome) site.Params.navigation.breadcrumb }}
-                        <div>{{ partial "assets/breadcrumb.html" $page }}</div>
+                        <div>{{ partial "assets/breadcrumb.html" (dict "page" $page) }}</div>
                     {{ end -}}
                 {{- end -}}