Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package notty
A is for attribute.
Construction and composition of styling characteristics of text.
Consult the basics for an overview.
TL;DR: A.(fg red ++ bg black ++ st bold).
Colors
One of 256 Xterm-style colors.
- The first 16 are supported on almost all terminals. The names are standardized, but the actual colors are not. The colors are often user-definable.
- The next 216 form a 6*6*6 color cube.
- The final 24 are a grayscale ramp.
Colors outside of the core 16 are widely, but not universally supported.
Note No attempt is made to remap colors depending on the terminal. Colors not recognized by a particular terminal will simply be ignored in the output.
Core 16 colors
The first 8 have their standard ANSI names.
val black : colorval red : colorval green : colorval yellow : colorval blue : colorval magenta : colorval cyan : colorval white : colorval lightblack : colorval lightred : colorval lightgreen : colorval lightyellow : colorval lightblue : colorval lightmagenta : colorval lightcyan : colorval lightwhite : colorExtended colors
val rgb : r:int -> g:int -> b:int -> colorrgb ~r:red ~g:green ~b:blue is an extended color from the color cube. All three components must be in the range 0-5.
val gray : int -> colorgray level is an extended color from the grayscale ramp. level must be in the range 0-23.
Text styles
val bold : styleval italic : styleval underline : styleval blink : styleval reverse : styleAttribute construction and composition
type t = attrval empty : attrempty is the attribute with the default foreground and background color and empty style set.
a1 ++ a2 is the concatenation of a1 and a2, the attribute that has a2's foreground (resp. background), unless unset, in which case it is a1's, and the union of both style sets.
++ and empty form a monoid. ++ is left-associative.