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

Package-level declarations

Types

class Box(val title: InlineContent?, val type: Box.Type, val padding: Size? = null, val backgroundColor: Color? = null, val foregroundColor: Color? = null, val children: List<Node>) : NestableNode

A generic box that contains content.

Clipped

class Clipped(val clip: Clipped.Clip, val children: List<Node>) : NestableNode

A block whose content is clipped in a path.

Collapse

class Collapse(val title: InlineContent, val isOpen: Boolean, val children: List<Node>) : NestableNode

A collapsible block, whose content can be hidden or shown by interacting with it.

Container

class Container(val width: Size? = null, val height: Size? = null, val fullWidth: Boolean = false, val foregroundColor: Color? = null, val backgroundColor: Color? = null, val borderColor: Color? = null, val borderWidth: Sizes? = null, val borderStyle: Container.BorderStyle? = null, val margin: Sizes? = null, val padding: Sizes? = null, val cornerRadius: Sizes? = null, val alignment: Container.Alignment? = null, val textAlignment: Container.Alignment? = null, val float: Container.FloatAlignment? = null, val children: List<Node>) : NestableNode

A general-purpose container that groups content.

Figure

abstract class Figure<T : Node>(val child: T) : SingleChildNestableNode<T> , LocationTrackableNode, CaptionableNode

A block which displays a single child, with an optional caption. If the caption is provided, the block is numbered.

FullColumnSpan

class FullColumnSpan(val children: List<Node>) : NestableNode

When this node is rendered in a multi-column layout, makes its content span across all columns.

ImageFigure

class ImageFigure(child: Image) : Figure<Image>

An optionally-numbered block which displays a single image, with an optional caption.

Math

class Math(val expression: String) : Node

A math (TeX) block.

MermaidDiagram

class MermaidDiagram(val code: String) : Node

A Mermaid diagram.

MermaidDiagramFigure

class MermaidDiagramFigure(child: MermaidDiagram, val caption: String? = null) : Figure<MermaidDiagram>

An optionally-numbered block which displays a single Mermaid diagram, with an optional caption.

Numbered

class Numbered(val key: String, val children: (location: String) -> List<Node>) : LocationTrackableNode

Node that can be numbered depending on its location in the document and the amount of occurrences according to its key.

PageBreak

class PageBreak : Node

A forced page break.

SlidesFragment

class SlidesFragment(val behavior: SlidesFragment.Behavior, val children: List<Node>) : NestableNode

A node that, when rendered in a Slides environment, is displayed when the user attempts to go to the next slide. Multiple fragments in the same slide are shown in order on distinct user interactions.

Stacked

class Stacked(val layout: Stacked.Layout, val mainAxisAlignment: Stacked.MainAxisAlignment, val crossAxisAlignment: Stacked.CrossAxisAlignment, val gap: Size?, val children: List<Node>) : NestableNode

A block that contains nodes grouped together according to the given layout.