DocsComponentsHooksUtilitiesGuidesSponsorsLicense
  • Docs

      • Introduction
      • Getting Started
      • Configuration
  • Components

      • CodeBlock
        • LineNumbers
        • Tokens
        • Toolbar
      • CodeInline
      • Command
      • Copyright
      • Link
      • Logo
      • MDX
      • Markdown
      • Navigation
      • Reference
      • RootProvider
      • Sponsors
      • TableOfContents
  • Hooks

      • useSectionObserver
      • useThemePicker
  • Utilities

    • File System
  • Guides

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

TableOfContents

API Reference

Last updated 09/19/25
Previous
Sponsors
Next
Hooks

On this page

  1. API Reference
    1. TableOfContentsComponents
    2. TableOfContentsProps
    3. TableOfContents
View Source

Properties

PropertyType
RootComponentClass<ClassAttributes<HTMLElement> & HTMLAttributes<HTMLElement> & { css?: CSSObject | undefined; }, any> | FunctionComponent<ClassAttributes<HTMLElement> & HTMLAttributes<HTMLElement> & { css?: CSSObject | undefined; }>
TitleComponentClass<ClassAttributes<HTMLHeadingElement> & HTMLAttributes<HTMLHeadingElement> & { css?: CSSObject | undefined; }, any> | FunctionComponent<ClassAttributes<HTMLHeadingElement> & HTMLAttributes<HTMLHeadingElement> & { css?: CSSObject | undefined; }>
ListComponentClass<ClassAttributes<HTMLOListElement> & OlHTMLAttributes<HTMLOListElement> & { css?: CSSObject | undefined; }, any> | FunctionComponent<ClassAttributes<HTMLOListElement> & OlHTMLAttributes<HTMLOListElement> & { css?: CSSObject | undefined; }>
ItemComponentClass<ClassAttributes<HTMLLIElement> & LiHTMLAttributes<HTMLLIElement> & { css?: CSSObject | undefined; }, any> | FunctionComponent<ClassAttributes<HTMLLIElement> & LiHTMLAttributes<HTMLLIElement> & { css?: CSSObject | undefined; }>
LinkComponentClass<ClassAttributes<HTMLAnchorElement> & AnchorHTMLAttributes<HTMLAnchorElement> & { css?: CSSObject | undefined; }, any> | FunctionComponent<ClassAttributes<HTMLAnchorElement> & AnchorHTMLAttributes<HTMLAnchorElement> & { css?: CSSObject | undefined; }>

Properties

PropertyType
headingsArray<{ id: string; level: number; text: string; children?: ReactNode; }>
components?Partial<TableOfContentsComponents>
children?ReactNode

Properties

TableOfContentsProps