Skip to content

Keep nav-v2 focused on the active section #3354

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

Merged
theletterf merged 4 commits into from
May 19, 2026
Merged

Keep nav-v2 focused on the active section #3354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5ab233b
Keep nav-v2 focused on the active section
theletterf May 19, 2026
acdfe6a
Auto-scroll nav-v2 to the active branch
theletterf May 19, 2026
174e219
Re-scroll nav-v2 after sidebar chrome resizes
theletterf May 19, 2026
cf3175e
Format nav-v2 scroll observer
theletterf May 19, 2026
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
187 changes: 187 additions & 0 deletions src/Elastic.Documentation.Site/Assets/pages-nav-v2.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
import { initNavV2 } from './pages-nav-v2'

jest.mock('tippy.js', () => ({
__esModule: true,
default: jest.fn(() => ({
destroy: jest.fn(),
setContent: jest.fn(),
})),
}))

function renderNav() {
document.body.innerHTML = `
<div class="pages-nav-menu">
<nav class="docs-sidebar-nav-v2" data-nav-v2>
<ul class="docs-sidebar-nav-v2__tree" id="nav-tree">
<li class="relative">
<span class="docs-sidebar-nav-v2__label docs-sidebar-nav-v2__label--top">Guides</span>
<ul class="docs-sidebar-nav-v2__label-children w-full">
<li class="flex flex-wrap group-navigation relative">
<div class="peer nav-folder-peer grid w-full grid-cols-1">
<input id="group-a" type="checkbox" checked />
<a href="/guide/a" class="sidebar-link nav-v2-link">Group A</a>
</div>
<div class="docs-sidebar-nav-v2__folder-clip w-full">
<div class="docs-sidebar-nav-v2__folder-clip-inner">
<ul class="docs-sidebar-nav-v2__folder-children w-full relative">
<li class="flex flex-wrap group-navigation relative">
<div class="peer nav-folder-peer grid w-full grid-cols-1">
<input id="group-a-1" type="checkbox" checked />
<a href="/guide/a/topic-1" class="sidebar-link nav-v2-link">Topic 1</a>
</div>
<div class="docs-sidebar-nav-v2__folder-clip w-full">
<div class="docs-sidebar-nav-v2__folder-clip-inner">
<ul class="docs-sidebar-nav-v2__folder-children w-full relative">
<li class="flex group/li">
<a href="/guide/a/topic-1/current-page" class="sidebar-link nav-v2-link">Current page</a>
</li>
</ul>
</div>
</div>
</li>
<li class="flex flex-wrap group-navigation relative">
<div class="peer nav-folder-peer grid w-full grid-cols-1">
<input id="group-a-2" type="checkbox" checked />
<a href="/guide/a/topic-2" class="sidebar-link nav-v2-link">Topic 2</a>
</div>
<div class="docs-sidebar-nav-v2__folder-clip w-full">
<div class="docs-sidebar-nav-v2__folder-clip-inner">
<ul class="docs-sidebar-nav-v2__folder-children w-full relative">
<li class="flex group/li">
<a href="/guide/a/topic-2/other-page" class="sidebar-link nav-v2-link">Other page</a>
</li>
</ul>
</div>
</div>
</li>
</ul>
</div>
</div>
</li>
<li class="flex flex-wrap group-navigation relative">
<div class="peer nav-folder-peer grid w-full grid-cols-1">
<input id="group-b" type="checkbox" checked />
<a href="/guide/b" class="sidebar-link nav-v2-link">Group B</a>
</div>
<div class="docs-sidebar-nav-v2__folder-clip w-full">
<div class="docs-sidebar-nav-v2__folder-clip-inner">
<ul class="docs-sidebar-nav-v2__folder-children w-full relative">
<li class="flex group/li">
<a href="/guide/b/page" class="sidebar-link nav-v2-link">Group B page</a>
</li>
</ul>
</div>
</div>
</li>
</ul>
</li>
</ul>
</nav>
</div>
`

return document.querySelector<HTMLElement>('[data-nav-v2]')!
}

function checkbox(id: string): HTMLInputElement {
return document.getElementById(id) as HTMLInputElement
}

function groupRow(id: string): HTMLElement {
return checkbox(id).closest('li.group-navigation') as HTMLElement
}

describe('initNavV2', () => {
const originalRequestAnimationFrame = window.requestAnimationFrame

beforeEach(() => {
sessionStorage.clear()
window.requestAnimationFrame = ((cb: FrameRequestCallback) => {
cb(0)
return 0
}) as typeof window.requestAnimationFrame
})

afterEach(() => {
document.body.innerHTML = ''
})

afterAll(() => {
window.requestAnimationFrame = originalRequestAnimationFrame
})

it('keeps only the active page branch expanded', () => {
window.history.pushState({}, '', '/guide/a/topic-1/current-page')

const nav = renderNav()

initNavV2(nav)

expect(checkbox('group-a').checked).toBe(true)
expect(checkbox('group-a-1').checked).toBe(true)
expect(checkbox('group-a-2').checked).toBe(false)
expect(checkbox('group-b').checked).toBe(false)
})

it('collapses sibling folders when a new folder is opened manually', () => {
window.history.pushState({}, '', '/guide/a/topic-1/current-page')

const nav = renderNav()

initNavV2(nav)

const groupA = checkbox('group-a')
const groupB = checkbox('group-b')
groupB.checked = true
groupB.dispatchEvent(new Event('change', { bubbles: true }))

expect(groupB.checked).toBe(true)
expect(groupA.checked).toBe(false)
})

it('scrolls the active branch into view when it opens below the viewport', () => {
window.history.pushState({}, '', '/guide/b/page')

const nav = renderNav()
const container = document.querySelector(
'.pages-nav-menu'
) as HTMLElement
const groupB = groupRow('group-b')

Object.defineProperty(container, 'scrollTop', {
value: 0,
writable: true,
configurable: true,
})
Object.defineProperty(container, 'clientHeight', {
value: 120,
configurable: true,
})
container.getBoundingClientRect = jest.fn(() => ({
x: 0,
y: 0,
top: 0,
right: 280,
bottom: 120,
left: 0,
width: 280,
height: 120,
toJSON: () => ({}),
}))
groupB.getBoundingClientRect = jest.fn(() => ({
x: 0,
y: 150,
top: 150,
right: 280,
bottom: 250,
left: 0,
width: 280,
height: 100,
toJSON: () => ({}),
}))

initNavV2(nav)

expect(container.scrollTop).toBe(142)
})
})
Loading
Loading