Text to be laid out as a single paragraph.

May be divided into a hierarchy of boxes and spans.

The input text must be encoded as UTF-8 in a contiguous byte array.

You may need to use Data.Text.Internal in order to determine the byte array and the necessary offsets to construct the paragraph without copying data.

Alternatively, you can use constructParagraph with piecewise text.

Construct a Paragraph from a tree containing individual pieces of text, plus an optional prefix and suffix, all encoded as UTF-8.

This internally concatenates all input text into one contiguous byte array.

Alternatively, you can construct a Paragraph directly to avoid copying data.

Determines how the contents of the paragraph should be aligned horizontally, that is, how should fragments be stacked inside each line when there is space available.

This has no effect on lines with overflowing content.

Determines how an inline box affects the height of a line that would otherwise be empty.

Note that for this setting to have any effect, the box must be the ancestor of at least one (possibly empty) text sequence, so that it can generate a Fragment.

For CSS-compliant behaviour:

• Ensure that empty boxes contain empty text sequences as mentioned above. This can be achieved using the strut function.
• Set AllowBoxCollapse for boxes with zero margins, padding, and borders.
• Set AvoidBoxCollapse for boxes with non-zero margins, padding, or borders.

Note that BoxSpacing may contain zero values even when calculated from non-zero CSS values, because of rounding to integer values and/or because of adding together positive and negative values that cancel out. You should therefore compare the individual computed values for margins, padding, and borders with zero, and set boxCollapse to AllowBoxCollapse if and only if all these values are equal to zero.

Determines the amount of empty space to add around a box.

Determines how the contents of a line should be aligned vertically, that is, how fragments should fill (and possibly extend) the vertical space inside a line.

Vertical alignment takes place after line breaking.

Determines the preferred line height of text in the resulting layout.

Defines options relevant to the entire paragraph.

This record type is likely to be extended in the future. Use defaultParagraphOptions and update it with specific record selectors instead of constructing ParagraphOptions directly.

In order to get CSS defaults, use:

defaultParagraphOptions { paragraphAlignment = AlignStart }

ParagraphOptions with backwards-compatible values.

Note that this sets paragraphAlignment to AlignLeft, whereas the CSS default should be AlignStart.

Alignment of non-overflowing lines within the paragraph.

Line width at which line breaking should occur. Lines will be broken at language-appropriate boundaries. If a line still exceeds this limit then, it will be broken at character boundaries, and if it already consists of a single cluster that cannot be further broken down, it will overflow.

Root of the paragraph tree.

Non-root node of the paragraph tree.

A box with content and a defined format. Corresponds to a DOM element.

Data types that can represent an empty text sequence in a tree.

Insert an empty text sequence with the given user data into each empty box.

Style options to be applied to an inline box.

This record type is likely to be extended in the future. Use defaultBoxOptions and update it with specific record selectors instead of constructing BoxOptions directly.

In order to get CSS defaults, use:

defaultBoxOptions { boxVerticalAlignment = AlignBaseline 0 }

BoxOptions with backwards-compatible values.

Note that this sets boxVerticalAlignment to AlignLineTop, whereas the CSS default should be `AlignBaseline 0`.

Style options to be applied to a text sequence.

This record type is likely to be extended in the future. Use defaultTextOptions and update it with specific record selectors instead of constructing TextOptions directly.

TextOptions with default values.

Determines amount of empty space to add before the first fragment and/or after the last fragment of this box.

This can be used to reserve space for a left margin, border, and/or padding.

In order to get CSS-compliant behaviour, consider using activateBoxSpacing instead.

Determines how this box affects the height of a line that would otherwise be empty.

Determines how fragments are aligned vertically within a line.

Shorthand for updating boxSpacing and setting boxCollapse to AvoidBoxCollapse.

Can be used to activate CSS-compliant rendering of empty boxes whose spacing is calculated from non-zero values.

Font to be used for shaping and measurement. Make sure to set its scale (see optionScale) using the same units that you want in the output.

How much to add to the text's baseline coordinate to reach its ascender line. This is usually a positive value.

If set to Nothing, the font's own ascender metric will be used.

Setting an explicit value with Just x is intended as an override for situations where the text is intended to be replaced by an object with differently calculated dimensions.

How much to add to the text's baseline coordinate to reach its descender line. Note that this is usually a negative value because the descender is usually below the baseline.

If set to Nothing, the font's own descender metric will be used.

Setting an explicit value with Just x is intended as an override for situations where the text is intended to be replaced by an object with differently calculated dimensions.

Preferred line height of the resulting fragments.

IETF BCP 47 language tag, such as the value expected to be found in the HTML lang attribute, specifying the primary language for the span's text content. An empty string explicitly means "language unknown".

Used for selecting the appropriate glyphs and line breaking rules, primarily in East Asian languages.

Base text direction.

Used to determine which box fragment gets the left spacing and which gets the right spacing when broken over multiple lines.

When applied to the root box in a paragraph, this is also used to determine the base direction of the paragraph.

Calculate the offsets into the Paragraph's underlying Array where each text node starts and ends, in ascending order. The resulting list will be one larger than the number of text nodes in the input.

You can use this function to verify that Balkón will slice the input text correctly.

Turn each text node from the input Paragraph into a Text.

You can use this function to verify that Balkón will slice the input text correctly.

Turn all text nodes from the input Paragraph into one combined Text.

You can use this function to verify that Balkón will slice the input text correctly.

Lay out a rich text paragraph.

The resulting layout of the whole paragraph.

Width of the widest line, including spacing.

This is the smallest paragraphMaxWidth that will not introduce new line breaks.

When paragraphMaxWidth is set to maxBound, paragraphSafeWidth can be used to determine the max-content width of the paragraph for CSS.

Information about a line in a laid out paragraph.

A unit of text laid out in a rectangular area.

Roughly equivalent to the term text fragment as used in CSS Display Module Level 3.

An input span (or text sequence in CSS terms) can be broken into multiple fragments because of line breaking, because of bidirectional ordering, or because it contains glyphs from multiple scripts.

Physical position of the fragment within the paragraph, with spacing added to the glyph advances. This is the space that the fragment takes up in the paragraph.

Describes the relationship of a fragment to an inline box that contains it.

A box can have many fragments, and a fragment contained by a box is also contained by all ancestors of that box.

The root inline box, which forms the basis of each paragraph, is implied and not described by this type of record.

Describes either the absence, or the presence and size, of a box edge at a given position.