ct

README

go-colortext package

This is a package to change the color of the text and background in the console, working both under Windows and other systems.

Under Windows, the console APIs are used. Otherwise, ANSI texts are output.

Docs: http://godoc.org/github.com/daviddengcn/go-colortext (packages that import ct)

Usage:

ct.Foreground(Green, false)
fmt.Println("Green text starts here...")
ct.ChangeColor(Red, true, White, false)
fmt.Println(...)
ct.ResetColor()

LICENSE

BSD/MIT license

Documentation

Overview

ct package provides functions to change the color of console text.

Under windows platform, the Console API is used. Under other systems, ANSI text mode is used.

Index

• Constants
• Variables
• func Background(cl Color, bright bool)
• func ChangeColor(fg Color, fgBright bool, bg Color, bgBright bool)
• func Foreground(cl Color, bright bool)
• func ResetColor()
• type Color

Constants

const (
	// No change of color
	None = Color(iota)
	Black
	Red
	Green
	Yellow
	Blue
	Magenta
	Cyan
	White
)

Variables

var Writer io.Writer = os.Stdout

Writer is the io.Writer where ANSI escape codes will be written to

Functions

func Background

func Background(cl Color, bright bool)

Background changes the background color.

func ChangeColor

func ChangeColor(fg Color, fgBright bool, bg Color, bgBright bool)

ChangeColor sets the foreground and background colors. If the value of the color is None, the corresponding color keeps unchanged. If fgBright or bgBright is set true, corresponding color use bright color. bgBright may be ignored in some OS environment.

func Foreground

func Foreground(cl Color, bright bool)

Foreground changes the foreground color.

func ResetColor

func ResetColor()

ResetColor resets the foreground and background to original colors

Types

type Color

type Color int

Color is the type of color to be set.