Files
supabase/apps/docs/components/Navigation/NavigationMenu/NavigationMenuGuideListItems.tsx
T
Anthony Lio c145f3e046 fix(docs): guide nav collapsible parity (#49945)
## What kind of change does this PR introduce?

visual parity fix and refresh + component extraction (stacked on #49942)

## What is the current behavior?

guide and reference sidebars each hand-roll their own collapsible
section visuals

## What is the new behavior?

- adds `NavSection` composition components (`NavSectionCaret`,
`NavSectionContent`, `NavSectionList`) shared by both navs via radix
`asChild`, so the rail, caret, and motion have a single source of truth
- fixes ui drift between both so navs get the same left rail beside
expanded children, the same caret and animation
- enhances link click area so space between rows is part of the click
target

| state | preview |
| -------|------|
| before | <img width="430" height="288" alt="image"
src="https://github.com/user-attachments/assets/0052d4b7-7793-43cf-8416-2a5445b95148"
/> |
| after | <img width="430" height="288" alt="image"
src="https://github.com/user-attachments/assets/42713ee3-e147-4e53-a58d-3f3de278264d"
/> |

## How to test?

1. run `pnpm dev:docs`
2. open [guide
page](http://localhost:3001/docs/guides/integrations/build-a-supabase-oauth-integration)
3. open [reference
page](http://localhost:3001/docs/reference/dart/introduction)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Added animated expand/collapse behavior and rotating caret indicators
to documentation navigation sections.
  * Added active-child indicators for clearer navigation context.

* **Improvements**
* Standardized spacing, borders, and animation styles across guide and
reference navigation.
* Improved collapsible animations to support varying content sizes more
reliably.
* Navigation items without links or child content, including disabled
nested items, are no longer displayed.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-09-10 15:03:55 +03:00

274 lines
8.6 KiB
TypeScript

import {
NavSectionCaret,
NavSectionContent,
NavSectionList,
} from '~/components/Navigation/NavSection'
import { useTheme } from 'next-themes'
import Image from 'next/legacy/image'
import Link from 'next/link'
import { usePathname } from 'next/navigation'
import { Accordion } from 'radix-ui'
import React, { useEffect, useRef } from 'react'
import MenuIconPicker from './MenuIconPicker'
type NavAccordionItem = {
url?: string
enabled?: boolean
items?: NavAccordionItem[]
}
function hasActiveDescendant(item: NavAccordionItem, pathname: string): boolean {
if (item.enabled === false) return false
if (item.url === pathname) return true
return item.items?.some((child) => hasActiveDescendant(child, pathname)) ?? false
}
function isRenderable(item: NavAccordionItem): boolean {
if (item.enabled === false) return false
if (item.url) return true
return item.items?.some(isRenderable) ?? false
}
const HeaderLink = React.memo(function HeaderLink(props: {
title: string
id: string
url: string
}) {
const pathname = usePathname()
return (
<span
className={[
' ',
!props.title && 'capitalize',
props.url === pathname ? 'text-brand-link' : 'hover:text-brand-link text-foreground',
].join(' ')}
>
{props.title ?? props.id}
</span>
)
})
const ContentAccordionLink = React.memo(function ContentAccordionLink(props: any) {
const pathname = usePathname()
const { resolvedTheme } = useTheme()
const childItems = props.subItem.items ?? []
const activeItem =
props.subItem.url === pathname &&
!childItems.some((child: NavAccordionItem) => child.url === pathname)
const activeItemRef = useRef<HTMLLIElement>(null)
const enabledChildren = childItems.filter(isRenderable)
const hasChildren = enabledChildren.length > 0
const isChildActive = enabledChildren.some((child: NavAccordionItem) =>
hasActiveDescendant(child, pathname)
)
const accordionValue = props.subItem.url || props.subItem.name
const LinkContainer = (props) => {
const isExternal = props.url.startsWith('https://')
return (
<Link
href={props.url}
className={props.className}
target={isExternal ? '_blank' : undefined}
rel={isExternal ? 'noopener noreferrer' : undefined}
>
{props.children}
</Link>
)
}
useEffect(() => {
// scroll to active item
if (activeItem && activeItemRef.current) {
// this is a hack, but seems a common one on Stackoverflow
setTimeout(() => {
activeItemRef.current?.scrollIntoView({ behavior: 'smooth', block: 'nearest' })
}, 0)
}
})
if (!hasChildren && !props.subItem.url) return null
return (
<li ref={!hasChildren && activeItem ? activeItemRef : null}>
{hasChildren ? (
<Accordion.Root
collapsible
type="single"
className="space-y-0.5"
defaultValue={isChildActive ? accordionValue : undefined}
>
<Accordion.Item key={accordionValue} value={accordionValue}>
<Accordion.Trigger
className={[
'flex items-center gap-2 w-full',
'cursor-pointer transition text-sm',
'focus-inset rounded-md',
activeItem
? 'text-brand-link font-medium'
: 'hover:text-foreground text-foreground-lighter',
].join(' ')}
>
<span className="flex items-center justify-between w-full">
<div className="flex items-center gap-2">
{props.subItem.icon && (
<Image
alt={props.subItem.name}
src={`${props.subItem.icon}${!resolvedTheme?.includes('dark') ? '-light' : ''}.svg`}
width={15}
height={15}
/>
)}
{props.subItem.name}
</div>
<NavSectionCaret />
</span>
</Accordion.Trigger>
<Accordion.Content asChild>
<NavSectionContent>
<NavSectionList>
{enabledChildren.map((child) => {
if (child.items && child.items.length > 0) {
return <ContentAccordionLink key={child.name} subItem={child} />
}
return (
<li key={`${props.subItem.name}-${child.url}`}>
<Link
href={child.url}
className={[
'relative block py-1.25 pl-1 -ml-1 cursor-pointer transition text-sm',
'focus-inset rounded-md',
child.url === pathname
? 'text-brand-link'
: 'hover:text-brand-link text-foreground-lighter',
].join(' ')}
>
{child.url === pathname && (
<span
aria-hidden
className="absolute left-[-13px] top-1/2 h-[1em] w-px -translate-y-1/2 bg-current"
/>
)}
{child.name}
</Link>
</li>
)
})}
</NavSectionList>
</NavSectionContent>
</Accordion.Content>
</Accordion.Item>
</Accordion.Root>
) : (
<LinkContainer
url={props.subItem.url}
className={[
'flex items-center gap-2',
'cursor-pointer transition text-sm',
'focus-inset rounded-md',
activeItem
? 'text-brand-link font-medium'
: 'hover:text-foreground text-foreground-lighter',
].join(' ')}
parent={props.subItem.parent}
>
<div className="flex items-center gap-2">
{props.subItem.icon && (
<Image
alt={props.subItem.name}
src={`${props.subItem.icon}${!resolvedTheme?.includes('dark') ? '-light' : ''}.svg`}
width={15}
height={15}
/>
)}
{props.subItem.name}
</div>
</LinkContainer>
)}
</li>
)
})
const ContentLink = React.memo(function ContentLink(props: any) {
const pathname = usePathname()
return (
<li className="mb-1.5">
<Link
href={props.url}
className={[
'cursor-pointer transition text-sm',
'focus-inset rounded-md',
props.url === pathname
? 'text-brand-link'
: 'hover:text-foreground text-foreground-lighter',
].join(' ')}
>
{props.icon && (
<Image alt={props.icon} width={12} height={12} src={`${pathname}${props.icon}`} />
)}
{props.name}
</Link>
</li>
)
})
const Content = (props) => {
const { menu, id } = props
if (menu.enabled === false) {
return null
}
return (
<div className="relative w-full flex flex-col gap-0 pb-5">
<Link href={menu.url ?? ''}>
<div className="flex items-center gap-3 my-3 text-brand-link">
<MenuIconPicker icon={menu.icon} />
<HeaderLink title={menu.title} url={menu.url} id={id} />
</div>
</Link>
<ul data-testid="docs-guide-navigation-list" className="flex flex-col gap-0">
{menu.items.map((entry) => {
if (entry.enabled === false) return null
if (entry.items && entry.items.length > 0) {
const enabledItems = entry.items.filter(isRenderable)
if (enabledItems.length === 0) return null
return (
<li key={entry.name}>
<div className="flex flex-col gap-2.5">
<div className="h-px w-full bg-border my-3"></div>
<span className="font-mono text-xs uppercase text-foreground font-medium tracking-wider">
{entry.name}
</span>
<ul className="flex flex-col gap-2.5">
{enabledItems.map((subItem) => (
<ContentAccordionLink key={subItem.name} subItem={subItem} />
))}
</ul>
</div>
</li>
)
}
return entry.url ? (
<ContentLink url={entry.url} icon={entry.icon} name={entry.name} key={entry.name} />
) : null
})}
</ul>
</div>
)
}
export default React.memo(Content)