fix: hashchange should only be triggered for same page navigations (#3768)

Co-authored-by: zonemeen <[email protected]>

Author: brc-dd

Diff for: docs/reference/runtime-api.md

@@ -38,6 +38,10 @@ interface VitePressData<T = any> {
   isDark: Ref<boolean>
   dir: Ref<string>
   localeIndex: Ref<string>
+  /**
+   * Current location hash
+   */
+  hash: Ref<string>
 }
 
 interface PageData {

Diff for: src/client/app/data.ts

@@ -6,12 +6,14 @@ import {
   readonly,
   ref,
   shallowRef,
+  watch,
   type InjectionKey,
   type Ref
 } from 'vue'
 import {
   APPEARANCE_KEY,
   createTitle,
+  inBrowser,
   resolveSiteDataByRoute,
   type PageData,
   type SiteData
@@ -47,6 +49,10 @@ export interface VitePressData<T = any> {
   dir: Ref<string>
   localeIndex: Ref<string>
   isDark: Ref<boolean>
+  /**
+   * Current location hash
+   */
+  hash: Ref<string>
 }
 
 // site data is a singleton
@@ -82,6 +88,21 @@ export function initData(route: Route): VitePressData {
           })
         : ref(false)
 
+  const hashRef = ref(inBrowser ? location.hash : '')
+
+  if (inBrowser) {
+    window.addEventListener('hashchange', () => {
+      hashRef.value = location.hash
+    })
+  }
+
+  watch(
+    () => route.data,
+    () => {
+      hashRef.value = inBrowser ? location.hash : ''
+    }
+  )
+
   return {
     site,
     theme: computed(() => site.value.themeConfig),
@@ -95,7 +116,8 @@ export function initData(route: Route): VitePressData {
     description: computed(
       () => route.data.description || site.value.description
     ),
-    isDark
+    isDark,
+    hash: computed(() => hashRef.value)
   }
 }
 

Diff for: src/client/app/router.ts

@@ -66,16 +66,10 @@ export function createRouter(
   async function go(href: string = inBrowser ? location.href : '/') {
     href = normalizeHref(href)
     if ((await router.onBeforeRouteChange?.(href)) === false) return
-    if (inBrowser) {
-      const currentUrl = new URL(location.href)
-      if (href !== normalizeHref(currentUrl.href)) {
-        // save scroll position before changing url
-        history.replaceState({ scrollPosition: window.scrollY }, document.title)
-        history.pushState(null, '', href)
-        if (new URL(href, fakeHost).hash !== currentUrl.hash) {
-          window.dispatchEvent(new Event('hashchange'))
-        }
-      }
+    if (inBrowser && href !== normalizeHref(location.href)) {
+      // save scroll position before changing url
+      history.replaceState({ scrollPosition: window.scrollY }, document.title)
+      history.pushState(null, '', href)
     }
     await loadPage(href)
     await router.onAfterRouteChanged?.(href)
@@ -211,7 +205,12 @@ export function createRouter(
               if (hash !== currentUrl.hash) {
                 history.pushState(null, '', href)
                 // still emit the event so we can listen to it in themes
-                window.dispatchEvent(new Event('hashchange'))
+                window.dispatchEvent(
+                  new HashChangeEvent('hashchange', {
+                    oldURL: currentUrl.href,
+                    newURL: href
+                  })
+                )
               }
               if (hash) {
                 // use smooth scroll when clicking on header anchor links

Diff for: src/client/theme-default/composables/hash.ts

@@ -1,13 +1,12 @@
 import { computed } from 'vue'
 import { ensureStartingSlash } from '../support/utils'
 import { useData } from './data'
-import { hashRef } from './hash'
 
 export function useLangs({
   removeCurrent = true,
   correspondingLink = false
 } = {}) {
-  const { site, localeIndex, page, theme } = useData()
+  const { site, localeIndex, page, theme, hash } = useData()
   const currentLang = computed(() => ({
     label: site.value.locales[localeIndex.value]?.label,
     link:
@@ -29,7 +28,7 @@ export function useLangs({
                   currentLang.value.link.length - 1
                 ),
                 !site.value.cleanUrls
-              ) + hashRef.value
+              ) + hash.value
           }
     )
   )

Diff for: src/client/theme-default/composables/langs.ts

@@ -18,7 +18,6 @@ import {
   getSidebarGroups
 } from '../support/sidebar'
 import { useData } from './data'
-import { hashRef } from './hash'
 
 export interface SidebarControl {
   collapsed: Ref<boolean>
@@ -138,7 +137,7 @@ export function useCloseSidebarOnEscape(
 export function useSidebarControl(
   item: ComputedRef<DefaultTheme.SidebarItem>
 ): SidebarControl {
-  const { page } = useData()
+  const { page, hash } = useData()
 
   const collapsed = ref(false)
 
@@ -155,7 +154,7 @@ export function useSidebarControl(
     isActiveLink.value = isActive(page.value.relativePath, item.value.link)
   }
 
-  watch([page, item, hashRef], updateIsActiveLink)
+  watch([page, item, hash], updateIsActiveLink)
   onMounted(updateIsActiveLink)
 
   const hasActiveLink = computed(() => {