ansi

Documentation

Overview

Package ansi can print colored and styled text to your terminal.

Index

• Constants
• func BgColor(str interface{}, col Col) string
• func Bold(str interface{}) string
• func Color(str interface{}, col Col) string
• func Log(valuea ...interface{}) interface{}
• func Set(str interface{}, Attribute ...Col) string
• func Underline(str interface{}) string
• type Col

Constants

const (
	Black = Col(iota)
	Red
	Green
	Yellow
	Blue
	Magenta
	Cyan
	White
)

defines supported colors

const (
	TReset = Col(iota)
	TBold
	TFaint
	TItalic
	TUnderline
	TBlinkSlow
	TBlinkFast
	TNegative
	TConceal
	TCrossedOut
)

defines text styling options

const (
	FgBlack = Col(iota + 30)
	FgRed
	FgGreen
	FgYellow
	FgBlue
	FgMagenta
	FgCyan
	FgWhite
)

Foreground text colors

const (
	BgBlack = Col(iota + 40)
	BgRed
	BgGreen
	BgYellow
	BgBlue
	BgMagenta
	BgCyan
	BgWhite
)

Background text colors

Functions

func BgColor

func BgColor(str interface{}, col Col) string

BgColor adds the color code of col as background color to str and returns as string

func Bold

func Bold(str interface{}) string

Bold surrounds str with the code for bold styled text

func Color

func Color(str interface{}, col Col) string

Color adds the color code of col as text color to str and returns as string

func Log

func Log(valuea ...interface{}) interface{}

Log prints red text via log package

func Set

func Set(str interface{}, Attribute ...Col) string

Set sets styling options on strings and stringable interfaces

func Underline

func Underline(str interface{}) string

Underline surrounds str with the code for underlined text

Types

type Col

type Col int

Col defines supported colors