quarkdown-stdlib/com.quarkdown.stdlib.module.Layout

Package-level declarations

Functions

.align alignment:{Container.Alignment} body:{MarkdownContent} -> <Error class: unknown class>

Aligns content and text within its parent.

box

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

Inserts content in a styled box.

center

.center body:{MarkdownContent} -> <Error class: unknown class>

Centers content and text within its parent.

clip

.clip clip:{Clipped.Clip} body:{MarkdownContent} -> <Error class: unknown class>

Applies a clipping path to its content.

collapse

.collapse title:{InlineMarkdownContent} \
           open:{Boolean = false} \
           body:{MarkdownContent}
-> <Error class: unknown class>

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

column

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

Stacks content vertically.

container

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

A general-purpose container that groups content.

float

.float alignment:{Container.FloatAlignment} body:{MarkdownContent} -> <Error class: unknown class>

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

fullspan

.fullspan body:{MarkdownContent} -> <Error class: unknown class>

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

grid

.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}
-> Nothing

Stacks content in a grid layout.

landscape

.landscape body:{MarkdownContent} -> <Error class: unknown class>

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

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

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

row

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

Stacks content horizontally.

table

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

Creates a table out of a collection of columns.

textcollapse

.textcollapse full:{InlineMarkdownContent} \
             short:{InlineMarkdownContent} \
              open:{Boolean = false}
-> <Error class: unknown class>

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

todo

.todo body:{MarkdownContent} -> Node

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

whitespace

.whitespace width:{Size? = null} height:{Size? = null} -> <Error class: unknown class>

An empty rectangle that adds whitespace to the layout.