Skip to content

Persist sidebar scroll position #2044

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
huanlin wants to merge 6 commits into
base: main
Choose a base branch
from
+24 −9
Open

Persist sidebar scroll position #2044

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
76f58b7
Update zh-tw.toml
huanlin Aug 13, 2023
7aebde9
Merge pull request #1 from huanlin/huanlin-patch-zh-tw
huanlin Aug 13, 2023
062cebb
Merge branch 'main' into main
chalin Nov 13, 2023
77d82bc
Merge branch 'google:main' into main
huanlin Jul 2, 2024
a276a3b
Update sidebar.html to persist the sidebar scroll position.
huanlin Jul 2, 2024
949d621
Merge branch 'main' into persist-sidebar-scroll-position
huanlin Aug 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 24 additions & 9 deletions layouts/partials/sidebar.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
<script>
/* Persist the scroll position of the section menu. See Docsy issue #257. */
function persistScrollPosition() {
var a = document.querySelector("#td-section-nav");
addEventListener("beforeunload", function() {
localStorage.setItem("menu.scrollTop", a.scrollTop)
});
a.scrollTop = localStorage.getItem("menu.scrollTop");
}
</script>

{{/* The "active" toggle here may delay rendering, so we only cache this side bar menu for bigger sites. */ -}}
{{ $sidebarCacheLimit := .Site.Params.ui.sidebar_cache_limit | default 2000 -}}
{{ $shouldCache := ge (len .Site.Pages) $sidebarCacheLimit -}}
Expand All @@ -6,18 +17,22 @@
{{ $mid := printf "m-%s" (.RelPermalink | anchorize) }}
<script>
$(function() {
$("#td-section-nav a").removeClass("active");
$("#td-section-nav #{{ $mid }}").addClass("active");
$("#td-section-nav #{{ $mid }}-li span").addClass("td-sidebar-nav-active-item");
$("#td-section-nav #{{ $mid }}").parents("li").addClass("active-path");
$("#td-section-nav li.active-path").addClass("show");
$("#td-section-nav li.active-path").children("input").prop('checked', true);
$("#td-section-nav #{{ $mid }}-li").siblings("li").addClass("show");
$("#td-section-nav #{{ $mid }}-li").children("ul").children("li").addClass("show");
$("#td-sidebar-menu").toggleClass("d-none");
$("#td-section-nav a").removeClass("active");
$("#td-section-nav #{{ $mid }}").addClass("active");
$("#td-section-nav #{{ $mid }}-li span").addClass("td-sidebar-nav-active-item");
$("#td-section-nav #{{ $mid }}").parents("li").addClass("active-path");
$("#td-section-nav li.active-path").addClass("show");
$("#td-section-nav li.active-path").children("input").prop('checked', true);
$("#td-section-nav #{{ $mid }}-li").siblings("li").addClass("show");
$("#td-section-nav #{{ $mid }}-li").children("ul").children("li").addClass("show");
$("#td-sidebar-menu").toggleClass("d-none");
persistScrollPosition();
});
</script>
{{ partialCached "sidebar-tree.html" . .FirstSection.RelPermalink }}
{{ else -}}
{{ partial "sidebar-tree.html" . }}
<script>
persistScrollPosition();
</script>
{{- end }}