mirror of https://github.com/theNewDynamic/gohugo-theme-ananke.git

Patrick Kollitsch
13 hours ago d0a424ee5cd2cc31a76261127880c40b51a865a4
feat(layouts): restructure header navigation for hooks and class params

Give every navigation element a stable `ananke-nav-*` or `ananke-submenu*` hook class. Its Tachyons classes are now defaults that `[params.ananke.navigation.classes]` replaces per element (nav, inner, brand, toggle, panel, menu, item, link, submenu_toggle, submenu, submenu_link). Defaults match the previous classes, so flat menus on large screens look the same.

Add a menu button (hidden until JavaScript runs) and wrap languages, menu, and social links in a collapsible panel. Add the `navigation-start` hook after the brand link, for example for a search box, and the `navigation-end` hook at the end of the panel. Submenus get compact Tachyons defaults: `br2`, a `b--white-20` border, and `hover-bg-white-10` rows.
2 files modified
121 ■■■■■ changed files
config/_default/params.toml 16 ●●●●● patch | view | raw | blame | history
layouts/_partials/site-navigation.html 105 ●●●●● patch | view | raw | blame | history
config/_default/params.toml
@@ -6,6 +6,22 @@
[ananke.home]
content_alignment = "center" # options: left, center, right
# Tachyons classes for the header navigation (layouts/_partials/site-navigation.html).
# An empty value uses the theme default shown in the comment. A value replaces the
# default classes of that element; its `ananke-nav-*` hook class always stays.
[ananke.navigation.classes]
nav = "" # <nav>: "pv3 ph3 ph4-ns"
inner = "" # row inside <nav>: "flex flex-wrap items-center justify-between center"
brand = "" # site title or logo link: "f3 fw2 hover-white white-90 dib no-underline"
toggle = "" # menu button below the -l breakpoint: "f5 white-90 hover-white"
panel = "" # collapsible panel with menu, languages, and social links: "flex-l items-center"
menu = "" # main menu <ul>: "pl0 mr3" ("pr0 ml3" for right-to-left)
item = "" # main menu <li>: "list f5 f4-ns fw4 dib pr3" ("pl3" for right-to-left)
link = "" # main menu link: "hover-white white-90 no-underline"
submenu_toggle = "" # submenu button: "hover-white white-90"
submenu = "" # submenu <ul>: "list ma0 pv2 ph0 br2 ba b--white-20" plus background_color_class
submenu_link = "" # submenu link: "db pv2 ph3 f5 white-90 hover-white hover-bg-white-10 no-underline"
[ananke.social]
icon_path = "ananke/socials/%s.svg"
layouts/_partials/site-navigation.html
@@ -1,4 +1,48 @@
{{- /*
  Site header navigation.
  Every element has a stable `ananke-nav-*` or `ananke-submenu*` hook class
  for custom CSS. The Tachyons classes next to it are defaults; replace them
  per element with `[params.ananke.navigation.classes]`. Collapsing (below the
  Tachyons `-l` breakpoint) and the dropdown position are in _styles.css.
  Hooks: `navigation-start` renders after the brand link (for example a search
  box), `navigation-end` renders at the end of the collapsible panel.
  Without JavaScript, the menu and all submenus are visible and the toggle
  buttons stay hidden. site-scripts.html enhances both.
*/ -}}
{{- /* Returns the classes for each navigation element: configured or default. */ -}}
{{- define "_partials/AnankeNavigationClasses.html" -}}
  {{- $rtl := compare.Eq site.Language.Direction "rtl" -}}
  {{- $background := site.Params.background_color_class | compare.Default "bg-black" -}}
  {{- $defaults := collections.Dictionary
    "nav" "pv3 ph3 ph4-ns"
    "inner" "flex flex-wrap items-center justify-between center"
    "brand" "f3 fw2 hover-white white-90 dib no-underline"
    "toggle" "f5 white-90 hover-white"
    "panel" "flex-l items-center"
    "menu" (compare.Conditional $rtl "pr0 ml3" "pl0 mr3")
    "item" (printf "list f5 f4-ns fw4 dib %s" (compare.Conditional $rtl "pl3" "pr3"))
    "link" "hover-white white-90 no-underline"
    "submenu_toggle" "hover-white white-90"
    "submenu" (printf "list ma0 pv2 ph0 br2 ba b--white-20 %s" $background)
    "submenu_link" "db pv2 ph3 f5 white-90 hover-white hover-bg-white-10 no-underline"
  -}}
  {{- $configured := collections.Dictionary -}}
  {{- with site.Params.ananke.navigation -}}
    {{- with .classes -}}{{- $configured = . -}}{{- end -}}
  {{- end -}}
  {{- $classes := collections.Dictionary -}}
  {{- range $key, $default := $defaults -}}
    {{- $value := collections.Index $configured $key | compare.Default $default -}}
    {{- $classes = collections.Merge $classes (collections.Dictionary $key $value) -}}
  {{- end -}}
  {{- return $classes -}}
{{- end -}}
{{- /*
  Returns the aria-current value for a menu entry: "page" if it links to the
  current page, "true" if the current page is below it (Hugo's HasMenuCurrent,
  which includes pages inside the entry's section), or an empty string.
@@ -14,80 +58,97 @@
{{- end -}}
{{- define "_partials/AnankeSubmenuIcon.html" -}}
<svg class="ananke-submenu-icon" aria-hidden="true" focusable="false" width="12" height="12" viewBox="0 0 12 12"><path d="M2 4.5l4 4 4-4" fill="none" stroke="currentColor" stroke-width="1.5"/></svg>
<svg class="ananke-submenu-icon" aria-hidden="true" focusable="false" width="12" height="12" viewBox="0 0 12 12"><path d="M2 4.5l4 4 4-4" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"/></svg>
{{- end -}}
{{- define "_partials/AnankeMenuToggleIcon.html" -}}
<svg class="ananke-nav-toggle-icon" aria-hidden="true" focusable="false" width="20" height="20" viewBox="0 0 20 20" fill="none" stroke="currentColor" stroke-width="1.75" stroke-linecap="round"><path class="ananke-nav-toggle-line" d="M3 5h14"/><path class="ananke-nav-toggle-line" d="M3 10h14"/><path class="ananke-nav-toggle-line" d="M3 15h14"/></svg>
{{- end -}}
{{- define "_partials/AnankeSubmenu.html" -}}
{{- $page := .page }}
<ul {{ with .id }}id="{{ . }}" class="ananke-submenu list pa0 ma0 {{ $page.Site.Params.background_color_class | compare.Default "bg-black" }}"{{ else }}class="ananke-submenu-nested list ma0"{{ end }}>
{{- $classes := .classes }}
<ul {{ with .id }}id="{{ . }}" class="ananke-submenu {{ $classes.submenu }}"{{ else }}class="ananke-submenu-nested list ma0 pa0"{{ end }}>
  {{- range .entries }}
  {{- $current := partials.Include "AnankeMenuCurrent.html" (dict "page" $page "entry" .) }}
  <li class="ananke-submenu-item">
    {{- if .URL }}
    <a class="hover-white white-90 no-underline" href="{{ .URL }}" title="{{ lang.Translate "pageTitle" . }}"{{ with $current }} aria-current="{{ . }}"{{ end }}>{{ .Name }}</a>
    <a class="ananke-submenu-link {{ $classes.submenu_link }}" href="{{ .URL }}" title="{{ lang.Translate "pageTitle" . }}"{{ with $current }} aria-current="{{ . }}"{{ end }}>{{ .Name }}</a>
    {{- else }}
    <span class="white-90">{{ .Name }}</span>
    <span class="ananke-submenu-link {{ $classes.submenu_link }}">{{ .Name }}</span>
    {{- end }}
    {{- with .Children }}
    {{ partials.Include "AnankeSubmenu.html" (dict "page" $page "entries" .) }}
    {{ partials.Include "AnankeSubmenu.html" (dict "page" $page "entries" . "classes" $classes) }}
    {{- end }}
  </li>
  {{- end }}
</ul>
{{- end -}}
<nav class="pv3 ph3 ph4-ns" role="navigation">
  <div class="flex-l center items-center justify-between">
    <a href="{{ .Site.Home.RelPermalink }}" class="f3 fw2 hover-white white-90 dib no-underline">
{{- $classes := partials.Include "AnankeNavigationClasses.html" . -}}
<nav class="ananke-nav {{ $classes.nav }}" role="navigation">
  <div class="ananke-nav-inner {{ $classes.inner }}">
    <a href="{{ .Site.Home.RelPermalink }}" class="ananke-nav-brand {{ $classes.brand }}">
      {{ with .Site.Params.site_logo }}
        <img src="{{ urls.RelURL . }}" class="w100 mw5-ns" alt="{{ $.Site.Title }}" />
      {{ else }}
        {{ .Site.Title }}
      {{ end }}
    </a>
    <div class="flex-l items-center">
    {{- with partials.Include "hook.html" (dict "hook" "navigation-start" "context" .) | strings.TrimSpace }}
    <div class="ananke-nav-slot">{{ . | safeHTML }}</div>
    {{- end }}
    {{- if .Site.Menus.main }}
    <button type="button" class="ananke-nav-toggle {{ $classes.toggle }}" aria-expanded="false" aria-controls="ananke-nav-panel" hidden>
      {{- partials.Include "AnankeMenuToggleIcon.html" -}}
      <span class="ananke-nav-toggle-label">{{ lang.Translate "menuToggle" }}</span>
    </button>
    {{- end }}
    <div id="ananke-nav-panel" class="ananke-nav-panel {{ $classes.panel }}">
      {{ partials.Include "i18nlist.html" . }}
      {{ if .Site.Menus.main }}
        <ul class="{{ compare.Conditional (compare.Eq $.Site.Language.Direction "rtl") "pr0 ml3" "pl0 mr3" }}">
        <ul class="ananke-nav-menu {{ $classes.menu }}">
          {{ range $index, $entry := .Site.Menus.main }}
          {{- $current := partials.Include "AnankeMenuCurrent.html" (dict "page" $ "entry" $entry) -}}
          {{- if not $entry.HasChildren }}
          <li class="list f5 f4-ns fw4 dib {{ compare.Conditional (compare.Eq $.Site.Language.Direction "rtl") "pl3" "pr3" }}">
            <a class="hover-white white-90 no-underline" href="{{ .URL }}" title="{{ lang.Translate "pageTitle" . }}"{{ with $current }} aria-current="{{ . }}"{{ end }}>
          <li class="ananke-nav-item {{ $classes.item }}">
            <a class="ananke-nav-link {{ $classes.link }}" href="{{ .URL }}" title="{{ lang.Translate "pageTitle" . }}"{{ with $current }} aria-current="{{ . }}"{{ end }}>
              {{ .Name }}
            </a>
          </li>
          {{- else }}
          {{- /*
            A parent entry with children. The child list is always in the
            markup, so it stays reachable without JavaScript. The toggle button
            is hidden until site-scripts.html reveals it and collapses the list.
            Entries below the second level render as nested lists inside the
            submenu, without their own toggle.
            markup, so it stays reachable without JavaScript. Entries below the
            second level render as nested lists inside the submenu, without
            their own toggle.
          */}}
          {{- $submenu_id := printf "ananke-submenu-%d" $index }}
          <li class="list f5 f4-ns fw4 dib {{ compare.Conditional (compare.Eq $.Site.Language.Direction "rtl") "pl3" "pr3" }} ananke-has-submenu">
          <li class="ananke-nav-item ananke-has-submenu {{ $classes.item }}">
            {{- if .URL }}
            <a class="hover-white white-90 no-underline" href="{{ .URL }}" title="{{ lang.Translate "pageTitle" . }}"{{ with $current }} aria-current="{{ . }}"{{ end }}>
            <a class="ananke-nav-link {{ $classes.link }}" href="{{ .URL }}" title="{{ lang.Translate "pageTitle" . }}"{{ with $current }} aria-current="{{ . }}"{{ end }}>
              {{ .Name }}
            </a>
            <button type="button" class="ananke-submenu-toggle hover-white white-90" aria-expanded="false" aria-controls="{{ $submenu_id }}" hidden>
            <button type="button" class="ananke-submenu-toggle {{ $classes.submenu_toggle }}" aria-expanded="false" aria-controls="{{ $submenu_id }}" hidden>
              <span class="clip">{{ lang.Translate "submenuToggle" . | compare.Default .Name }}</span>
              {{- partials.Include "AnankeSubmenuIcon.html" }}
            </button>
            {{- else }}
            <span class="white-90 ananke-submenu-label">{{ .Name }}</span>
            <button type="button" class="ananke-submenu-toggle hover-white white-90" aria-expanded="false" aria-controls="{{ $submenu_id }}"{{ with $current }} aria-current="{{ . }}"{{ end }} hidden>
            <span class="ananke-submenu-label {{ $classes.link }}">{{ .Name }}</span>
            <button type="button" class="ananke-submenu-toggle {{ $classes.submenu_toggle }}" aria-expanded="false" aria-controls="{{ $submenu_id }}"{{ with $current }} aria-current="{{ . }}"{{ end }} hidden>
              {{ .Name }}
              {{- partials.Include "AnankeSubmenuIcon.html" }}
            </button>
            {{- end }}
            {{ partials.Include "AnankeSubmenu.html" (dict "page" $ "entries" .Children "id" $submenu_id) }}
            {{ partials.Include "AnankeSubmenu.html" (dict "page" $ "entries" .Children "id" $submenu_id "classes" $classes) }}
          </li>
          {{- end }}
          {{ end }}
        </ul>
      {{ end }}
      {{ partials.IncludeCached "social/follow.html" . }}
      {{- with partials.Include "hook.html" (dict "hook" "navigation-end" "context" .) | strings.TrimSpace }}
      <div class="ananke-nav-end">{{ . | safeHTML }}</div>
      {{- end }}
    </div>
  </div>
</nav>