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

Package-level declarations

Functions

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

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 box.

center

.center body:{MarkdownContent} -> Node

Centers content and text within its parent.

clip

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

Applies a clipping path to its content.

collapse

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

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}
-> Node

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)}
           float:{Container.FloatAlignment? = null}
            body:{MarkdownContent? = null}
-> Node

A general-purpose container that groups content. Any layout rules (e.g. from align, row, column, grid) are ignored inside this container.

figure

.figure caption:{String? = null} body:{MarkdownContent} -> Node

Inserts content in a figure block, which features an optional caption and can be numbered according to the figures numbering rules.

float

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

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

fullspan

.fullspan body:{MarkdownContent} -> Node

If the document has a multi-column layout (set via pageformat), makes content span across all columns in a multi-column layout. If the document has a single-column layout, the effect is the same as container.

grid

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

Stacks content in a grid layout. Each child is placed in a cell in a row, and a row ends when its cell count reaches columns.

numbered

.numbered key:{String} 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}
-> Node

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}
-> Node

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 logs it. The title is localized according to the current locale (doclang), or English as a fallback.

whitespace

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

An empty square that adds whitespace to the layout. If at least one of the dimensions is set, the square will have a fixed size. If both dimensions are unset, a blank character is used, which can be useful for spacing and adding line breaks.