Skip to content

Restore sidebar scroll and folds on reload using sessionStorage (#679) #896

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Restore sidebar scroll and folds on reload using sessionStorage (#679) #896

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53cd677
Restore sidebar scroll and folds on reload using sessionStorage (#679)
b10902118 Aug 19, 2025
10ceea5
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Aug 19, 2025
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
50 changes: 50 additions & 0 deletions src/furo/assets/scripts/furo.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,55 @@ function scrollHandlerForTOC(positionY) {
}
}

function setupTOC() {
function loadFold() {
const states = JSON.parse(
sessionStorage.getItem("toc-fold-states") || "{}",
);
document.querySelectorAll("input.toctree-checkbox").forEach((cb) => {
if (states.hasOwnProperty(cb.id)) {
cb.checked = states[cb.id];
}
});
}
function saveFold() {
const states = {};
document.querySelectorAll("input.toctree-checkbox").forEach((cb) => {
states[cb.id] = cb.checked;
});
sessionStorage.setItem("toc-fold-states", JSON.stringify(states));
}

function loadScroll() {
var sidebar = document.querySelector(".sidebar-scroll");
if (!sidebar) return;

let storedScrollTop = parseInt(
sessionStorage.getItem("toc-scroll-top"),
10,
);

if (!isNaN(storedScrollTop)) {
sidebar.scrollTop = storedScrollTop;
}
}

function saveScroll() {
var sidebar = document.querySelector(".sidebar-scroll");
if (!sidebar) return;

sessionStorage.setItem("toc-scroll-top", sidebar.scrollTop);
}

loadFold();
loadScroll();

window.addEventListener("beforeunload", () => {
saveFold();
saveScroll();
});
}

function scrollHandler(positionY) {
scrollHandlerForHeader(positionY);
scrollHandlerForBackToTop(positionY);
Expand Down Expand Up @@ -159,6 +208,7 @@ function setup() {
setupTheme();
setupScrollHandler();
setupScrollSpy();
setupTOC();
}

////////////////////////////////////////////////////////////////////////////////
Expand Down