Skip to content

add support for navigation entries that contain a fragment identifier #183

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.

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
merged 1 commit into from
Jun 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion preview-src/ui-model.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
antoraVersion: '2.3.1'
navMode: template # set value to client to generate navigation on the client
navMode: client # set value to client to generate navigation on the client
site:
title: Couchbase Docs
url: http://localhost:5252
Expand Down Expand Up @@ -65,6 +65,8 @@ site:
urlType: fragment
- content: Monitoring Statistics
url: /index.html
- content: Glossaries
url: /index.html#_glossaries
- content: Monitoring XDCR Timestamp-based Conflict Resolution
url: '#'
urlType: fragment
Expand Down
42 changes: 40 additions & 2 deletions src/js/01-nav.js
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@
navTextEl.href = relativize(page.url, item.url)
if (page.url === item.url) {
navItemEl.classList.add('is-current-page')
navTextEl.classList.add('is-current-page')
navTextEl.classList.add('is-current-page', 'is-initial-page')
}
} else {
navTextEl = createElement('span', 'menu_title menu_text')
Expand Down Expand Up @@ -247,6 +247,39 @@
return parent.appendChild(navListEl)
}

function onHashChange () {
var navLink
var hash = window.location.hash
if (hash) {
if (hash.indexOf('%')) hash = decodeURIComponent(hash)
navLink = navContainer.querySelector('a.menu_link[href="' + hash + '"]')
}
if (!(navLink || (navLink = navContainer.querySelector('a.is-initial-page')))) return
var currentPageLink = navContainer.querySelector('a.is-current-page')
if (navLink === currentPageLink) return
if (currentPageLink) toggleCurrentPath(navContainer, currentPageLink, 'clear')
toggleCurrentPath(navContainer, navLink, 'activate')
scrollItemToMidpoint(nav.querySelector('.components'), navLink)
return true
}

function toggleCurrentPath (container, navLink, operation) {
navLink.classList[operation === 'clear' ? 'remove' : 'add']('is-current-page')
var navItem = navLink.parentNode.parentNode
var ancestor = navLink.parentNode
while (ancestor !== container) {
if (ancestor.tagName === 'LI') {
var ancestorClassList = ancestor.classList
if (ancestor === navItem) {
ancestorClassList[operation === 'clear' ? 'remove' : 'add']('is-current-page')
} else if (ancestorClassList.contains('is-parent')) {
ancestorClassList[operation === 'clear' ? 'add' : 'remove']('closed')
}
}
ancestor = ancestor.parentNode
}
}

function relativize (from, to) {
if (!(from && to.charAt() === '/')) { return to }
var hash = ''
Expand Down Expand Up @@ -316,7 +349,12 @@

var components = container.querySelector('.components')

scrollItemToMidpoint(components, container.querySelector('a.is-current-page'))
let scrolled
if (container.querySelector('a.menu_link[href^="#"]')) {
window.location.hash && (scrolled = onHashChange())
window.addEventListener('hashchange', onHashChange)
}
scrolled || scrollItemToMidpoint(components, container.querySelector('a.is-current-page'))

if (!components.classList.contains('is-revealed')) {
find('a.is-current-page', container).forEach(function (currentPage) {
Expand Down