@tanstack/router-core 1.168.3 → 1.168.5

package/src/scroll-restoration-inline.ts

@@ -0,0 +1,81 @@
+export default function (options: {
+  storageKey: string
+  key?: string
+  behavior?: ScrollToOptions['behavior']
+  shouldScrollRestoration?: boolean
+}) {
+  let byKey
+
+  try {
+    byKey = JSON.parse(sessionStorage.getItem(options.storageKey) || '{}')
+  } catch (error) {
+    console.error(error)
+    return
+  }
+
+  const resolvedKey = options.key || window.history.state?.__TSR_key
+  const elementEntries = resolvedKey ? byKey[resolvedKey] : undefined
+
+  if (
+    options.shouldScrollRestoration &&
+    elementEntries &&
+    typeof elementEntries === 'object' &&
+    Object.keys(elementEntries).length > 0
+  ) {
+    for (const elementSelector in elementEntries) {
+      const entry = elementEntries[elementSelector]
+
+      if (!entry || typeof entry !== 'object') {
+        continue
+      }
+
+      const scrollX = entry.scrollX
+      const scrollY = entry.scrollY
+
+      if (!Number.isFinite(scrollX) || !Number.isFinite(scrollY)) {
+        continue
+      }
+
+      if (elementSelector === 'window') {
+        window.scrollTo({
+          top: scrollY,
+          left: scrollX,
+          behavior: options.behavior,
+        })
+      } else if (elementSelector) {
+        let element
+
+        try {
+          element = document.querySelector(elementSelector)
+        } catch {
+          continue
+        }
+
+        if (element) {
+          element.scrollLeft = scrollX
+          element.scrollTop = scrollY
+        }
+      }
+    }
+
+    return
+  }
+
+  const hash = window.location.hash.split('#', 2)[1]
+
+  if (hash) {
+    const hashScrollIntoViewOptions =
+      window.history.state?.__hashScrollIntoViewOptions ?? true
+
+    if (hashScrollIntoViewOptions) {
+      const el = document.getElementById(hash)
+      if (el) {
+        el.scrollIntoView(hashScrollIntoViewOptions)
+      }
+    }
+
+    return
+  }
+
+  window.scrollTo({ top: 0, left: 0, behavior: options.behavior })
+}

package/src/scroll-restoration-script/client.ts

@@ -0,0 +1,5 @@
+import type { AnyRouter } from '../router'
+
+export function getScrollRestorationScriptForRouter(_router: AnyRouter) {
+  return null
+}

package/src/scroll-restoration-script/server.ts

@@ -0,0 +1,64 @@
+import minifiedScrollRestorationScript from '../scroll-restoration-inline?script-string'
+import {
+  defaultGetScrollRestorationKey,
+  storageKey,
+} from '../scroll-restoration'
+import { escapeHtml } from '../utils'
+import type { AnyRouter } from '../router'
+
+type InlineScrollRestorationScriptOptions = {
+  storageKey: string
+  key?: string
+  behavior?: ScrollToOptions['behavior']
+  shouldScrollRestoration?: boolean
+}
+
+const defaultInlineScrollRestorationScript = `(${minifiedScrollRestorationScript})(${escapeHtml(
+  JSON.stringify({
+    storageKey,
+    shouldScrollRestoration: true,
+  } satisfies InlineScrollRestorationScriptOptions),
+)})`
+
+function getScrollRestorationScript(
+  options: InlineScrollRestorationScriptOptions,
+) {
+  if (
+    options.storageKey === storageKey &&
+    options.shouldScrollRestoration === true &&
+    options.key === undefined &&
+    options.behavior === undefined
+  ) {
+    return defaultInlineScrollRestorationScript
+  }
+
+  return `(${minifiedScrollRestorationScript})(${escapeHtml(JSON.stringify(options))})`
+}
+
+export function getScrollRestorationScriptForRouter(router: AnyRouter) {
+  if (
+    typeof router.options.scrollRestoration === 'function' &&
+    !router.options.scrollRestoration({ location: router.latestLocation })
+  ) {
+    return null
+  }
+
+  const getKey = router.options.getScrollRestorationKey
+  if (!getKey) {
+    return defaultInlineScrollRestorationScript
+  }
+
+  const location = router.latestLocation
+  const userKey = getKey(location)
+  const defaultKey = defaultGetScrollRestorationKey(location)
+
+  if (userKey === defaultKey) {
+    return defaultInlineScrollRestorationScript
+  }
+
+  return getScrollRestorationScript({
+    storageKey,
+    shouldScrollRestoration: true,
+    key: userKey,
+  })
+}