color

Documentation

Index

• Constants
• func Blue() string
• func ByName(name string) string
• func ByNames(name ...string) string
• func Clear() string
• func Cyan() string
• func Green() string
• func Magenta() string
• func Red() string
• func Yellow() string
• type Parameter
  • func NewParameter(name string) Parameter
  • func (c Parameter) String() string

Constants

const Escape = "\x1b"

Functions

func Blue

func Blue() string

func ByName

func ByName(name string) string

func ByNames

func ByNames(name ...string) string

func Clear

func Clear() string

func Cyan

func Cyan() string

func Green

func Green() string

func Magenta

func Magenta() string

func Red

func Red() string

func Yellow

func Yellow() string

Types

type Parameter

type Parameter uint8

Parameter defines an SGR parameter. See: https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters

const (
	Reset Parameter = iota
	Bold
	Faint
	Italic
	Underline
	BlinkSlow
	BlinkRapid
	ReverseVideo
	Conceal
	CrossedOut
	PrimaryFont
)

Base params.

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

Foreground.

const (
	FgBBlack Parameter = iota + 90
	FgBRed
	FgBGreen
	FgBYellow
	FgBBlue
	FgBMagenta
	FgBCyan
	FgBWhite
)

Foreground Bright.

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

Background.

const (
	BgBBlack Parameter = iota + 100
	BgBRed
	BgBGreen
	BgBYellow
	BgBBlue
	BgBMagenta
	BgBCyan
	BgBWhite
)

Background Bright.

func NewParameter

func NewParameter(name string) Parameter

NewParameter returns a Parameter based on the given name. If the name doesn't match any value, the zero-value is returned.

func (Parameter) String

func (c Parameter) String() string

String implements the fmt.Stringer interface.