Background colors to use when inserting necessary padding.

Use the default background colors of the current terminal.

Use the same color for 8 and 256-color backgrounds.

A count of rows

How many Rod are in this Box?

A count of columns

How many columns are in this thing? A column is one character wide. Every Bar in a Box always has the same number of columns.

This is for things that have a single, solitary width, not things like columns that might have different widths at different points.

Alignment.

Vertical alignment.

Horizontal alignment.

Occupies a single row on screen. The Chunk you place in a Bar should not have any control characters such as newlines or tabs, as rainbox assumes that each character in a Bar takes up one screen column and that each character does not create newlines. Leave newline handling up to rainbox. However, rainbox will not check to make sure that your inputs do not contain newlines, tabs, or other spurious characters. Similarly, use of combining characters will create unexpected results, as Rainbox will see something that takes up (for instance) two characters and think it takes up two screen columns, when in reality it will take up only one screen column. So, if you need accented characters, use a single Unicode code point, not two code points. For example, for é, use U+00E9, not U+0065 and U+0301.

A Box has a width in columns and a height in rows. Its height and width both are always at least zero. It can have positive height even if its width is zero, and it can have positive width even if its height is zero.

Each row in a Box always has the same number of characters; a Box with zero height has no characters but still has a certain width.

A blank Box. Useful for aligning other Box.

A blank horizontal box with a given width and no height.

A blank vertical box with a given length.

A Box made of Chunk. Always one Bar tall, and has as many columns as there are characters in the Chunk.

A Box made of a single Chunk.

Merge several Box horizontally into one Box. That is, with alignment set to ATop:

 --- ------- ----
 --- -------
 ---

becomes

 --------------
 ----------....
 ---...........

With alignment set to ABottom, becomes

 ---...........
 ----------....
 --------------

Merge several Box vertically into one Box. That is, with alignment set to left:

 -------
 -------

 ---
 ---

 ----
 ----

becomes

 -------
 -------
 ---....
 ---....
 ---....
 ----...
 ----...

With alignment set to right, becomes

 -------
 -------
 ....---
 ....---
 ...----
 ...----

sepH sep a bs lays out bs horizontally with alignment a, with sep amount of space in between each.

sepV sep a bs lays out bs vertically with alignment a, with sep amount of space in between each.

punctuateH a p bs horizontally lays out the boxes bs with a copy of p interspersed between each.

A vertical version of punctuateH.

View a Box, possibly shrinking it. You set the size of your viewport and how it is oriented relative to the Box as a whole. The Box returned may be smaller than the argument Box, but it will never be bigger.

Examples:

>>> :set -XOverloadedStrings
>>> let box = catV defaultBackground top [ "ab", "cd" ]
>>> printBox . view (Height 1) (Width 1) left top $ box
a

>>> printBox . view (Height 1) (Width 1) right bottom $ box
d

Grow a box. Each dimension of the result Box is never smaller than the corresponding dimension of the input Box. Analogous to view, so you give the resulting dimensions that you want. The alignment is analogous to view; for instance, if you specify that the alignment is top and left, the extra padding is added to the right and bottom sides of the resulting Box.

Grow a Box horizontally.

Grow a Box vertically.

Returns a list of Box, each being exactly as wide as the widest Box in the input list.

Resize a Box. Will grow or trim it as necessary in order to reach the resulting size. Returns an empty Box if either Height or Width is less than 1.

Resize horizontally.

Resize vertically.

Convert a Box to Rainbow Chunks. You can then print it using putChunks or the like.

Prints a Box to standard output. If standard output is not a terminal, no colors are used. Otherwise, colors are used if your TERM environment variable suggests they are available.