useScrollTopOnPageChange() — supabase Function Reference

Architecture documentation for the useScrollTopOnPageChange() function in helpers.scroll.client.tsx from the supabase codebase.

Function tsx DocumentationSystem ReferenceGen called by 1

Entity Profile

DocumentationSystem→ ReferenceGen→ useScrollTopOnPageChange() — supabase Function Reference

Dependency Diagram

graph TD
  9fe87dd5_c2d9_6746_7be2_2faa60d7a83e["useScrollTopOnPageChange()"]
  9f61d70e_36be_0070_dc8b_b3844573a498["ScrollRestoration()"]
  9f61d70e_36be_0070_dc8b_b3844573a498 -->|calls| 9fe87dd5_c2d9_6746_7be2_2faa60d7a83e
  style 9fe87dd5_c2d9_6746_7be2_2faa60d7a83e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/docs/features/ui/helpers.scroll.client.tsx lines 7–22

const useScrollTopOnPageChange = () => {
  const pathname = usePathname()

  useEffect(() => {
    if (document && pathname) {
      // Don't scroll on reference pages
      if (pathname.startsWith('/reference/')) return

      const container = document.getElementById(DOCS_CONTENT_CONTAINER_ID)
      if (container) container.scrollTop = 0
      /**
       * a11y works by default, so no need to specially handle it
       */
    }
  }, [pathname])
}