TableOfContents
A table of contents that displays links to the sections in the current document.
API Reference
Type
Section | ContentSectionProperties
| Property | Type | Modifiers |
|---|---|---|
| Root | ComponentClass<{ children?: React.ReactNode; 'aria-labelledby'?: string; }, any> | FunctionComponent<{ children?: React.ReactNode; 'aria-labelledby'?: string; }> | — |
Root navigation element. | ||
| Title | ComponentClass<{ id?: string; children?: React.ReactNode; }, any> | FunctionComponent<{ id?: string; children?: React.ReactNode; }> | — |
Title heading. | ||
| List | ComponentClass<{ depth: number; children?: React.ReactNode; }, any> | FunctionComponent<{ depth: number; children?: React.ReactNode; }> | — |
Ordered list of items. | ||
| Item | ComponentClass<{ children?: React.ReactNode; }, any> | FunctionComponent<{ children?: React.ReactNode; }> | — |
Individual list item. | ||
| Link | ComponentClass<{ children?: React.ReactNode; href: string; suppressHydrationWarning?: boolean; 'aria-current'?: React.AriaAttributes["aria-current"]; }, any> | FunctionComponent<{ children?: React.ReactNode; href: string; suppressHydrationWarning?: boolean; 'aria-current'?: React.AriaAttributes["aria-current"]; }> | — |
Anchor link to a heading. | ||
Properties
| Property | Type | Modifiers |
|---|---|---|
| sections | Array<TableOfContentsSection> | — |
The sections to display within the table of contents. | ||
| components? | Partial<TableOfContentsComponents> | — |
Override the default component renderers. | ||
| children? | React.ReactNode | — |
Optional content rendered after the section links. | ||
A table of contents that displays links to the sections in the current document.
Properties
TableOfContentsPropsReturns
null | React.JSX.ElementLast updated