1.14.1

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

Role

enum Role : Enum<NavigationContainer.Role> , RenderRepresentable

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

Roles improve accessibility, and enable specific features in renderers and themes.

Entries

TABLE_OF_CONTENTS

TABLE_OF_CONTENTS

Properties

val entries: EnumEntries<NavigationContainer.Role>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

val Enum<*>.kebabCaseName: String

Name of the enum in kebab-case. Example: TOP_LEFT_CORNER ->top-left-corner

val name: String

val ordinal: Int

val Enum<*>.quarkdownName: String

Functions

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

Accepts a visitor to produce a representation of this element suitable for the rendered document.

fun valueOf(value: String): NavigationContainer.Role

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

fun values(): Array<NavigationContainer.Role>

Returns an array containing the constants of this enum type, in the order they're declared.

fun Enum<*>.wrappedAsValue(): EnumValue