TableOfContents

data class TableOfContents(val items: List<TableOfContents.Item>)

A summary of the document's structure. Each item links to a section.

Parameters

items

root sections in the document

Constructors

Link copied to clipboard
constructor(items: List<TableOfContents.Item>)

Types

Link copied to clipboard
object Companion
Link copied to clipboard
data class Item(val text: InlineContent, val target: Identifiable, val depth: Int, val subItems: List<TableOfContents.Item> = emptyList())

An item in the table of contents, usually associated to a section of the document.

Properties

Link copied to clipboard