# Package-level declarations

## Functions

align
Link copied to clipboard

    .align alignment:{NodeStyle.Alignment} body:{MarkdownContent} -> Node

Content copied to clipboard

Aligns content and text within its parent.

box
Link copied to clipboard

    .box  title:{InlineMarkdownContent? = null} \
           type:{Box.Type = Box.Type.CALLOUT} \
        padding:{Size? = null} \
     background:{Color? = null} \
     foreground:{Color? = null} \
           body:{MarkdownContent}
    -> Node

Content copied to clipboard

Inserts content in a styled box.

center
Link copied to clipboard

    .center body:{MarkdownContent} -> Node

Content copied to clipboard

Centers content and text within its parent.

clip
Link copied to clipboard

    .clip clip:{Clipped.Clip} body:{MarkdownContent} -> Node

Content copied to clipboard

Applies a clipping path to its content.

collapse
Link copied to clipboard

    .collapse title:{InlineMarkdownContent} \
               open:{Boolean = false} \
               body:{MarkdownContent}
    -> Node

Content copied to clipboard

Inserts content in a collapsible block, whose content can be hidden or shown by interacting with it.

column
Link copied to clipboard

    .column alignment:{Stacked.MainAxisAlignment = Stacked.MainAxisAlignment.START} \
                cross:{Stacked.CrossAxisAlignment = Stacked.CrossAxisAlignment.CENTER} \
                  gap:{Size? = null} \
                 body:{MarkdownContent}
    -> Node

Content copied to clipboard

Stacks content vertically.

container
Link copied to clipboard

    .container width:{Size? = null} \
              height:{Size? = null} \
           fullwidth:{Boolean = false} \
               float:{Container.FloatAlignment? = null} \
            fullspan:{Boolean = false} \
           classname:{String? = null} \
          foreground:{Color? = null} \
          background:{Color? = null} \
              border:{Color? = null} \
         borderwidth:{Sizes? = null} \
         borderstyle:{NodeStyle.BorderStyle? = null} \
           alignment:{NodeStyle.Alignment? = null} \
       textalignment:{NodeStyle.TextAlignment? = null} \
              margin:{Sizes? = null} \
             padding:{Sizes? = null} \
              radius:{Sizes? = null} \
            fontsize:{TextTransformData.Size? = null} \
          fontweight:{TextTransformData.Weight? = null} \
           fontstyle:{TextTransformData.Style? = null} \
         fontvariant:{TextTransformData.Variant? = null} \
      textdecoration:{TextTransformData.Decoration? = null} \
            textcase:{TextTransformData.Case? = null} \
                body:{MarkdownContent? = null}
    -> Node

Content copied to clipboard

A general-purpose container that groups content.

float
Link copied to clipboard

    .float alignment:{Container.FloatAlignment} body:{MarkdownContent} -> Node

Content copied to clipboard

Turns content into a floating element, allowing subsequent content to wrap around it.

fullspan
Link copied to clipboard

    .fullspan body:{MarkdownContent} -> Node

Content copied to clipboard

Shorthand for container with `fullspan:{true}`. Makes content span across all columns in a multi-column layout.

grid
Link copied to clipboard

    .grid columns:{Int} \
        alignment:{Stacked.MainAxisAlignment = Stacked.MainAxisAlignment.CENTER} \
            cross:{Stacked.CrossAxisAlignment = Stacked.CrossAxisAlignment.CENTER} \
              gap:{Size? = null} \
             vgap:{Size? = gap} \
             hgap:{Size? = gap} \
             body:{MarkdownContent}
    -> Node

Content copied to clipboard

Stacks content in a grid layout.

landscape
Link copied to clipboard

    .landscape body:{MarkdownContent} -> Node

Content copied to clipboard

Transposes content to landscape orientation by rotating it 90 degrees counter-clockwise. This is useful for wide content, such as diagrams, that does not fit in the normal page orientation.

numbered
Link copied to clipboard

    .numbered key:{String} \
              ref:{String? = null} \
             body:{Lambda}
    -> Node

Content copied to clipboard

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

row
Link copied to clipboard

    .row alignment:{Stacked.MainAxisAlignment = Stacked.MainAxisAlignment.START} \
             cross:{Stacked.CrossAxisAlignment = Stacked.CrossAxisAlignment.CENTER} \
               gap:{Size? = null} \
              body:{MarkdownContent}
    -> Node

Content copied to clipboard

Stacks content horizontally.

table
Link copied to clipboard

    .table subTables:{Iterable<Any>} -> Node

Content copied to clipboard

Creates a table out of a collection of columns.

textcollapse
Link copied to clipboard

    .textcollapse full:{InlineMarkdownContent} \
                 short:{InlineMarkdownContent} \
                  open:{Boolean = false}
    -> Node

Content copied to clipboard

Inserts content in a collapsible text span, whose content can be expanded or collapsed by interacting with it.

todo
Link copied to clipboard

    .todo body:{MarkdownContent} -> Node

Content copied to clipboard

Creates a to do box, to mark content that needs to be done later, and also logs it to stdout.

whitespace
Link copied to clipboard

    .whitespace width:{Size? = null} height:{Size? = null} -> Node

Content copied to clipboard

An empty rectangle that adds whitespace to the layout.