mirror of
https://github.com/imfing/hextra.git
synced 2025-10-31 08:54:51 -04:00
3bc454bbf6
* feat: Remove the main sidebar entirely to free up more space for the main content of the page * fix: ensure that the footer switches are still visible when the main sidebar has been disabled * refactor: Repurpose Params.sidebar.hide to disable the main sidebar and disable the placeholder rather than adding a new front matter parameter * fix: change wording from "disable" to "hide" in the documentation for hiding the sidebar * fix: using incorrect hidden class in sidebar.html broke mobile navigation. Fixed this --------- Co-authored-by: Xin <5097752+imfing@users.noreply.github.com>
189 lines
9.5 KiB
HTML
189 lines
9.5 KiB
HTML
{{- $context := .context -}}
|
|
|
|
{{- $disableSidebar := .disableSidebar | default false -}}
|
|
{{- $displayPlaceholder := .displayPlaceholder | default false -}}
|
|
|
|
{{- $navRoot := cond (eq site.Home.Type "docs") site.Home $context.FirstSection -}}
|
|
{{- $pageURL := $context.RelPermalink -}}
|
|
|
|
{{- if .context.Params.sidebar.hide -}}
|
|
{{- $disableSidebar = true -}}
|
|
{{- $displayPlaceholder = false -}}
|
|
{{- end -}}
|
|
|
|
{{- $sidebarClass := "hx:md:sticky" -}}
|
|
{{- if $disableSidebar -}}
|
|
{{- if $displayPlaceholder -}}
|
|
{{- $sidebarClass = "hx:md:hidden hx:xl:block" -}}
|
|
{{- else -}}
|
|
{{- $sidebarClass = "hx:md:hidden" -}}
|
|
{{- end -}}
|
|
{{- end -}}
|
|
|
|
<aside class="hextra-sidebar-container hx:flex hx:flex-col hx:print:hidden hx:md:top-16 hx:md:shrink-0 hx:md:w-64 hx:md:self-start hx:max-md:[transform:translate3d(0,-100%,0)] {{ $sidebarClass }}">
|
|
<!-- Search bar on small screen -->
|
|
<div class="hx:px-4 hx:pt-4 hx:md:hidden">
|
|
{{ partial "search.html" }}
|
|
</div>
|
|
<div class="hextra-scrollbar hx:overflow-y-auto hx:overflow-x-hidden hx:p-4 hx:grow hx:md:h-[calc(100vh-var(--navbar-height)-var(--menu-height))]">
|
|
<ul class="hx:flex hx:flex-col hx:gap-1 hx:md:hidden">
|
|
<!-- Nav -->
|
|
{{ template "sidebar-main" (dict "context" site.Home "pageURL" $pageURL "page" $context "toc" true) -}}
|
|
{{ template "sidebar-footer" }}
|
|
</ul>
|
|
|
|
<!-- Sidebar on large screen -->
|
|
{{- if $disableSidebar -}}
|
|
{{- if $displayPlaceholder }}<div class="hx:max-xl:hidden hx:h-0 hx:w-64 hx:shrink-0"></div>{{ end -}}
|
|
{{ .context.Store.Set "enableFooterSwitches" true }}
|
|
{{- else -}}
|
|
<ul class="hx:flex hx:flex-col hx:gap-1 hx:max-md:hidden">
|
|
{{ template "sidebar-main" (dict "context" $navRoot "page" $context "pageURL" $pageURL) }}
|
|
{{ template "sidebar-footer" }}
|
|
</ul>
|
|
{{ end -}}
|
|
</div>
|
|
{{/* Hide theme switch when sidebar is disabled */}}
|
|
{{ $switchesClass := cond $disableSidebar "hx:md:hidden" "" -}}
|
|
{{ $displayThemeToggle := (site.Params.theme.displayToggle | default true) -}}
|
|
|
|
{{ if or hugo.IsMultilingual $displayThemeToggle }}
|
|
<div class="{{ $switchesClass }} {{ with hugo.IsMultilingual }}hx:justify-end{{ end }} hx:sticky hx:bottom-0 hx:max-h-(--menu-height) hx:bg-white hx:dark:bg-dark hx:mx-4 hx:py-4 hx:shadow-[0_-12px_16px_#fff] hx:flex hx:items-center hx:gap-2 hx:border-gray-200 hx:dark:border-neutral-800 hx:dark:shadow-[0_-12px_16px_#111] hx:contrast-more:border-neutral-400 hx:contrast-more:shadow-none hx:contrast-more:dark:shadow-none hx:border-t" data-toggle-animation="show">
|
|
{{- with hugo.IsMultilingual -}}
|
|
{{- partial "language-switch" (dict "context" $context "grow" true) -}}
|
|
{{- with $displayThemeToggle }}{{ partial "theme-toggle" (dict "hideLabel" true "location" "bottom-right") }}{{ end -}}
|
|
{{- else -}}
|
|
{{- with $displayThemeToggle -}}
|
|
<div class="hx:flex hx:grow hx:flex-col">{{ partial "theme-toggle" }}</div>
|
|
{{- end -}}
|
|
{{- end -}}
|
|
</div>
|
|
{{- end -}}
|
|
</aside>
|
|
|
|
{{- define "sidebar-main" -}}
|
|
{{ template "sidebar-tree" (dict "context" .context "level" 0 "page" .page "pageURL" .pageURL "toc" (.toc | default false)) }}
|
|
{{- end -}}
|
|
|
|
{{- define "sidebar-tree" -}}
|
|
{{- if ge .level 4 -}}
|
|
{{- return -}}
|
|
{{- end -}}
|
|
|
|
{{- $context := .context -}}
|
|
{{- $page := .page }}
|
|
{{- $pageURL := .page.RelPermalink -}}
|
|
{{- $level := .level -}}
|
|
{{- $toc := .toc | default false -}}
|
|
|
|
{{- with $items := union .context.RegularPages .context.Sections -}}
|
|
{{- $items = where $items "Params.sidebar.exclude" "!=" true -}}
|
|
{{- if eq $level 0 -}}
|
|
{{- range $items.ByWeight }}
|
|
{{- if .Params.sidebar.separator -}}
|
|
<li class="[word-break:break-word] hx:mt-5 hx:mb-2 hx:px-2 hx:py-1.5 hx:text-sm hx:font-semibold hx:text-gray-900 hx:first:mt-0 hx:dark:text-gray-100">
|
|
<span class="hx:cursor-default">{{ partial "utils/title" . }}</span>
|
|
</li>
|
|
{{- else -}}
|
|
{{- $active := eq $pageURL .RelPermalink -}}
|
|
{{- $shouldOpen := or (.Params.sidebar.open) (.IsAncestor $page) $active | default true }}
|
|
<li class="{{ if $shouldOpen }}open{{ end }}">
|
|
{{- $linkTitle := partial "utils/title" . -}}
|
|
{{- template "sidebar-item-link" dict "context" . "active" $active "title" $linkTitle "link" .RelPermalink -}}
|
|
{{- if and $toc $active -}}
|
|
{{- template "sidebar-toc" dict "page" . -}}
|
|
{{- end -}}
|
|
{{- template "sidebar-tree" dict "context" . "page" $page "pageURL" $pageURL "level" (add $level 1) "toc" $toc -}}
|
|
</li>
|
|
{{- end -}}
|
|
{{- end -}}
|
|
{{- else -}}
|
|
<div class="hx:ltr:pr-0 hx:overflow-hidden">
|
|
<ul class='hx:relative hx:flex hx:flex-col hx:gap-1 hx:before:absolute hx:before:inset-y-1 hx:before:w-px hx:before:bg-gray-200 hx:before:content-[""] hx:ltr:ml-3 hx:ltr:pl-3 hx:ltr:before:left-0 hx:rtl:mr-3 hx:rtl:pr-3 hx:rtl:before:right-0 hx:dark:before:bg-neutral-800'>
|
|
{{- range $items.ByWeight }}
|
|
{{- $active := eq $pageURL .RelPermalink -}}
|
|
{{- $shouldOpen := or (.Params.sidebar.open) (.IsAncestor $page) $active | default true }}
|
|
{{- $linkTitle := partial "utils/title" . -}}
|
|
<li class="hx:flex hx:flex-col {{ if $shouldOpen }}open{{ end }}">
|
|
{{- template "sidebar-item-link" dict "context" . "active" $active "title" $linkTitle "link" .RelPermalink -}}
|
|
{{- if and $toc $active -}}
|
|
{{ template "sidebar-toc" dict "page" . }}
|
|
{{- end }}
|
|
{{ template "sidebar-tree" dict "context" . "page" $page "pageURL" $pageURL "level" (add $level 1) "toc" $toc }}
|
|
</li>
|
|
{{- end -}}
|
|
</ul>
|
|
</div>
|
|
{{- end -}}
|
|
{{- end }}
|
|
{{- end -}}
|
|
|
|
{{- define "sidebar-toc" -}}
|
|
{{ $page := .page }}
|
|
{{ with $page.Fragments.Headings }}
|
|
<ul class='hx:flex hx:flex-col hx:gap-1 hx:relative hx:before:absolute hx:before:inset-y-1 hx:before:w-px hx:before:bg-gray-200 hx:before:content-[""] hx:dark:before:bg-neutral-800 hx:ltr:pl-3 hx:ltr:before:left-0 hx:rtl:pr-3 hx:rtl:before:right-0 hx:ltr:ml-3 hx:rtl:mr-3'>
|
|
{{- range . }}
|
|
{{- with .Headings }}
|
|
{{- range . -}}
|
|
<li>
|
|
<a
|
|
href="#{{ anchorize .ID }}"
|
|
class="hx:flex hx:rounded-sm hx:px-2 hx:py-1.5 hx:text-sm hx:transition-colors [word-break:break-word] hx:cursor-pointer [-webkit-tap-highlight-color:transparent] [-webkit-touch-callout:none] hx:contrast-more:border hx:gap-2 hx:before:opacity-25 hx:before:content-['#'] hx:text-gray-500 hx:hover:bg-gray-100 hx:hover:text-gray-900 hx:dark:text-neutral-400 hx:dark:hover:bg-primary-100/5 hx:dark:hover:text-gray-50 hx:contrast-more:text-gray-900 hx:contrast-more:dark:text-gray-50 hx:contrast-more:border-transparent hx:contrast-more:hover:border-gray-900 hx:contrast-more:dark:hover:border-gray-50"
|
|
>
|
|
{{- .Title | safeHTML | plainify | htmlUnescape -}}
|
|
</a>
|
|
</li>
|
|
{{ end -}}
|
|
{{ end -}}
|
|
{{ end -}}
|
|
</ul>
|
|
{{ end }}
|
|
{{- end -}}
|
|
|
|
{{- define "sidebar-footer" -}}
|
|
{{- range site.Menus.sidebar -}}
|
|
{{- $name := or (T .Identifier) .Name -}}
|
|
{{ if eq .Params.type "separator" }}
|
|
<li class="[word-break:break-word] hx:mt-5 hx:mb-2 hx:px-2 hx:py-1.5 hx:text-sm hx:font-semibold hx:text-gray-900 hx:first:mt-0 hx:dark:text-gray-100">
|
|
<span class="hx:cursor-default">{{ $name }}</span>
|
|
</li>
|
|
{{ else }}
|
|
{{- $link := .URL -}}
|
|
{{- with .PageRef -}}
|
|
{{- if hasPrefix . "/" -}}
|
|
{{- $link = relLangURL (strings.TrimPrefix "/" .) -}}
|
|
{{- end -}}
|
|
{{- end -}}
|
|
<li>{{ template "sidebar-item-link" dict "active" false "title" $name "link" $link }}</li>
|
|
{{ end }}
|
|
{{- end -}}
|
|
{{- end -}}
|
|
|
|
{{- define "sidebar-item-link" -}}
|
|
{{- $external := strings.HasPrefix .link "http" -}}
|
|
{{- $open := .open | default true -}}
|
|
<a
|
|
class="hx:flex hx:items-center hx:justify-between hx:gap-2 hx:cursor-pointer hx:rounded-sm hx:px-2 hx:py-1.5 hx:text-sm hx:transition-colors [-webkit-tap-highlight-color:transparent] [-webkit-touch-callout:none] [word-break:break-word]
|
|
{{- if .active }}
|
|
hextra-sidebar-active-item hx:bg-primary-100 hx:font-semibold hx:text-primary-800 hx:contrast-more:border hx:contrast-more:border-primary-500 hx:dark:bg-primary-400/10 hx:dark:text-primary-600 hx:contrast-more:dark:border-primary-500
|
|
{{- else }}
|
|
hx:text-gray-500 hx:hover:bg-gray-100 hx:hover:text-gray-900 hx:contrast-more:border hx:contrast-more:border-transparent hx:contrast-more:text-gray-900 hx:contrast-more:hover:border-gray-900 hx:dark:text-neutral-400 hx:dark:hover:bg-primary-100/5 hx:dark:hover:text-gray-50 hx:contrast-more:dark:text-gray-50 hx:contrast-more:dark:hover:border-gray-50
|
|
{{- end -}}"
|
|
href="{{ .link }}"
|
|
{{ if $external }}target="_blank" rel="noreferrer"{{ end }}
|
|
>
|
|
{{- .title -}}
|
|
{{- with .context }}
|
|
{{- if or .RegularPages .Sections }}
|
|
<span class="hextra-sidebar-collapsible-button">
|
|
{{- template "sidebar-collapsible-button" -}}
|
|
</span>
|
|
{{- end }}
|
|
{{ end -}}
|
|
</a>
|
|
{{- end -}}
|
|
|
|
{{- define "sidebar-collapsible-button" -}}
|
|
<svg fill="none" viewBox="0 0 24 24" stroke="currentColor" class="hx:h-[18px] hx:min-w-[18px] hx:rounded-xs hx:p-0.5 hx:hover:bg-gray-800/5 hx:dark:hover:bg-gray-100/5"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9 5l7 7-7 7" class="hx:origin-center hx:transition-transform hx:rtl:-rotate-180"></path></svg>
|
|
{{- end -}}
|