Skip to content

Normalize selector operation in scrollspy #41726

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 3 commits into
base: main
Choose a base branch
from
+34 −4
Open

Normalize selector operation in scrollspy #41726

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f84bf47
normalizes the selector operation in scrollspy
DenisLopatin Sep 5, 2025
588cf7e
Apply suggestion from @XhmikosR
DenisLopatin Sep 7, 2025
e0d1dad
returns a comment
DenisLopatin Sep 7, 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
8 changes: 5 additions & 3 deletions js/src/scrollspy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import BaseComponent from './base-component.js'
import EventHandler from './dom/event-handler.js'
import SelectorEngine from './dom/selector-engine.js'
import {
defineJQueryPlugin, getElement, isDisabled, isVisible
defineJQueryPlugin, getElement, isDisabled, isVisible, parseSelector
} from './util/index.js'

/**
Expand Down Expand Up @@ -210,11 +210,13 @@ class ScrollSpy extends BaseComponent {
continue
}

const observableSection = SelectorEngine.findOne(decodeURI(anchor.hash), this._element)
const withDecodeUri = decodeURI(anchor.hash)
const withEscape = parseSelector(withDecodeUri)
const observableSection = SelectorEngine.findOne(withEscape, this._element)

// ensure that the observableSection exists & is visible
if (isVisible(observableSection)) {
this._targetLinks.set(decodeURI(anchor.hash), anchor)
this._targetLinks.set(withDecodeUri, anchor)
this._observableSections.set(anchor.hash, observableSection)
}
}
Expand Down
2 changes: 1 addition & 1 deletion js/src/util/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const TRANSITION_END = 'transitionend'
const parseSelector = selector => {
if (selector && window.CSS && window.CSS.escape) {
// document.querySelector needs escaping to handle IDs (html5+) containing for instance /
selector = selector.replace(/#([^\s"#']+)/g, (match, id) => `#${CSS.escape(id)}`)
selector = selector.replace(/#([^\s"']+)/g, (match, id) => `#${CSS.escape(id)}`)
}

return selector
Expand Down
28 changes: 28 additions & 0 deletions js/tests/unit/scrollspy.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,34 @@ describe('ScrollSpy', () => {
expect(scrollSpy._targetLinks.size).toBe(1)
})

it('should take account of escaped IDs', () => {
fixtureEl.innerHTML = [
'<nav id="navigation" class="navbar">',
' <ul class="navbar-nav">',
' <li class="nav-item"><a class="nav-link active" id="one-link" href="#div-2.1">One</a></li>',
' <li class="nav-item"><a class="nav-link" id="two-link" href="#!@#$_^&*()">Two</a></li>',
' <li class="nav-item"><a class="nav-link" id="three-link" href="#id.div.Element@data-custom=true">Three</a></li>',
' <li class="nav-item"><a class="nav-link" id="four-link" href="#https://domain.to/#%2F%40user%3Aname.test">Four</a></li>',
' <li class="nav-item"><a class="nav-link" id="five-link" href="#https://domain.to/#/@user:name.test">Five</a></li>',
' </ul>',
'</nav>',
'<div id="content" style="height: 200px; overflow-y: auto;">',
' <div id="div-2.1" style="height: 300px;">test</div>',
' <div id="!@#$_^&*()" style="height: 300px;">test</div>',
' <div id="id.div.Element@data-custom=true" style="height: 300px;">test</div>',
' <div id="https://domain.to/#%2F%40user%3Aname.test" style="height: 300px;">test</div>',
' <div id="https://domain.to/#/@user:name.test">test</div>',
'</div>'
].join('')

const scrollSpy = new ScrollSpy(fixtureEl.querySelector('#content'), {
target: '#navigation'
})

expect(scrollSpy._observableSections.size).toBe(5)
expect(scrollSpy._targetLinks.size).toBe(5)
})

it('should not process element without target', () => {
fixtureEl.innerHTML = [
'<nav id="navigation" class="navbar">',
Expand Down