From aea92352856b003ec957a5b26e623b2236c0af0e Mon Sep 17 00:00:00 2001
From: Attila Greguss <attila.greguss@netduma.com>
Date: Mon, 16 Dec 2024 17:58:47 +0000
Subject: [PATCH] Add support for custom footer

---
 .../content/docs/advanced/customization.md    | 21 +++++++++++++++++
 layouts/partials/footer.html                  | 23 +++++++++++++------
 2 files changed, 37 insertions(+), 7 deletions(-)

diff --git a/exampleSite/content/docs/advanced/customization.md b/exampleSite/content/docs/advanced/customization.md
index 5c37b79..e37ee07 100644
--- a/exampleSite/content/docs/advanced/customization.md
+++ b/exampleSite/content/docs/advanced/customization.md
@@ -62,6 +62,27 @@ You may add custom scripts to the end of the head for every page by adding the f
 layouts/partials/custom/head-end.html
 ```
 
+## Custom Footer
+
+You can replace the footer completely - excluding the language and theme buttons - by creating a file `layouts/partials/custom/footer.html` in your site __and__ setting `custom: true` in the `footer` section of your `hugo.yaml`:
+
+```yaml {filename="hugo.yaml"}
+ footer:
+    enable: true
+    custom: true
+    # These settings are ignored by the custom footer
+    displayCopyright: false
+    displayPoweredBy: true
+    # This setting is respected by the custom footer
+    with: "wide"
+```
+
+Variables available in the footer are:
+
+- `{{ .footerButtonColor }}` - The color/background color of a footer button
+
+_Note: The custom footer inherits the default footer background color and text color._
+
 ## Custom Layouts
 
 The layouts of the theme can be overridden by creating a file with the same name in the `layouts` directory of your site.
diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html
index 61cbb11..7e79443 100644
--- a/layouts/partials/footer.html
+++ b/layouts/partials/footer.html
@@ -24,14 +24,23 @@
       <hr class="dark:hx-border-neutral-800" />
     {{- end -}}
   {{- end -}}
-  <div
-    class="{{ $footerWidth }} hx-mx-auto hx-flex hx-justify-center hx-py-12 hx-pl-[max(env(safe-area-inset-left),1.5rem)] hx-pr-[max(env(safe-area-inset-right),1.5rem)] hx-text-gray-600 dark:hx-text-gray-400 md:hx-justify-start"
-  >
-    <div class="hx-flex hx-w-full hx-flex-col hx-items-center sm:hx-items-start">
-      {{- if (.Site.Params.footer.displayPoweredBy | default true) }}<div class="hx-font-semibold">{{ template "theme-credit" $poweredBy }}</div>{{ end }}
-      {{- if .Site.Params.footer.displayCopyright }}<div class="hx-mt-6 hx-text-xs">{{ $copyright | markdownify }}</div>{{ end }}
+
+  {{- if .Site.Params.footer.custom -}}
+    <div
+      class="{{ $footerWidth }} hx-pl-[max(env(safe-area-inset-left),0rem)] hx-pr-[max(env(safe-area-inset-right),0rem)] hx-text-gray-600 dark:hx-text-gray-400"
+    >
+      {{ partial "custom/footer.html" (dict "context" . "footerButtonColor" "hx-rounded-md hx-transition-colors hover:hx-bg-gray-100 hover:hx-text-gray-900 dark:hover:hx-bg-primary-100/5 dark:hover:hx-text-gray-50" ) }}
     </div>
-  </div>
+  {{- else -}}
+    <div
+      class="{{ $footerWidth }} hx-mx-auto hx-flex hx-justify-center hx-py-12 hx-pl-[max(env(safe-area-inset-left),1.5rem)] hx-pr-[max(env(safe-area-inset-right),1.5rem)] hx-text-gray-600 dark:hx-text-gray-400 md:hx-justify-start"
+    >
+      <div class="hx-flex hx-w-full hx-flex-col hx-items-center sm:hx-items-start">
+          {{- if (.Site.Params.footer.displayPoweredBy | default true) }}<div class="hx-font-semibold">{{ template "theme-credit" $poweredBy }}</div>{{ end }}
+          {{- if .Site.Params.footer.displayCopyright }}<div class="hx-mt-6 hx-text-xs">{{ $copyright | markdownify }}</div>{{ end }}
+      </div>
+    </div>
+  {{- end -}}
 </footer>
 
 {{- define "theme-credit" -}}