Trevixal API
    Preparing search index...

    Interface TableOfContentsOptions

    interface TableOfContentsOptions {
        ariaLabel?: string;
        container: HTMLElement;
        emptyLabel?: string;
        maxLevel?: number;
        nodeName?: string;
        onNavigate?: (entry: TocEntry, element: HTMLElement | null) => void;
        untitledLabel?: string;
    }
    Index
    ariaLabel? container emptyLabel? maxLevel? nodeName? onNavigate? untitledLabel?
    ariaLabel?: string

    Accessible name of the <nav> (default "Table of contents").

    container: HTMLElement

    Where the nav is appended. Required. The TOC is not a floating widget.

    emptyLabel?: string

    Shown in place of the list when the document has no headings.

    maxLevel?: number

    Deepest level to include (default 6). Deeper headings are skipped.

    nodeName?: string

    Node type carrying the level attribute (default "heading").

    onNavigate?: (entry: TocEntry, element: HTMLElement | null) => void

    Called after the caret has been moved into the clicked heading. Override to scroll a custom container, or to suppress scrolling entirely.

    untitledLabel?: string

    Text for an untitled heading (default "Untitled").

    Settings
    Member Visibility

    On This Page
    Properties