colorman

Documentation

Index

• Variables
• func AddColors(col ColorValue, str string) string
• func AppendColor(str string, col ColorValue) string
• func IsColorized(word string) bool
• type ColorStruct
  • func (s *ColorStruct) GetValue() ColorValue
• type ColorType
• type ColorValue
  • func ColorGetter(col ColorType, font FontType) ColorValue
• type FontType

Variables

var (
	RESET       ColorValue = "\x1b[0m"
	COL_GREY    ColorValue = ColorGetter(BLACK, REGULAR)
	COL_GREEN              = ColorGetter(GREEN, REGULAR)
	COL_RED                = ColorGetter(RED, REGULAR)
	COL_RED_BB             = ColorGetter(RED, BRIGHT_BACKGROUND)
	COL_BLUE_B             = ColorGetter(BLUE, BACKGROUND)
	COL_BLUE_U             = ColorGetter(BLUE, UNDERLINE)
	COL_GREEN_B            = ColorGetter(GREEN, BACKGROUND)
	COL_CYAN               = ColorGetter(CYAN, REGULAR)
)

var (
	COL_BOOL_TRUE  ColorValue = RESET + ColorGetter(GREEN, REGULAR)
	COL_BOOL_FALSE            = RESET + ColorGetter(RED, REGULAR)
	COL_SETYPE                = ColorGetter(BLUE, BRIGHT_BACKGROUND) + ColorGetter(WHITE, REGULAR)
	COL_DEEP_LIM              = ColorGetter(BLACK, BRIGHT_BACKGROUND) + ColorGetter(BLACK, UNDERLINE)
)

Functions

func AddColors

func AddColors(col ColorValue, str string) string

func AppendColor

func AppendColor(str string, col ColorValue) string

func IsColorized

func IsColorized(word string) bool

Types

type ColorStruct

type ColorStruct struct {
	// contains filtered or unexported fields
}

func (*ColorStruct) GetValue

func (s *ColorStruct) GetValue() ColorValue

type ColorType

type ColorType int

const (
	BLACK ColorType = iota
	RED
	GREEN
	YELLOW
	BLUE
	PURPLE
	CYAN
	WHITE

	DEFAULT
)

type ColorValue

type ColorValue string

func ColorGetter

func ColorGetter(col ColorType, font FontType) ColorValue

type FontType

type FontType int

const (
	REGULAR FontType = iota
	UNDERLINE
	BACKGROUND
	BRIGHT_BACKGROUND
)