TableOfContentsView

class TableOfContentsView(val title: InlineContent?, val maxDepth: Int, val includeUnnumbered: Boolean = false, focusedItem: InlineContent? = null) : Node

When this node is rendered, the current table of contents, retrieved from the auto-generated AstAttributes.tableOfContents, is displayed.

title

title of the table of contents. If null, the default localized title is used

maxDepth

maximum depth the table of contents to display. For instance, if maxDepth is 2, only headings of level 1 and 2 will be displayed

includeUnnumbered

if true, unnumbered (decorative) headings are also included

focusedItem

if not null, adds focus to the item of the table of contents with the same text content as this value

Constructors

constructor(title: InlineContent?, maxDepth: Int, includeUnnumbered: Boolean = false, focusedItem: InlineContent? = null)

open override fun <T> accept(visitor: NodeVisitor<T>): T

Accepts a visitor.

Retrieves the stored media associated with this node, if any.