Mirrors/mdBook
2
0
Fork 0
mirror of https://github.com/rust-lang/mdBook synced 2024-12-13 22:32:35 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #2473 from notriddle/notriddle/folding

Browse source 
Fix inadvertently broken folding behavior
This commit is contained in:
Eric Huss 2024-11-07 14:39:31 +00:00 committed by GitHub
commit c6236ead67
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 66 additions and 61 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
src/theme/book.js
View file

@ -463,17 +463,6 @@ function playground_text(playground, hidden = true) {
try { localStorage.setItem('mdbook-sidebar', 'visible'); } catch (e) { } try { localStorage.setItem('mdbook-sidebar', 'visible'); } catch (e) { }
} }
var sidebarAnchorToggles = document.querySelectorAll('#sidebar a.toggle');
function toggleSection(ev) {
ev.currentTarget.parentElement.classList.toggle('expanded');
}
Array.from(sidebarAnchorToggles).forEach(function (el) {
el.addEventListener('click', toggleSection);
});
function hideSidebar() { function hideSidebar() {
body.classList.remove('sidebar-visible') body.classList.remove('sidebar-visible')
body.classList.add('sidebar-hidden'); body.classList.add('sidebar-hidden');

14
src/theme/index.hbs
View file

@ -52,15 +52,17 @@
<!-- MathJax --> <!-- MathJax -->
<script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> <script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
{{/if}} {{/if}}
</head>
<body>
<div id="body-container">
<!-- Provide site root to javascript --> <!-- Provide site root to javascript -->
<script> <script>
var path_to_root = "{{ path_to_root }}"; var path_to_root = "{{ path_to_root }}";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "{{ preferred_dark_theme }}" : "{{ default_theme }}"; var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "{{ preferred_dark_theme }}" : "{{ default_theme }}";
</script> </script>
<!-- Start loading toc.js asap -->
<script src="{{ path_to_root }}toc.js"></script>
</head>
<body>
<div id="body-container">
<!-- Work around some values being stored in localStorage wrapped in quotes --> <!-- Work around some values being stored in localStorage wrapped in quotes -->
<script> <script>
try { try {
@ -107,7 +109,7 @@
<nav id="sidebar" class="sidebar" aria-label="Table of contents"> <nav id="sidebar" class="sidebar" aria-label="Table of contents">
<!-- populated by js --> <!-- populated by js -->
<div class="sidebar-scrollbox"></div> <mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
<noscript> <noscript>
<iframe class="sidebar-iframe-outer" src="{{ path_to_root }}toc.html"></iframe> <iframe class="sidebar-iframe-outer" src="{{ path_to_root }}toc.html"></iframe>
</noscript> </noscript>
@ -116,8 +118,6 @@
</div> </div>
</nav> </nav>
<script async src="{{ path_to_root }}toc.js"></script>
<div id="page-wrapper" class="page-wrapper"> <div id="page-wrapper" class="page-wrapper">
<div class="page"> <div class="page">

46
src/theme/toc.js.hbs
View file

@ -3,14 +3,18 @@
// This is a script, and not included directly in the page, to control the total size of the book. // This is a script, and not included directly in the page, to control the total size of the book.
// The TOC contains an entry for each page, so if each page includes a copy of the TOC, // The TOC contains an entry for each page, so if each page includes a copy of the TOC,
// the total size of the page becomes O(n**2). // the total size of the page becomes O(n**2).
var sidebarScrollbox = document.querySelector("#sidebar .sidebar-scrollbox"); class MDBookSidebarScrollbox extends HTMLElement {
sidebarScrollbox.innerHTML = '{{#toc}}{{/toc}}'; constructor() {
(function() { super();
}
connectedCallback() {
this.innerHTML = '{{#toc}}{{/toc}}';
// Set the current, active page, and reveal it if it's hidden
let current_page = document.location.href.toString(); let current_page = document.location.href.toString();
if (current_page.endsWith("/")) { if (current_page.endsWith("/")) {
current_page += "index.html"; current_page += "index.html";
} }
var links = sidebarScrollbox.querySelectorAll("a"); var links = Array.prototype.slice.call(this.querySelectorAll("a"));
var l = links.length; var l = links.length;
for (var i = 0; i < l; ++i) { for (var i = 0; i < l; ++i) {
var link = links[i]; var link = links[i];
@ -22,6 +26,9 @@ sidebarScrollbox.innerHTML = '{{#toc}}{{/toc}}';
if (link.href === current_page || (i === 0 && path_to_root === "" && current_page.endsWith("/index.html"))) { if (link.href === current_page || (i === 0 && path_to_root === "" && current_page.endsWith("/index.html"))) {
link.classList.add("active"); link.classList.add("active");
var parent = link.parentElement; var parent = link.parentElement;
if (parent && parent.classList.contains("chapter-item")) {
parent.classList.add("expanded");
}
while (parent) { while (parent) {
if (parent.tagName === "LI" && parent.previousElementSibling) { if (parent.tagName === "LI" && parent.previousElementSibling) {
if (parent.previousElementSibling.classList.contains("chapter-item")) { if (parent.previousElementSibling.classList.contains("chapter-item")) {
@ -32,23 +39,32 @@ sidebarScrollbox.innerHTML = '{{#toc}}{{/toc}}';
} }
} }
} }
})(); // Track and set sidebar scroll position
this.addEventListener('click', function(e) {
// Track and set sidebar scroll position
sidebarScrollbox.addEventListener('click', function(e) {
if (e.target.tagName === 'A') { if (e.target.tagName === 'A') {
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop); sessionStorage.setItem('sidebar-scroll', this.scrollTop);
} }
}, { passive: true }); }, { passive: true });
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll'); var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
sessionStorage.removeItem('sidebar-scroll'); sessionStorage.removeItem('sidebar-scroll');
if (sidebarScrollTop) { if (sidebarScrollTop) {
// preserve sidebar scroll position when navigating via links within sidebar // preserve sidebar scroll position when navigating via links within sidebar
sidebarScrollbox.scrollTop = sidebarScrollTop; this.scrollTop = sidebarScrollTop;
} else { } else {
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons // scroll sidebar to current active section when navigating via "next/previous chapter" buttons
var activeSection = document.querySelector('#sidebar .active'); var activeSection = document.querySelector('#sidebar .active');
if (activeSection) { if (activeSection) {
activeSection.scrollIntoView({ block: 'center' }); activeSection.scrollIntoView({ block: 'center' });
} }
}
// Toggle buttons
var sidebarAnchorToggles = document.querySelectorAll('#sidebar a.toggle');
function toggleSection(ev) {
ev.currentTarget.parentElement.classList.toggle('expanded');
}
Array.from(sidebarAnchorToggles).forEach(function (el) {
el.addEventListener('click', toggleSection);
});
}
} }
window.customElements.define("mdbook-sidebar-scrollbox", MDBookSidebarScrollbox);

2
tests/rendered_output.rs
View file

@ -243,7 +243,7 @@ fn toc_js_html() -> Result<Document> {
let toc_path = temp.path().join("book").join("toc.js"); let toc_path = temp.path().join("book").join("toc.js");
let html = fs::read_to_string(toc_path).with_context(|| "Unable to read index.html")?; let html = fs::read_to_string(toc_path).with_context(|| "Unable to read index.html")?;
for line in html.lines() { for line in html.lines() {
if let Some(left) = line.strip_prefix("sidebarScrollbox.innerHTML = '") { if let Some(left) = line.strip_prefix(" this.innerHTML = '") {
if let Some(html) = left.strip_suffix("';") { if let Some(html) = left.strip_suffix("';") {
return Ok(Document::from(html)); return Ok(Document::from(html));
} }