Skip to content

fix: improve underlining in "On this page" #1312

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

fix: improve underlining in "On this page" #1312

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
722be43
Remove no-longer-needed :global
zqianem Apr 18, 2025
85ecbb2
Make anchor underlines react better to clicks
zqianem Apr 18, 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
37 changes: 23 additions & 14 deletions apps/svelte.dev/src/routes/docs/[topic]/[...path]/OnThisPage.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,28 @@

let headings: NodeListOf<HTMLHeadingElement>;
let current = $state('');
let locked = $state(false);

afterNavigate(() => {
current = location.hash.slice(1);
headings = content.querySelectorAll('h2');
update(); // Ensure active link is set correctly on navigation
for (const heading of headings) {
const anchor = heading.querySelector('a');
if (anchor) anchor.onclick = onclick;
}
onclick();
});

// Update function to activate the correct section link
function update() {
function onclick() {
current = location.hash.slice(1);
// avoid onscroll handler from inaccurately updating
locked = true;
setTimeout(() => (locked = false), 100);
}

function onscroll() {
if (locked) return;

const threshold = (innerHeight * 1) / 3;
let found = false;

for (let i = 0; i < headings.length; i++) {
const heading = headings[i];
Expand All @@ -28,19 +39,18 @@
(!next || next.getBoundingClientRect().top > threshold)
) {
current = heading.id;
found = true;
break;
}
}

// Handle case when scrolled to the top of the page
if (!found && scrollY === 0) {
if (scrollY === 0) {
current = '';
}
}
</script>

<svelte:window onscroll={update} onhashchange={() => (current = location.hash.slice(1))} />
<svelte:window {onscroll} onhashchange={onclick} />

<aside class="on-this-page">
<label>
Expand All @@ -51,14 +61,15 @@
<nav>
<ul>
<li>
<a href="/{document.slug}" class:active={current === ''}>
<a href="/{document.slug}" class:active={current === ''} {onclick}>
{document.metadata.title}
</a>
</li>

{#each document.sections as section}
<li>
<a href="#{section.slug}" class:active={current === section.slug}>{@html section.title}</a
<a href="#{section.slug}" class:active={current === section.slug} {onclick}
>{@html section.title}</a
>
</li>
{/each}
Expand Down Expand Up @@ -89,8 +100,7 @@
@media (max-width: 1199px) {
margin: 4rem 0;

/* TODO remove :global once https://github.com/sveltejs/svelte/issues/13779 is fixed */
:global(&:not(:has(li:nth-child(2)))) {
&:not(:has(li:nth-child(2))) {
/* hide widget if there are no subheadings */
display: none;
}
Expand Down Expand Up @@ -165,8 +175,7 @@
rotate: 90deg;
}

/* TODO remove :global once https://github.com/sveltejs/svelte/issues/13779 is fixed */
:global(& + nav) {
& + nav {
display: block;
}
}
Expand Down