spruce/block

Block styling for multiline terminal text.

Types

Block

opaque </>

Options for rendering a multiline block.

pub opaque type Block

Values

align

</>

pub fn align(
  block: Block,
  horizontal horizontal: layout.Pos,
  vertical vertical: layout.Pos,
) -> Block

Align content horizontally within width and vertically within height.

background

</>

pub fn background(block: Block, color: style.Color) -> Block

Set the background color applied to content lines.

border

</>

pub fn border(block: Block, border: box.Border) -> Block

Draw a border around the padded block.

border_colors

</>

pub fn border_colors(
  block: Block,
  top top: style.Color,
  right right: style.Color,
  bottom bottom: style.Color,
  left left: style.Color,
) -> Block

Set top, right, bottom, and left border colors independently.

border_sides

</>

pub fn border_sides(
  block: Block,
  top top: Bool,
  right right: Bool,
  bottom bottom: Bool,
  left left: Bool,
) -> Block

Set top, right, bottom, and left border visibility independently.

foreground

</>

pub fn foreground(block: Block, color: style.Color) -> Block

Set the foreground color applied to content lines.

height

</>

pub fn height(block: Block, height: Int) -> Block

Constrain content to a line count. Short content is padded with blank lines using vertical alignment; tall content is truncated from the bottom after wrapping.

margin

</>

pub fn margin(
  block: Block,
  top top: Int,
  right right: Int,
  bottom bottom: Int,
  left left: Int,
) -> Block

Set outer margin as top, right, bottom, left cell counts.

new

</>

pub fn new() -> Block

Build block options with no styling, padding, margin, or border.

padding

</>

pub fn padding(
  block: Block,
  top top: Int,
  right right: Int,
  bottom bottom: Int,
  left left: Int,
) -> Block

Set inner padding as top, right, bottom, left cell counts.

render

</>

pub fn render(
  sp: spruce.Spruce,
  content: String,
  block: Block,
) -> String

Render content as one block using the given options.

width

</>

pub fn width(block: Block, width: Int) -> Block

Constrain content to a visual width and wrap with spruce/align.wrap.