Tincture.Layout.Box.FlowResult (Tincture v0.1.0)

Copy Markdown View Source

What flow_text/7 and flow_across_boxes/4 managed to place.

overflow? is true when the text did not fit, and spill_text is what was left over — pass it to another box, or another page.

Summary

Types

t()

Types

t()

@type t() :: %Tincture.Layout.Box.FlowResult{
  box_results: [Tincture.Typography.LayoutResult.t()],
  boxes_used: non_neg_integer(),
  overflow?: boolean(),
  spill_text: String.t()
}