Skip to content

[hooks] fix: use History API instead of window.location.hash #153

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
Copilot wants to merge 4 commits into
base: main
Choose a base branch
from
Open

[hooks] fix: use History API instead of window.location.hash #153

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
4d0ef71
Initial plan
Copilot Mar 18, 2026
045d76d
fix: use History API instead of window.location.hash to prevent Safar…
Copilot Mar 18, 2026
b2da150
chore: add minor changeset for history API hash fix
Copilot Mar 18, 2026
007b43b
fix: safe window guard and preserve query string in replaceState
Copilot Mar 18, 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
5 changes: 5 additions & 0 deletions .changeset/fix-use-history-api-for-hash.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@wethegit/react-modal": minor
---

Use the History API (`pushState`/`replaceState`) instead of directly assigning `window.location.hash` when opening and closing hash-linked modals. This prevents Safari from scrolling the user to the top of the page. Also adds a `popstate` listener so browser back/forward navigation correctly opens and closes the modal.
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 14 additions & 6 deletions src/lib/hooks/use-modal.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,20 @@ export function useModal(props: UseModalOptions = {}) {
// an extra dependecy and stay within the render loop
current = cur

if (cur !== ModalStates.CLOSED) return ModalStates.CLOSED
if (cur !== ModalStates.CLOSED) return ModalStates.CLOSED
return cur
})

// If the modal is already closed, don't do anything
// we don't want focus back on the trigger
if (current === ModalStates.CLOSED || !current) return

if (hash && window && window.location.hash === `#${hash}`) {
window.location.hash = ""
window.history.replaceState({}, "", window.location.pathname)
if (hash && typeof window !== "undefined" && window.location.hash === `#${hash}`) {
window.history.replaceState(
{},
"",
window.location.pathname + window.location.search
)
}

if (triggerRef && triggerRef.current) triggerRef.current.focus()
Expand All @@ -58,8 +61,8 @@ export function useModal(props: UseModalOptions = {}) {

if (current === ModalStates.OPEN) return

if (hash && window && window.location.hash !== `#${hash}`) {
window.location.hash = `#${hash}`
if (hash && typeof window !== "undefined" && window.location.hash !== `#${hash}`) {
window.history.pushState({}, "", `#${hash}`)
}
}, [hash])

Expand All @@ -81,10 +84,15 @@ export function useModal(props: UseModalOptions = {}) {
// Check for a hash on mount
handleHashChange()

// hashchange fires when navigating to same-page anchors (e.g. <a href="#hash">)
window.addEventListener("hashchange", handleHashChange)
// popstate fires when navigating via browser history (back/forward),
// which is what history.pushState entries use
window.addEventListener("popstate", handleHashChange)

return () => {
window.removeEventListener("hashchange", handleHashChange)
window.removeEventListener("popstate", handleHashChange)
}
}, [handleClose, handleOpen, hash])

Expand Down
Loading