useCompoundRefLinkActive() — supabase Function Reference

Architecture documentation for the useCompoundRefLinkActive() function in Reference.navigation.client.tsx from the supabase codebase.

Function tsx DocumentationSystem ReferenceGen calls 2 called by 1

Entity Profile

DocumentationSystem→ ReferenceGen→ useCompoundRefLinkActive() — supabase Function Reference

Dependency Diagram

graph TD
  0547f6d5_1310_fdf7_d2ea_5e8a160ea36f["useCompoundRefLinkActive()"]
  17ffa18c_6fb8_d700_8e17_494a07a6e141["CompoundRefLink()"]
  17ffa18c_6fb8_d700_8e17_494a07a6e141 -->|calls| 0547f6d5_1310_fdf7_d2ea_5e8a160ea36f
  cac0806c_afea_1c54_1d56_95246f1e7737["useCurrentPathname()"]
  0547f6d5_1310_fdf7_d2ea_5e8a160ea36f -->|calls| cac0806c_afea_1c54_1d56_95246f1e7737
  64d636ac_c75e_381b_df7f_d60397061232["deriveHref()"]
  0547f6d5_1310_fdf7_d2ea_5e8a160ea36f -->|calls| 64d636ac_c75e_381b_df7f_d60397061232
  style 0547f6d5_1310_fdf7_d2ea_5e8a160ea36f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/docs/features/docs/Reference.navigation.client.tsx lines 296–322

function useCompoundRefLinkActive(basePath: string, section: AbbrevApiReferenceSection) {
  const [open, _setOpen] = useState(false)

  const pathname = useCurrentPathname()
  const parentHref = deriveHref(basePath, section)
  const isParentActive = pathname === parentHref

  const childHrefs = useMemo(
    () => new Set((section.items || []).map((item) => deriveHref(basePath, item))),
    [basePath, section]
  )
  const isChildActive = childHrefs.has(pathname)

  const isActive = isParentActive || isChildActive

  const setOpen = (open: boolean) => {
    // Disable closing if the section is active, to prevent the currently active
    // link disappearing
    if (open || !isActive) _setOpen(open)
  }

  if (isActive && !open) {
    setOpen(true)
  }

  return { open, setOpen, isActive }
}