DocsComponentsUtilitiesGuidesSponsorsLicense
  • Docs

    • Introduction
    • Getting Started
    • Configuration
  • Components

    • CodeBlock
      • CopyButton
      • LineNumbers
      • Tokens
      • Toolbar
    • CodeInline
    • Copyright
    • GitProvider
    • MDX
    • Markdown
    • PackageInstall
    • Reference
    • Refresh
    • Sponsors
    • Theme
      • ThemeStyles
  • Hooks

    • useSectionObserver
    • useThemePicker
  • Utilities

    • File System
  • Guides

    • MDX
    • Next.js
    • Waku
    • Zod
    • Valibot
  • © 2025 souporserious

useSectionObserver

API Reference

Last updated: 4/29/2025Edit on GitHub
Previous
Hooks
Next
useThemePicker

On this page

  1. API Reference
  2. useSectionObserver

Returns a set of hooks to manage the active section in a scrollable container.

Parameters

ParameterTypeDefault Value
{ rootMargin, }{ rootMargin, }: { rootMargin?: string } = {}{}

Returns

{ scrollToSection: (sectionId: string) => void; useSection: (id: string) => boolean; useLink: (id: string) => readonly [boolean | null, { readonly href: `#${string}`; readonly onClick: (e: MouseEvent<HTMLAnchorElement, MouseEvent>) => void; }]; }