color

Documentation

Index

• Variables
• func Escape(s string) string
• func Format(s ...interface{}) string
• type Attribute

Variables

var (
	// NoColor defines if the output is colorized or not.
	NoColor = false

	// NoColorFlag is set by the global --no-color
	NoColorFlag = false
)

var BlockPalette = [][]Attribute{
	[]Attribute{BgHiRed, FgBlack},
	[]Attribute{BgHiGreen, FgBlack},
	[]Attribute{BgHiYellow, FgBlack},
	[]Attribute{BgHiBlue, FgBlack},
	[]Attribute{BgHiMagenta, FgBlack},
}

BlockPalette is a basic text on background palette of colors for terminal

var TextPalette = [][]Attribute{
	[]Attribute{FgHiRed},
	[]Attribute{FgHiGreen},
	[]Attribute{FgHiYellow},
	[]Attribute{FgHiBlue},
	[]Attribute{FgHiMagenta},
}

TextPalette is a basic foreground-only palette of colors for terminal

Functions

func Escape

func Escape(s string) string

Escape text for terminal

func Format

func Format(s ...interface{}) string

Format text for terminal

Types

type Attribute

type Attribute int

Attribute defines a single SGR Code

const (
	Reset Attribute = iota
	Bold
	Faint
	Italic
	Underline
	BlinkSlow
	BlinkRapid
	ReverseVideo
	Concealed
	CrossedOut
)

Base attributes

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

Foreground text colors

const (
	FgHiBlack Attribute = iota + 90
	FgHiRed
	FgHiGreen
	FgHiYellow
	FgHiBlue
	FgHiMagenta
	FgHiCyan
	FgHiWhite
)

Foreground Hi-Intensity text colors

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

Background text colors

const (
	BgHiBlack Attribute = iota + 100
	BgHiRed
	BgHiGreen
	BgHiYellow
	BgHiBlue
	BgHiMagenta
	BgHiCyan
	BgHiWhite
)

Background Hi-Intensity text colors