Files
supabase/apps/docs/layouts/ref/RefSubLayoutNonFunc.tsx
Devanshu Sharma 0674343912 Fix(docs): prevent SecurityError from rapid history.replaceState call… (#38672)
* Fix(docs): prevent SecurityError from rapid history.replaceState calls during fast scrolling

* url now chases the scroll

* fixing merge conflicts

* refactor: minor changes to safeHistoryReplaceState

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-09-18 21:00:10 +00:00

109 lines
3.2 KiB
TypeScript

import { useInView } from 'react-intersection-observer'
import { FC, PropsWithChildren } from 'react'
import { highlightSelectedNavItem } from 'ui/src/components/CustomHTMLElements/CustomHTMLElements.utils'
import { useRouter } from 'next/compat/router'
import { useNavigationMenuContext } from '~/components/Navigation/NavigationMenu/NavigationMenu.Context'
import { menuState } from '~/hooks/useMenuState'
import { safeHistoryReplaceState } from '~/lib/historyUtils'
interface ISectionContainer {
id: string
title?: string
monoFont?: boolean
slug: string
scrollSpyHeader?: boolean
singleColumn?: boolean
}
type RefSubLayoutNonFuncSubComponents = {
Section: FC<ISectionContainer>
Details: FC<ISectionDetails>
Examples: FC<ISectionExamples>
}
type StickyHeader = {
id: string
slug?: string
title?: string
monoFont?: boolean
scrollSpyHeader?: boolean // whether or not the header updates the url on scroll
}
type RefSubLayoutNonFuncType = {}
const RefSubLayoutNonFunc: FC<PropsWithChildren<RefSubLayoutNonFuncType>> &
RefSubLayoutNonFuncSubComponents = (props) => {
return <div className="flex flex-col w-full divide-y">{props.children}</div>
}
const Section: FC<PropsWithChildren<ISectionContainer>> = (props) => {
return (
<article key={props.id} className={`${props.singleColumn ? 'prose py-16' : 'py-16'}`}>
<StickyHeader {...props} />
<div
className={`ref-container gap-16 ${
!props.singleColumn ? 'grid lg:grid-cols-2' : 'ref-container--full-width lg:max-w-3xl'
}`}
>
{props.children}
</div>
</article>
)
}
const StickyHeader: FC<StickyHeader> = (props) => {
const router = useRouter()
const { setActiveRefItem } = useNavigationMenuContext()
const { ref } = useInView({
threshold: 1,
rootMargin: '30% 0% -35% 0px',
onChange: (inView, entry) => {
if (inView && window) highlightSelectedNavItem(entry.target.attributes['data-ref-id'].value)
if (inView && props.scrollSpyHeader) {
safeHistoryReplaceState(entry.target.id)
// if (setActiveRefItem) setActiveRefItem(entry.target.attributes['data-ref-id'].value)
menuState.setMenuActiveRefId(entry.target.attributes['data-ref-id'].value)
// router.push(`/reference/javascript/${entry.target.attributes['data-ref-id'].value}`, null, {
// shallow: true,
// })
}
},
})
return (
<h2
ref={ref}
id={props.slug}
data-ref-id={props.id}
className={[
'text-xl font-medium text-foreground mb-8 scroll-mt-24',
props.monoFont && 'font-mono',
].join(' ')}
>
{props.title && <span className="max-w-xl">{props.title}</span>}
</h2>
)
}
interface ISectionDetails {}
const Details: FC<PropsWithChildren<ISectionDetails>> = (props) => {
return <div>{props.children}</div>
}
interface ISectionExamples {}
const Examples: FC<PropsWithChildren<ISectionExamples>> = (props) => {
return (
<div className="w-full">
<div className="sticky top-32">{props.children}</div>
</div>
)
}
RefSubLayoutNonFunc.Section = Section
RefSubLayoutNonFunc.Details = Details
RefSubLayoutNonFunc.Examples = Examples
export default RefSubLayoutNonFunc