TableOfContents

TableOfContents collects Heading and Bookmark within the current page and displays them in a navigable tree. Uses the same Scroller behavior as NavPanel (scrollStyle, showScrollerFade).

Behaviors

This component supports the following behaviors:

Properties

maxHeadingLevel

default: 6

Defines the maximum heading level (1 to 6) to include in the table of contents. For example, if it is 2, then H1 and H2 are displayed, but lower levels (H3 to H6) are not.

omitH1

default: false

If true, the H1 heading is not included in the table of contents. This is useful when the H1 is used for the page title and you want to avoid duplication.

scrollStyle

default: "normal"

This property determines the scrollbar style. Options: "normal" uses the browser's default scrollbar; "overlay" displays a themed scrollbar that is always visible; "whenMouseOver" shows the scrollbar only when hovering over the scroll container; "whenScrolling" displays the scrollbar only while scrolling is active and fades out after 400ms of inactivity. On mobile/touch devices, this property is ignored and the browser's native scrollbar is always used.

Available values: normal (default), overlay, whenMouseOver, whenScrolling

showScrollerFade

default: true

When enabled, displays gradient fade indicators at the top and bottom edges when scrollable content extends beyond the visible area. Only works with "overlay", "whenMouseOver", and "whenScrolling" scroll styles. On mobile/touch devices, this property has no effect.

smoothScrolling

default: false

This property indicates that smooth scrolling is used while scrolling the selected table of contents items into view.

Events

contextMenu

This event is triggered when the TableOfContents is right-clicked (context menu).

Signature: contextMenu(event: MouseEvent): void

• event: The mouse event object.

Exposed Methods

This component does not expose any methods.

Styling

Theme Variables