Skip to content

Do not run window.history.replaceState unconditionally #13918

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
AA-Turner merged 3 commits into from
Nov 24, 2025
Merged

Do not run window.history.replaceState unconditionally #13918

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
2ad7509
Do not run `window.history.replaceState` unconditionally
haampie Sep 27, 2025
99fb307
add clarifying comment
haampie Nov 22, 2025
808e79a
Update sphinx/themes/basic/static/sphinx_highlight.js
AA-Turner Nov 24, 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
2 changes: 2 additions & 0 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,8 @@ Bugs fixed
* #14059: LaTeX: Footnotes cause pdflatex error with French language
(since late June 2025 upstream change to LaTeX ``babel-french``).
Patch by Jean-François B.
* #13916: HTML Search: do not clear text fragments from the URL on page load.
Patch by Harmen Stoppels.


Testing
Expand Down
8 changes: 6 additions & 2 deletions sphinx/themes/basic/static/sphinx_highlight.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,12 @@ const SphinxHighlight = {
|| url.searchParams.get("highlight")
|| "";
localStorage.removeItem("sphinx_highlight_terms");
url.searchParams.delete("highlight");
window.history.replaceState({}, "", url);
// Update history only if '?highlight' is present; otherwise it
// clears text fragments (not set in window.location by the browser)
if (url.searchParams.has("highlight")) {
url.searchParams.delete("highlight");
window.history.replaceState({}, "", url);
}

// get individual terms from highlight string
const terms = highlight
Expand Down
Loading