Merge pull request #978 from gethinode/develop

Publish v0.24.0 release

assets/js/critical/color.js

@@ -9,44 +9,49 @@
 (() => {
   'use strict'
 
+  const supportedThemes = ['auto', 'dark', 'light'];
+
+  // retrieves the currently stored theme from local storage (cookie)
   const storedTheme = localStorage.getItem('theme')
 
-  const getPreferredTheme = () => {
+  // retrieves the theme preferred by the client, defaults to light
-    if (storedTheme) {
+  function getPreferredTheme() {
-      return storedTheme
-    }
-
     return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light'
   }
 
-  const setTheme = function (theme) {
+  // retrieves the current theme, either from local storage or client's preferences
-    if (theme === 'auto') {
+  function getTheme() {
-      document.documentElement.setAttribute('data-bs-theme', (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light'))
+    if (storedTheme) {
+      return storedTheme
     } else {
-      document.documentElement.setAttribute('data-bs-theme', theme)
+      const preference = getPreferredTheme()
+      localStorage.setItem('theme', preference)
+      return preference
     }
   }
 
-  setTheme(getPreferredTheme())
+  // applies and stores requested theme
-
+  function setTheme(theme) {
-  const showActiveTheme = theme => {
+    if (!supportedThemes.includes(theme)) {
-    const activeSelectors = document.querySelectorAll('.theme-icon-active')
+      theme = 'auto'
-    const activeButtons = document.querySelectorAll(`[data-bs-theme-value="${theme}"]`)
-    if (activeButtons.length > 0) {
-      const activeIcon = activeButtons[0].querySelector('span')
-
-      document.querySelectorAll('[data-bs-theme-value]').forEach(element => {
-        element.classList.remove('active')
-      })
-
-      for (let i = 0; i < activeSelectors.length; ++i) {
-        activeSelectors[i].innerHTML = activeIcon.innerHTML
-      }
-
-      for (let i = 0; i < activeButtons.length; ++i) {
-        activeButtons[i].classList.add('active')
-      }
     }
+    localStorage.setItem('theme', theme)
+
+    if (theme === 'auto') {
+      document.documentElement.setAttribute('data-bs-theme', (getPreferredTheme()))
+    } else {
+      document.documentElement.setAttribute('data-bs-theme', theme)
+    }
+
+    document.querySelectorAll('.navbar-mode-selector').forEach(chk => {
+      chk.checked = (document.documentElement.getAttribute('data-bs-theme') === 'light')
+    })
+  }
+
+  // alternates the currently active theme
+  function toggleTheme() {
+    const target = document.documentElement.getAttribute('data-bs-theme') === 'dark' ? 'light' : 'dark'
+    setTheme(target)
   }
 
   window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', () => {
@@ -56,18 +61,32 @@
   })
 
   window.addEventListener('DOMContentLoaded', () => {
-    showActiveTheme(getPreferredTheme())
+    setTheme(getTheme())
+    const light = (document.documentElement.getAttribute('data-bs-theme') === 'light')
 
-    document.querySelectorAll('[data-bs-theme-value]')
+    document.querySelectorAll('.ball').forEach(ball => {
-      .forEach(toggle => {
+      ball.classList.add('notransition');
-        toggle.addEventListener('click', () => {
+    })
-          const theme = toggle.getAttribute('data-bs-theme-value')
+    
-          localStorage.setItem('theme', theme)
+    document.querySelectorAll('.navbar-mode-selector').forEach(chk => {
-          setTheme(theme)
+      chk.checked = light
-          showActiveTheme(theme)
+      chk.addEventListener('change', function () {
-        })
+        toggleTheme()
       })
+    })
+
+    document.querySelectorAll('.ball').forEach(ball => {
+      ball.offsetHeight; // flush css changes
+      ball.classList.remove('notransition');
+    })
   })
+
+  window.addEventListener('load', () => {
+    const light = (document.documentElement.getAttribute('data-bs-theme') === 'light')
+    document.querySelectorAll('.navbar-mode-selector').forEach(chk => {
+      chk.checked = light
+    })
+  });  
 })()
 
 {{- end -}}

assets/scss/common/_styles.scss

@@ -1,3 +1,9 @@
+@if $enable-dark-mode {
+    body { 
+        transition: background-color 0.5s, color 0.5s; 
+    }
+}
+
 //
 // Remove underline from all links
 //

assets/scss/components/_navbar.scss

@@ -1,8 +1,6 @@
 // stylelint-disable annotation-no-unknown
 
 // Source: https://jsfiddle.net/njhgr40m/
-
-
 .navbar {
     --bs-navbar-expanded-color: var(--bs-body-bg);
     --bs-navbar-toggler-color: var(--bs-navbar-hover-color);
@@ -236,3 +234,61 @@
         }
     }
 }
+
+// adapted from https://www.codeply.com/p/UsTEwDkzNp#
+.checkbox {
+	opacity: 0;
+	position: absolute;
+}
+
+.mode-switch {
+    --#{$prefix}mode-switch-width: 50px;
+}
+
+.mode-switch .label {
+	border-color: var(--#{$prefix}border-color);
+    border-style: solid;
+    border-width: 1px;
+	border-radius: var(--#{$prefix}mode-switch-width);
+	cursor: pointer;
+	display: flex;
+	align-items: center;
+	justify-content: space-between;
+	padding: 5px;
+	position: relative;
+	height: calc(1px + var(--#{$prefix}mode-switch-width) / 2);
+	width: var(--#{$prefix}mode-switch-width);
+    transform: scale(0.9);
+}
+
+.notransition {
+    -webkit-transition: none !important;
+    -moz-transition: none !important;
+    -o-transition: none !important;
+    transition: none !important;
+}
+
+.mode-switch .label .ball {
+    background-color: var(--#{$prefix}secondary-bg);
+	border-radius: 50%;
+	position: absolute;
+	top: 2px;
+	left: 2px;
+	height: calc((var(--#{$prefix}mode-switch-width) / 2) - 5px);
+	width: calc((var(--#{$prefix}mode-switch-width) / 2) - 5px);
+	transition: transform 0.2s linear;
+}
+
+.mode-switch .checkbox:checked + .label .ball {
+	transform: translateX(calc((var(--#{$prefix}mode-switch-width) / 2) - 1px));
+}
+
+.mode-switch .fa-moon {
+	color: $yellow;
+    transform: scale(0.8);
+}
+
+.mode-switch .fa-sun {
+	color: var(--#{$prefix}bs-body-color);
+    transform: scale(0.8);
+}

data/structures/image.yml

@@ -137,4 +137,4 @@ arguments:
     comment:
       Flag to indicate if the image should render a plain image instead of an
       image set. When set, no transformations are applied to the image.
-    release: v0.24.0-beta5
+    release: v0.24.0

exampleSite/hugo_stats.json

@@ -22,6 +22,7 @@
       "i",
       "img",
       "input",
+      "label",
       "li",
       "link",
       "mark",
@@ -69,6 +70,7 @@
       "align-self-end",
       "anchor",
       "badge",
+      "ball",
       "bg-body",
       "bg-body-tertiary",
       "bg-danger",
@@ -123,6 +125,7 @@
       "carousel-indicators",
       "carousel-inner",
       "carousel-item",
+      "checkbox",
       "chroma",
       "col",
       "col-10",
@@ -188,7 +191,6 @@
       "fa-arrow-right",
       "fa-bootstrap",
       "fa-circle-check",
-      "fa-circle-half-stroke",
       "fa-code",
       "fa-docker",
       "fa-ellipsis",
@@ -257,6 +259,7 @@
       "justify-content-center",
       "justify-content-end",
       "justify-content-start",
+      "label",
       "lead",
       "leaflet-map",
       "link-bg-body",
@@ -278,6 +281,7 @@
       "me-auto",
       "middle-bar",
       "min-vh-100",
+      "mode-switch",
       "ms-1",
       "ms-3",
       "ms-auto",
@@ -309,6 +313,7 @@
       "navbar-contrast",
       "navbar-expand-md",
       "navbar-fixed-top",
+      "navbar-mode-selector",
       "navbar-nav",
       "navbar-nav-scroll",
       "navbar-title",
@@ -391,7 +396,6 @@
       "sticky-top",
       "stretched-link",
       "svg-inline--fa",
-      "switch-mode-collapsed",
       "syntax-highlight",
       "tab-content",
       "tab-pane",
@@ -419,8 +423,6 @@
       "text-sm-start",
       "text-start",
       "text-uppercase",
-      "theme-icon",
-      "theme-icon-active",
       "tickmark",
       "timeline",
       "timeline-bg-dark",
@@ -459,8 +461,6 @@
       "w-50"
     ],
     "ids": [
-      "-theme",
-      "-theme-collapsed",
       "TableOfContents",
       "abbr",
       "accordion",
@@ -532,6 +532,8 @@
       "nav-0-btn-2",
       "navbar",
       "navbar-0-collapse",
+      "navbar-mode",
+      "navbar-mode-checkbox",
       "navbar-sample-collapse",
       "navigation",
       "notification",

hugo_stats.json

@@ -11,6 +11,7 @@
       "html",
       "img",
       "input",
+      "label",
       "li",
       "link",
       "meta",
@@ -31,6 +32,7 @@
       "align-items-center",
       "align-self-center",
       "align-self-end",
+      "ball",
       "bg-body",
       "bg-opacity-10",
       "bg-primary",
@@ -41,6 +43,7 @@
       "btn",
       "btn-close",
       "btn-primary",
+      "checkbox",
       "col",
       "col-12",
       "col-6",
@@ -57,22 +60,15 @@
       "d-flex",
       "d-inline",
       "d-md-block",
-      "d-md-none",
       "d-none",
       "display-1",
       "display-4",
-      "dropdown",
-      "dropdown-item",
-      "dropdown-menu",
-      "dropdown-menu-end",
-      "dropdown-toggle",
       "emphasis",
       "end-0",
       "fa",
       "fa-10x",
       "fa-2x",
       "fa-book-open",
-      "fa-circle-half-stroke",
       "fa-ellipsis",
       "fa-face-frown",
       "fa-fw",
@@ -100,6 +96,7 @@
       "justify-content-center",
       "justify-content-end",
       "justify-content-start",
+      "label",
       "link-bg-footer",
       "link-secondary",
       "main-content",
@@ -107,6 +104,7 @@
       "me-auto",
       "middle-bar",
       "min-vh-100",
+      "mode-switch",
       "ms-auto",
       "ms-md-3",
       "mt-3",
@@ -123,6 +121,7 @@
       "navbar-container",
       "navbar-expand-md",
       "navbar-fixed-top",
+      "navbar-mode-selector",
       "navbar-nav",
       "navbar-toggler",
       "no-js",
@@ -156,15 +155,12 @@
       "search-suggestions",
       "shadow",
       "svg-inline--fa",
-      "switch-mode-collapsed",
       "text-center",
       "text-decoration-none",
       "text-muted",
       "text-secondary",
       "text-sm-start",
       "text-start",
-      "theme-icon",
-      "theme-icon-active",
       "toast",
       "toast-body",
       "toast-container",
@@ -173,9 +169,9 @@
       "top-bar"
     ],
     "ids": [
-      "-theme",
-      "-theme-collapsed",
       "navbar-0-collapse",
+      "navbar-mode",
+      "navbar-mode-checkbox",
       "toast-container",
       "toast-copied-code-message"
     ]

layouts/partials/assets/navbar.html

@@ -16,36 +16,16 @@
 
 <!-- Inline partial to render the color mode switcher -->
 {{- define "partials/navbar-mode.html" -}}
-    {{- $size := .size -}}
+    {{- $id := .id | default "navbar-mode" -}}
-    {{- $collapsed := .collapsed -}}
-    {{- $id := .id -}}
 
-    <li class="nav-item dropdown {{ if $collapsed }}d-{{ $size }}-none{{ else }}d-none d-{{ $size }}-block{{ end }}">
+    <div class="d-flex mode-switch align-items-center" id="{{ $id }}">
-        <a class="nav-link dropdown-toggle" href="#!" role="button" data-bs-toggle="dropdown" aria-label="{{ T "colorMode" }}" aria-expanded="false" id="{{ $id }}-theme{{ if $collapsed }}-collapsed{{ end }}">
+        <input type="checkbox" class="checkbox navbar-mode-selector" id="{{ $id }}-checkbox" />
-            <span class="theme-icon-active">{{- partial "assets/icon.html" (dict "icon" "fas sun fa-fw") }}</span>{{ if $collapsed }}&nbsp;{{ T "colorMode" }}{{ end }}
+        <label class="label" for="{{ $id }}-checkbox">
-            <span class="d-md-none"></span>
+            {{- partial "assets/icon.html" (dict "icon" "fas sun fa-fw" "spacing" false) }}
-        </a>
+            {{- partial "assets/icon.html" (dict "icon" "fas moon fa-fw" "spacing" false) }}
-        <ul class="dropdown-menu dropdown-menu-end" aria-labelledby="{{ $id }}-theme{{ if $collapsed }}-collapsed{{ end }}">
+            <div class="ball"></div>
-            <li>
+        </label>
-                <a class="dropdown-item{{ if $collapsed }} switch-mode-collapsed{{ end }}" data-bs-theme-value="light" href="#!">
+    </div>
-                    <span class="theme-icon">{{- partial "assets/icon.html" (dict "icon" "fas sun fa-fw" "spacing" false) }}</span>&nbsp;
-                    {{- T "colorLight" }}
-                </a>
-            </li>
-            <li>
-                <a class="dropdown-item{{ if $collapsed }} switch-mode-collapsed{{ end }}" data-bs-theme-value="dark" href="#!">
-                    <span class="theme-icon">{{- partial "assets/icon.html" (dict "icon" "fas moon fa-fw" "spacing" false) }}</span>&nbsp;
-                    {{- T "colorDark" }}
-                </a>
-            </li>
-            <li>
-                <a class="dropdown-item{{ if $collapsed }} switch-mode-collapsed{{ end }}" data-bs-theme-value="auto" href="#!">
-                    <span class="theme-icon">{{- partial "assets/icon.html" (dict "icon" "fas circle-half-stroke fa-fw" "spacing" false) }}</span>&nbsp;
-                    {{- T "colorAuto" }}
-                </a>
-            </li>
-        </ul>
-    </li>
 {{- end -}}
 
 <!-- Inline partial to render the version switcher -->
@@ -300,7 +280,6 @@
                     <!-- Insert color mode switcher -->
                     {{- if $enableDarkMode -}}
                         {{- partial "partials/navbar-mode.html" (dict "size" $size "collapsed" true "id" .id) -}}
-                        {{- partial "partials/navbar-mode.html" (dict "size" $size "collapsed" false "id" .id) -}}
                     {{- end -}}
 
                     <!-- Insert modal search button -->

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gethinode/hinode",
-  "version": "0.24.0-beta10",
+  "version": "0.24.0",
   "description": "Hinode is a clean documentation and blog theme for Hugo, an open-source static site generator",
   "keywords": [
     "hugo",
@@ -66,24 +66,26 @@
     "url": "https://github.com/gethinode/hinode/issues"
   },
   "homepage": "https://gethinode.com",
-  "devDependencies": {
+  "dependencies": {
     "@fullhuman/postcss-purgecss": "^6.0.0",
-    "@gethinode/netlify-plugin-dartsass": "^0.3.0",
-    "@netlify/plugin-lighthouse": "^6.0.0",
     "autoprefixer": "^10.4.19",
     "cssnano": "^7.0.1",
     "cssnano-preset-advanced": "^7.0.1",
+    "hugo-bin": "0.123.2",
+    "purgecss-whitelister": "^2.4.0"
+  },
+  "devDependencies": {
+    "@gethinode/netlify-plugin-dartsass": "^0.3.0",
+    "@netlify/plugin-lighthouse": "^6.0.0",
     "eslint": "^8.57.0",
     "eslint-config-standard": "^17.1.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-n": "^16.6.2",
     "eslint-plugin-promise": "^6.2.0",
-    "hugo-bin": "0.123.2",
     "markdownlint-cli2": "^0.13.0",
     "netlify-plugin-hugo-cache-resources": "^0.2.1",
     "npm-run-all": "^4.1.5",
     "postcss-cli": "^11.0.0",
-    "purgecss-whitelister": "^2.4.0",
     "replace-in-files-cli": "^2.2.0",
     "rimraf": "^5.0.7",
     "shx": "^0.3.4",