quarkdown-core/com.quarkdown.core.ast.quarkdown.block/NavigationContainer

NavigationContainer

class NavigationContainer(val role: NavigationContainer.Role? = null, val children: List<Node>) : NestableNode

Creates a navigation container, which marks its content as a navigable section.

This doesn't affect the layout of the document by itself, but can be used by themes and renderers to provide additional navigation features, styling, behaviors and accessibility.

Constructors

NavigationContainer

constructor(role: NavigationContainer.Role? = null, children: List<Node>)

Types

Role

enum Role : Enum<NavigationContainer.Role> , RenderRepresentable

Role of the NavigationContainer, indicating its purpose in the document.

Properties

children

open override val children: List<Node>

role

val role: NavigationContainer.Role? = null

Functions

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

Accepts a visitor.

flattenedChildren

fun NestableNode.flattenedChildren(): Sequence<Node>

Returns a sequence of all nodes in the tree, where this is the root node. The sequence is generated by traversing the tree in depth-first order. The root node is excluded from the sequence.

getStoredMedia

fun Node.getStoredMedia(context: Context): StoredMedia?

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

wrappedAsValue

fun Node.wrappedAsValue(): NodeValue