Interface TableOfContents

interface TableOfContents {
    element: HTMLElement;
    entries: readonly TocEntry[];
    destroy(): void;
    refresh(): void;
}

Index

Properties

element entries

Methods

destroy refresh

Properties

`Readonly`element

element: HTMLElement

`Readonly`entries

entries: readonly TocEntry[]

The headings behind the current render, in document order.

Methods

destroy

destroy(): void
Returns void
- Defined in table-of-contents.ts:48

refresh

refresh(): void
Rebuild from the current document. Called automatically on transactions.

Returns void
- Defined in table-of-contents.ts:47