Console.Display

Displaying utilities

Documentation

data TerminalDisplay

Terminal display state

Basic

displayInit :: IO TerminalDisplay

Create a new display

display :: TerminalDisplay -> [OutputElem] -> IO ()

Display

displayTextColor :: TerminalDisplay -> Color -> String -> IO ()

A simple utility that display a msg in color

displayLn :: TerminalDisplay -> Color -> String -> IO ()

A simple utility that display a msg in color and newline at the end.

Progress Bar

data ProgressBar

Progress bar widget

progress :: TerminalDisplay -> Int -> (ProgressBar -> IO a) -> IO a

Create a new progress bar context

progressTick :: ProgressBar -> IO ()

Tick an element on the progress bar

Summary line

data Summary

Summary

summary :: TerminalDisplay -> IO Summary

Create a summary

summarySet :: Summary -> [OutputElem] -> IO ()

Set the summary

Attributes

data Color :: *

Constructors

Black

Red

Green

Yellow

Blue

Magenta

Cyan

White

ColorNumber Int

Instances

Eq Color

Ord Color

Show Color

data OutputElem

Element to output text and attributes to the display

Constructors

Bg Color

Fg Color

T String

LeftT Int String

RightT Int String

NA

Instances

Eq OutputElem

Show OutputElem

termText :: String -> TermOutput

justify :: Justify -> Int -> String -> String

box a string to a specific size, choosing the justification

Table

data Justify

Justify position

Constructors

JustifyLeft

JustifyRight

data Table

Table widget

data Column

Column for a table

columnNew :: Int -> String -> Column

Create a new column setting the right default parameters

tableCreate :: [Column] -> Table

Create a new table

tableHeaders :: TerminalDisplay -> Table -> IO ()

Show the table headers

tableAppend :: TerminalDisplay -> Table -> [String] -> IO ()

Append a row to the table.

if the number of elements is greater than the amount of column the table has been configured with, the extra elements are dropped.