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.

Return

the new Box node

Parameters

title
  • Optional

box title. If unset:

  • If the locale (docLanguage) is set and supported, the title is localized according to the box type

  • Otherwise, the box is untitled

type

box type. If unset, it defaults to a callout box

Values

  • callout
  • tip
  • note
  • warning
  • error
padding

padding around the box. If unset, the box uses the default padding

background
  • Optional

background color. If unset, the box uses the default color

foreground
  • Optional

foreground (text) color. If unset, the box uses the default color

body

box content

Wiki page

box