color

package module
v1.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 21, 2020 License: MIT Imports: 9 Imported by: 2,553

README

CLI Color

GitHub go.mod Go version Actions Status Codacy Badge GoDoc GitHub tag (latest SemVer) Build Status Coverage Status Go Report Card

A command-line color library with true color support, universal API methods and Windows support.

中文说明

Basic color preview:

basic-color

Now, 256 colors and RGB colors have also been supported to work in Windows CMD and PowerShell:

color-on-cmd-pwsh

Features

  • Simple to use, zero dependencies
  • Supports rich color output: 16-color, 256-color, true color (24-bit, RGB)
    • 16-color output is the most commonly used and most widely supported, working on any Windows version
    • Since v1.2.4 the 256-color, true color (24-bit) support windows CMD and PowerShell
    • See this gist for information on true color support
  • Generic API methods: Print, Printf, Println, Sprint, Sprintf
  • Supports HTML tag-style color rendering, such as <green>message</>. Support working on windows cmd powerShell
  • Basic colors: Bold, Black, White, Gray, Red, Green, Yellow, Blue, Magenta, Cyan
  • Additional styles: Info, Note, Light, Error, Danger, Notice, Success, Comment, Primary, Warning, Question, Secondary

GoDoc

Install

go get github.com/gookit/color

Quick start

package main

import (
	"fmt"

	"github.com/gookit/color"
)

func main() {
	// quick use like fmt.Print*
	color.Red.Println("Simple to use color")
	color.Green.Print("Simple to use color\n")
	color.Cyan.Printf("Simple to use %s\n", "color")
	color.Yellow.Printf("Simple to use %s\n", "color")

	// use like func
	red := color.FgRed.Render
	green := color.FgGreen.Render
	fmt.Printf("%s line %s library\n", red("Command"), green("color"))

	// custom color
	color.New(color.FgWhite, color.BgBlack).Println("custom color style")

	// can also:
	color.Style{color.FgCyan, color.OpBold}.Println("custom color style")

	// internal theme/style:
	color.Info.Tips("message")
	color.Info.Prompt("message")
	color.Info.Println("message")
	color.Warn.Println("message")
	color.Error.Println("message")

	// use style tag
	color.Print("<suc>he</><comment>llo</>, <cyan>wel</><red>come</>\n")

	// apply a style tag
	color.Tag("info").Println("info style text")

	// prompt message
	color.Info.Prompt("prompt style message")
	color.Warn.Prompt("prompt style message")

	// tips message
	color.Info.Tips("tips style message")
	color.Warn.Tips("tips style message")
}

Run demo: go run ./_examples/demo.go

colored-out

Custom Build Color

// Only use foreground color
color.FgCyan.Printf("Simple to use %s\n", "color")
// Only use background color
color.BgRed.Printf("Simple to use %s\n", "color")

// Full custom: foreground, background, option
myStyle := color.New(color.FgWhite, color.BgBlack, color.OpBold)
myStyle.Println("custom color style")

// can also:
color.Style{color.FgCyan, color.OpBold}.Println("custom color style")

custom set console settings:

// set console color
color.Set(color.FgCyan)

// print message
fmt.Print("message")

// reset console settings
color.Reset()

Basic Color

Supported on any Windows version.

  • color.Bold
  • color.Black
  • color.White
  • color.Gray
  • color.Red
  • color.Green
  • color.Yellow
  • color.Blue
  • color.Magenta
  • color.Cyan
color.Bold.Println("bold message")
color.Yellow.Println("yellow message")

Run demo: go run ./_examples/basiccolor.go

basic-color

Additional styles

Supported on any Windows version.

  • color.Info
  • color.Note
  • color.Warn
  • color.Light
  • color.Error
  • color.Danger
  • color.Debug
  • color.Notice
  • color.Success
  • color.Comment
  • color.Primary
  • color.Question
  • color.Secondary
Basic Style

print message use defined style:

color.Info.Println("Info message")
color.Note.Println("Note message")
color.Notice.Println("Notice message")
color.Error.Println("Error message")
color.Danger.Println("Danger message")
color.Warn.Println("Warn message")
color.Debug.Println("Debug message")
color.Primary.Println("Primary message")
color.Question.Println("Question message")
color.Secondary.Println("Secondary message")

Run demo: go run ./_examples/theme_basic.go

theme-basic

Tips Style
color.Info.Tips("Info tips message")
color.Note.Tips("Note tips message")
color.Notice.Tips("Notice tips message")
color.Error.Tips("Error tips message")
color.Danger.Tips("Danger tips message")
color.Warn.Tips("Warn tips message")
color.Debug.Tips("Debug tips message")
color.Primary.Tips("Primary tips message")
color.Question.Tips("Question tips message")
color.Secondary.Tips("Secondary tips message")

Run demo: go run ./_examples/theme_tips.go

theme-tips

Prompt Style
color.Info.Prompt("Info prompt message")
color.Note.Prompt("Note prompt message")
color.Notice.Prompt("Notice prompt message")
color.Error.Prompt("Error prompt message")
color.Danger.Prompt("Danger prompt message")
color.Warn.Prompt("Warn prompt message")
color.Debug.Prompt("Debug prompt message")
color.Primary.Prompt("Primary prompt message")
color.Question.Prompt("Question prompt message")
color.Secondary.Prompt("Secondary prompt message")

Run demo: go run ./_examples/theme_prompt.go

theme-prompt

Block Style
color.Info.Block("Info block message")
color.Note.Block("Note block message")
color.Notice.Block("Notice block message")
color.Error.Block("Error block message")
color.Danger.Block("Danger block message")
color.Warn.Block("Warn block message")
color.Debug.Block("Debug block message")
color.Primary.Block("Primary block message")
color.Question.Block("Question block message")
color.Secondary.Block("Secondary block message")

Run demo: go run ./_examples/theme_block.go

theme-block

HTML-like tag usage

Supported on Windows cmd.exe PowerShell .

// use style tag
color.Print("<suc>he</><comment>llo</>, <cyan>wel</><red>come</>")
color.Println("<suc>hello</>")
color.Println("<error>hello</>")
color.Println("<warning>hello</>")

// custom color attributes
color.Print("<fg=yellow;bg=black;op=underscore;>hello, welcome</>\n")
  • color.Tag
// set a style tag
color.Tag("info").Print("info style text")
color.Tag("info").Printf("%s style text", "info")
color.Tag("info").Println("info style text")

Run demo: go run ./_examples/colortag.go

color-tags

256-color usage

256 colors support Windows CMD, PowerShell environment after v1.2.4

Set the foreground or background color
  • color.C256(val uint8, isBg ...bool) Color256
c := color.C256(132) // fg color
c.Println("message")
c.Printf("format %s", "message")

c := color.C256(132, true) // bg color
c.Println("message")
c.Printf("format %s", "message")
Use a 256-color style

Can be used to set foreground and background colors at the same time.

  • color.S256(fgAndBg ...uint8) *Style256
s := color.S256(32, 203)
s.Println("message")
s.Printf("format %s", "message")

Run demo: go run ./_examples/color256.go

color-tags

Use RGB color

RGB colors support Windows CMD, PowerShell environment after v1.2.4

Preview:

Run demo: Run demo: go run ./_examples/color_rgb.go

color-rgb

example:

color.RGB(30, 144, 255).Println("message. use RGB number")

color.HEX("#1976D2").Println("blue-darken")
color.HEX("#D50000", true).Println("red-accent. use HEX style")

color.RGBStyleFromString("213,0,0").Println("red-accent. use RGB number")
color.HEXStyle("eee", "D50000").Println("deep-purple color")
Set the foreground or background color
  • color.RGB(r, g, b uint8, isBg ...bool) RGBColor
c := color.RGB(30,144,255) // fg color
c.Println("message")
c.Printf("format %s", "message")

c := color.RGB(30,144,255, true) // bg color
c.Println("message")
c.Printf("format %s", "message")

Create a style from an hexadecimal color string:

  • color.HEX(hex string, isBg ...bool) RGBColor
c := color.HEX("ccc") // can also: "cccccc" "#cccccc"
c.Println("message")
c.Printf("format %s", "message")

c = color.HEX("aabbcc", true) // as bg color
c.Println("message")
c.Printf("format %s", "message")
Use an RGB color style

Can be used to set the foreground and background colors at the same time.

  • color.NewRGBStyle(fg RGBColor, bg ...RGBColor) *RGBStyle
s := color.NewRGBStyle(RGB(20, 144, 234), RGB(234, 78, 23))
s.Println("message")
s.Printf("format %s", "message")

Create a style from an hexadecimal color string:

  • color.HEXStyle(fg string, bg ...string) *RGBStyle
s := color.HEXStyle("11aa23", "eee")
s.Println("message")
s.Printf("format %s", "message")

Func refer

there are some useful functions reference

  • Disable() disable color render
  • SetOutput(io.Writer) custom set the colored text output writer
  • ForceOpenColor() force open color render
  • ClearCode(str string) string Use for clear color codes
  • ClearTag(s string) string clear all color html-tag for a string
  • IsConsole(w io.Writer) Determine whether w is one of stderr, stdout, stdin
  • HexToRgb(hex string) (rgb []int) Convert hex color string to RGB numbers
  • RgbToHex(rgb []int) string Convert RGB to hex code

Gookit packages

  • gookit/ini Go config management, use INI files
  • gookit/rux Simple and fast request router for golang HTTP
  • gookit/gcli build CLI application, tool library, running CLI commands
  • gookit/event Lightweight event manager and dispatcher implements by Go
  • gookit/cache Generic cache use and cache manager for golang. support File, Memory, Redis, Memcached.
  • gookit/config Go config management. support JSON, YAML, TOML, INI, HCL, ENV and Flags
  • gookit/color A command-line color library with true color support, universal API methods and Windows support
  • gookit/filter Provide filtering, sanitizing, and conversion of golang data
  • gookit/validate Use for data validation and filtering. support Map, Struct, Form data
  • gookit/goutil Some utils for the Go: string, array/slice, map, format, cli, env, filesystem, test and more
  • More please see https://github.com/gookit

See also

License

MIT

Documentation

Overview

Package color is Command line color library. Support rich color rendering output, universal API method, compatible with Windows system

Source code and other details for the project are available at GitHub: 

https://github.com/gookit/color

More usage please see README and tests.

Example 
// quick use like fmt.Print*
Red.Println("Simple to use color")
Green.Print("Simple to use color")
Cyan.Printf("Simple to use %s\n", "color")
Gray.Printf("Simple to use %s\n", "color")
Blue.Printf("Simple to use %s\n", "color")
Yellow.Printf("Simple to use %s\n", "color")
Magenta.Printf("Simple to use %s\n", "color")

// use like func
red := FgRed.Render
green := FgGreen.Render
fmt.Printf("%s line %s library\n", red("Command"), green("color"))

// custom color
New(FgWhite, BgBlack).Println("custom color style")

// can also:
Style{FgCyan, OpBold}.Println("custom color style")

// internal theme/style:
Info.Tips("message")
Info.Prompt("message")
Info.Println("info message")
Warn.Println("warning message")
Error.Println("error message")
Danger.Println("danger message")

// use style tag
Print("<suc>he</><comment>llo</>, <cyan>wel</><red>come</>\n")

// apply a style tag
Tag("info").Println("info style text")

// prompt message
Info.Prompt("prompt style message")
Warn.Prompt("prompt style message")

// tips message
Info.Tips("tips style message")
Warn.Tips("tips style message")

Output:

Index

Examples

Constants

View Source 
const (
	SettingTpl   = "\x1b[%sm"
	FullColorTpl = "\x1b[%sm%s\x1b[0m"
)

color render templates ESC 操作的表示: 

"\033"(Octal 8进制) = "\x1b"(Hexadecimal 16进制) = 27 (10进制)
View Source 
const (
	Red     = FgRed
	Cyan    = FgCyan
	Gray    = FgDarkGray // is light Black
	Blue    = FgBlue
	Black   = FgBlack
	Green   = FgGreen
	White   = FgWhite
	Yellow  = FgYellow
	Magenta = FgMagenta

	Bold   = OpBold
	Normal = FgDefault

	LightRed     = FgLightRed
	LightCyan    = FgLightCyan
	LightBlue    = FgLightBlue
	LightGreen   = FgLightGreen
	LightWhite   = FgLightWhite
	LightYellow  = FgLightYellow
	LightMagenta = FgLightMagenta
)

There are basic and light foreground color aliases

View Source 
const (
	TplFg256 = "38;5;%d"
	TplBg256 = "48;5;%d"
)

tpl for 8 bit 256 color(`2^8`)

format: 

	ESC[ … 38;5;<n> … m // 选择前景色
 ESC[ … 48;5;<n> … m // 选择背景色

example: 

fg "\x1b[38;5;242m"
bg "\x1b[48;5;208m"
both "\x1b[38;5;242;48;5;208m"

links: 

https://zh.wikipedia.org/wiki/ANSI%E8%BD%AC%E4%B9%89%E5%BA%8F%E5%88%97#8位
View Source 
const (
	TplFgRGB = "38;2;%d;%d;%d"
	TplBgRGB = "48;2;%d;%d;%d"
)

24 bit RGB color RGB: 

R 0-255 G 0-255 B 0-255
R 00-FF G 00-FF B 00-FF (16进制)

Format: 

ESC[ … 38;2;<r>;<g>;<b> … m // Select RGB foreground color
ESC[ … 48;2;<r>;<g>;<b> … m // Choose RGB background color

links: 

https://zh.wikipedia.org/wiki/ANSI%E8%BD%AC%E4%B9%89%E5%BA%8F%E5%88%97#24位

example: 

fg: \x1b[38;2;30;144;255mMESSAGE\x1b[0m
bg: \x1b[48;2;30;144;255mMESSAGE\x1b[0m
both: \x1b[38;2;233;90;203;48;2;30;144;255mMESSAGE\x1b[0m
View Source 
const (
	AsFg uint8 = iota
	AsBg
)

mark color is fg or bg.

View Source 
const (
	// MatchExpr regex to match color tags
	// Notice: golang 不支持反向引用.  即不支持使用 \1 引用第一个匹配 ([a-z=;]+)
	// MatchExpr = `<([a-z=;]+)>(.*?)<\/\1>`
	// 所以调整一下 统一使用 `</>` 来结束标签，例如 "<info>some text</>"
	// 支持自定义颜色属性的tag "<fg=white;bg=blue;op=bold>content</>"
	// (?s:...) s - 让 "." 匹配换行
	MatchExpr = `<([a-zA-Z_=,;]+)>(?s:(.*?))<\/>`

	// AttrExpr regex to match color attributes
	AttrExpr = `(fg|bg|op)[\s]*=[\s]*([a-zA-Z,]+);?`

	// StripExpr regex used for removing color tags
	// StripExpr = `<[\/]?[a-zA-Z=;]+>`
	// 随着上面的做一些调整
	StripExpr = `<[\/]?[a-zA-Z_=,;]*>`
)

output colored text like use html tag. (not support windows cmd)

View Source 
const CodeExpr = `\033\[[\d;?]+m`

CodeExpr regex to clear color codes eg "\033[1;36mText\x1b[0m"

View Source 
const ResetSet = "\x1b[0m"

ResetSet Close all properties.

Variables

View Source 
var (
	// Enable switch color render and display
	Enable = true
	// RenderTag render HTML tag on call color.Xprint, color.PrintX
	RenderTag = true
)
View Source 
var (
	// Info color style
	Info = &Theme{"info", Style{OpReset, FgGreen}}
	// Note color style
	Note = &Theme{"note", Style{OpBold, FgLightCyan}}
	// Warn color style
	Warn = &Theme{"warning", Style{OpBold, FgYellow}}
	// Light color style
	Light = &Theme{"light", Style{FgLightWhite, BgBlack}}
	// Error color style
	Error = &Theme{"error", Style{FgLightWhite, BgRed}}
	// Danger color style
	Danger = &Theme{"danger", Style{OpBold, FgRed}}
	// Debug color style
	Debug = &Theme{"debug", Style{OpReset, FgCyan}}
	// Notice color style
	Notice = &Theme{"notice", Style{OpBold, FgCyan}}
	// Comment color style
	Comment = &Theme{"comment", Style{OpReset, FgLightYellow}}
	// Success color style
	Success = &Theme{"success", Style{OpBold, FgGreen}}
	// Primary color style
	Primary = &Theme{"primary", Style{OpReset, FgBlue}}
	// Question color style
	Question = &Theme{"question", Style{OpReset, FgMagenta}}
	// Secondary color style
	Secondary = &Theme{"secondary", Style{FgDarkGray}}
)

internal themes(like bootstrap style) Usage: 

color.Info.Print("message")
color.Info.Printf("a %s message", "test")
color.Warn.Println("message")
color.Error.Println("message")
View Source 
var BgColors = map[string]Color{
	"black":   BgBlack,
	"red":     BgRed,
	"green":   BgGreen,
	"yellow":  BgYellow,
	"blue":    BgBlue,
	"magenta": BgMagenta,
	"cyan":    BgCyan,
	"white":   BgWhite,
	"default": BgDefault,
}

BgColors background colors map

View Source 
var ExBgColors = map[string]Color{
	"darkGray":     BgDarkGray,
	"lightRed":     BgLightRed,
	"lightGreen":   BgLightGreen,
	"lightYellow":  BgLightYellow,
	"lightBlue":    BgLightBlue,
	"lightMagenta": BgLightMagenta,
	"lightCyan":    BgLightCyan,
	"lightWhite":   BgLightWhite,
}

ExBgColors extra background colors map

View Source 
var ExFgColors = map[string]Color{
	"darkGray":     FgDarkGray,
	"lightRed":     FgLightRed,
	"lightGreen":   FgLightGreen,
	"lightYellow":  FgLightYellow,
	"lightBlue":    FgLightBlue,
	"lightMagenta": FgLightMagenta,
	"lightCyan":    FgLightCyan,
	"lightWhite":   FgLightWhite,
}

ExFgColors extra foreground colors map

View Source 
var FgColors = map[string]Color{
	"black":   FgBlack,
	"red":     FgRed,
	"green":   FgGreen,
	"yellow":  FgYellow,
	"blue":    FgBlue,
	"magenta": FgMagenta,
	"cyan":    FgCyan,
	"white":   FgWhite,
	"default": FgDefault,
}

FgColors foreground colors map

View Source 
var Options = map[string]Color{
	"reset":      OpReset,
	"bold":       OpBold,
	"fuzzy":      OpFuzzy,
	"italic":     OpItalic,
	"underscore": OpUnderscore,
	"blink":      OpBlink,
	"reverse":    OpReverse,
	"concealed":  OpConcealed,
}

Options color options map

View Source 
var Styles = map[string]Style{
	"info":  {OpReset, FgGreen},
	"note":  {OpBold, FgLightCyan},
	"light": {FgLightWhite, BgRed},
	"error": {FgLightWhite, BgRed},

	"danger":  {OpBold, FgRed},
	"notice":  {OpBold, FgCyan},
	"success": {OpBold, FgGreen},
	"comment": {OpReset, FgMagenta},
	"primary": {OpReset, FgBlue},
	"warning": {OpBold, FgYellow},

	"question":  {OpReset, FgMagenta},
	"secondary": {FgDarkGray},
}

Styles internal defined styles, like bootstrap styles. Usage: 

color.Styles["info"].Println("message")
View Source 
var Themes = map[string]*Theme{
	"info":  Info,
	"note":  Note,
	"light": Light,
	"error": Error,

	"debug":   Debug,
	"danger":  Danger,
	"notice":  Notice,
	"success": Success,
	"comment": Comment,
	"primary": Primary,
	"warning": Warn,

	"question":  Question,
	"secondary": Secondary,
}

Themes internal defined themes. Usage: 

color.Themes["info"].Println("message")

Functions

func AddStyle 

func AddStyle(name string, s Style)

AddStyle add a style

func AddTheme added in v1.1.1 

func AddTheme(name string, style Style)

AddTheme add a theme and style

func ApplyTag 

func ApplyTag(tag string, a ...interface{}) string

ApplyTag for messages

func ClearCode 

func ClearCode(str string) string

ClearCode clear color codes. eg: 

"\033[36;1mText\x1b[0m" -> "Text"

func ClearTag 

func ClearTag(s string) string

ClearTag clear all tag for a string

func Disable 

func Disable() bool

Disable disable color output

func Errorf added in v1.2.6 

func Errorf(format string, a ...interface{})

Errorf print message with Error style

func Errorln added in v1.0.1 

func Errorln(a ...interface{})

Errorln print message with Error style

func ForceColor added in v1.2.8 

func ForceColor() bool

ForceColor force open color render

func ForceOpenColor added in v1.1.11 

func ForceOpenColor() bool

ForceOpenColor force open color render

func Fprint 

func Fprint(w io.Writer, a ...interface{})

Fprint print rendered messages to writer Notice: will ignore print error

func Fprintf 

func Fprintf(w io.Writer, format string, a ...interface{})

Fprintf print format and rendered messages to writer. Notice: will ignore print error

func Fprintln 

func Fprintln(w io.Writer, a ...interface{})

Fprintln print rendered messages line to writer Notice: will ignore print error

func GetColorTags 

func GetColorTags() map[string]string

GetColorTags get all internal color tags

func GetErrors added in v1.3.0 

func GetErrors() []error

GetErrors info

func GetTagCode added in v1.1.2 

func GetTagCode(name string) string

GetTagCode get color code by tag name

func Hex2rgb added in v1.2.6 

func Hex2rgb(hex string) []int

Hex2rgb alias of the HexToRgb()

func HexToRGB added in v1.1.2 

func HexToRGB(hex string) []int

HexToRGB alias of the HexToRgb()

func HexToRgb added in v1.2.6 

func HexToRgb(hex string) (rgb []int)

HexToRgb convert hex color string to RGB numbers Usage: 

rgb := HexToRgb("ccc") // rgb: [204 204 204]
rgb := HexToRgb("aabbcc") // rgb: [170 187 204]
rgb := HexToRgb("#aabbcc") // rgb: [170 187 204]
rgb := HexToRgb("0xad99c0") // rgb: [170 187 204]

func Infof added in v1.2.6 

func Infof(format string, a ...interface{})

Infof print message with Info style

func Infoln added in v1.0.1 

func Infoln(a ...interface{})

Infoln print message with Info style

func IsConsole added in v1.1.2 

func IsConsole(w io.Writer) bool

IsConsole Determine whether w is one of stderr, stdout, stdin

func IsDefinedTag 

func IsDefinedTag(name string) bool

IsDefinedTag is defined tag name

func IsLikeInCmd added in v1.2.6 

func IsLikeInCmd() bool

IsLikeInCmd check result

func IsMSys added in v1.1.2 

func IsMSys() bool

IsMSys msys(MINGW64) environment, does not necessarily support color

func IsSupport256Color added in v1.1.2 

func IsSupport256Color() bool

IsSupport256Color render

func IsSupportColor added in v1.1.2 

func IsSupportColor() bool

IsSupportColor check current console is support color.

Supported: 

linux, mac, or windows's ConEmu, Cmder, putty, git-bash.exe

Not support: 

windows cmd.exe, powerShell.exe

func IsSupportTrueColor added in v1.2.1 

func IsSupportTrueColor() bool

IsSupportTrueColor render. IsSupportRGBColor

func IsTerminal added in v1.1.11 

func IsTerminal(_ int) bool

IsTerminal check currently is terminal

func Lprint added in v1.2.3 

func Lprint(l *log.Logger, a ...interface{})

Lprint passes colored messages to a log.Logger for printing. Notice: should be goroutine safe

func NotRenderTag added in v1.2.8 

func NotRenderTag()

NotRenderTag on call color.Xprint, color.PrintX

func ParseCodeFromAttr 

func ParseCodeFromAttr(attr string) (code string)

ParseCodeFromAttr parse color attributes. attr like: 

"fg=VALUE;bg=VALUE;op=VALUE" // VALUE please see var: FgColors, BgColors, Options

eg: 

"fg=yellow"
"bg=red"
"op=bold,underscore" option is allow multi value
"fg=white;bg=blue;op=bold"
"fg=white;op=bold,underscore"

func Print 

func Print(a ...interface{})

Print render color tag and print messages

func Printf 

func Printf(format string, a ...interface{})

Printf format and print messages

func Println 

func Println(a ...interface{})

Println messages with new line

func Render 

func Render(a ...interface{}) string

Render parse color tags, return rendered string. Usage: 

text := Render("<info>hello</> <cyan>world</>!")
fmt.Println(text)

func RenderCode added in v1.1.2 

func RenderCode(code string, args ...interface{}) string

RenderCode render message by color code. Usage: 

msg := RenderCode("3;32;45", "some", "message")

func RenderString added in v1.1.2 

func RenderString(code string, str string) string

RenderString render a string with color code. Usage: 

msg := RenderString("3;32;45", "a message")

func RenderWithSpaces added in v1.1.11 

func RenderWithSpaces(code string, args ...interface{}) string

RenderWithSpaces Render code with spaces. If the number of args is > 1, a space will be added between the args

func ReplaceTag 

func ReplaceTag(str string) string

ReplaceTag parse string, replace color tag and return rendered string

func Reset 

func Reset() (int, error)

Reset reset console color attributes

func ResetOptions added in v1.2.8 

func ResetOptions()

ResetOptions reset all package option setting

func ResetOutput added in v1.2.0 

func ResetOutput()

ResetOutput reset output

func Rgb2hex added in v1.2.6 

func Rgb2hex(rgb []int) string

Rgb2hex alias of the RgbToHex()

func RgbToHex added in v1.2.6 

func RgbToHex(rgb []int) string

RgbToHex convert RGB to hex code Usage: 

hex := RgbToHex([]int{170, 187, 204}) // hex: "aabbcc"

func Set 

func Set(colors ...Color) (int, error)

Set set console color attributes

func SetOutput added in v1.2.0 

func SetOutput(w io.Writer)

SetOutput set default colored text output

func Sprint added in v1.1.1 

func Sprint(args ...interface{}) string

Sprint parse color tags, return rendered string

func Sprintf added in v1.1.1 

func Sprintf(format string, a ...interface{}) string

Sprintf format and return rendered string

func String added in v1.1.1 

func String(s string) string

String alias of the ReplaceTag

func Text added in v1.1.2 

func Text(s string) string

Text alias of the ReplaceTag

func Warnf added in v1.2.6 

func Warnf(format string, a ...interface{})

Warnf print message with Warn style

func Warnln added in v1.0.1 

func Warnln(a ...interface{})

Warnln print message with Warn style

func WrapTag 

func WrapTag(s string, tag string) string

WrapTag wrap a tag for a string "<tag>content</>"

Types

type Color 

type Color uint8

Color Color16, 16 color value type 3(2^3=8) OR 4(2^4=16) bite color. 

const (
	FgBlack Color = iota + 30
	FgRed
	FgGreen
	FgYellow
	FgBlue
	FgMagenta // 品红
	FgCyan    // 青色
	FgWhite
	// FgDefault revert default FG
	FgDefault Color = 39
)

Foreground colors. basic foreground colors 30 - 37 

const (
	FgDarkGray Color = iota + 90 // 亮黑（灰）
	FgLightRed
	FgLightGreen
	FgLightYellow
	FgLightBlue
	FgLightMagenta
	FgLightCyan
	FgLightWhite
	// FgGray is alias of FgDarkGray
	FgGray Color = 90 // 亮黑（灰）
)

Extra foreground color 90 - 97(非标准) 

const (
	BgBlack Color = iota + 40
	BgRed
	BgGreen
	BgYellow // BgBrown like yellow
	BgBlue
	BgMagenta
	BgCyan
	BgWhite
	// BgDefault revert default BG
	BgDefault Color = 49
)

Background colors. basic background colors 40 - 47 

const (
	BgDarkGray Color = iota + 100
	BgLightRed
	BgLightGreen
	BgLightYellow
	BgLightBlue
	BgLightMagenta
	BgLightCyan
	BgLightWhite
	// BgGray is alias of BgDarkGray
	BgGray Color = 100
)

Extra background color 100 - 107(非标准) 

const (
	OpReset         Color = iota // 0 重置所有设置
	OpBold                       // 1 加粗
	OpFuzzy                      // 2 模糊(不是所有的终端仿真器都支持)
	OpItalic                     // 3 斜体(不是所有的终端仿真器都支持)
	OpUnderscore                 // 4 下划线
	OpBlink                      // 5 闪烁
	OpFastBlink                  // 5 快速闪烁(未广泛支持)
	OpReverse                    // 7 颠倒的 交换背景色与前景色
	OpConcealed                  // 8 隐匿的
	OpStrikethrough              // 9 删除的，删除线(未广泛支持)
)

Option settings

func (Color) Code added in v1.1.11 

func (c Color) Code() string

Code convert to code string. eg "35"

func (Color) Darken added in v1.1.4 

func (c Color) Darken() Color

Darken current color. eg. 96(FgLightCyan) -> 36(FgCyan) Usage: 

cyan := LightCyan.Darken()
cyan.Print("message")

func (Color) IsValid 

func (c Color) IsValid() bool

IsValid color value

func (Color) Light added in v1.1.4 

func (c Color) Light() Color

Light current color. eg: 36(FgCyan) -> 96(FgLightCyan). Usage: 

lightCyan := Cyan.Light()
lightCyan.Print("message")

func (Color) Print 

func (c Color) Print(args ...interface{})

Print messages. Usage: 

color.Green.Print("message")

OR: 

green := color.FgGreen.Print
green("message")

func (Color) Printf 

func (c Color) Printf(format string, a ...interface{})

Printf format and print messages. Usage: 

color.Cyan.Printf("string %s", "arg0")

func (Color) Println 

func (c Color) Println(a ...interface{})

Println messages with new line

func (Color) Render 

func (c Color) Render(a ...interface{}) string

Render messages by color setting Usage: 

green := color.FgGreen.Render
fmt.Println(green("message"))

func (Color) Renderln added in v1.1.11 

func (c Color) Renderln(a ...interface{}) string

Renderln messages by color setting. like Println, will add spaces for each argument Usage: 

green := color.FgGreen.Renderln
fmt.Println(green("message"))

func (Color) Sprint added in v1.1.2 

func (c Color) Sprint(a ...interface{}) string

Sprint render messages by color setting. is alias of the Render()

func (Color) Sprintf added in v1.1.2 

func (c Color) Sprintf(format string, args ...interface{}) string

Sprintf format and render message. Usage: 

	green := color.Green.Sprintf
 colored := green("message")

func (Color) String 

func (c Color) String() string

String convert to code string. eg "35"

func (Color) Text added in v1.1.2 

func (c Color) Text(message string) string

Text render a text message

type Color256 added in v1.1.2 

type Color256 [2]uint8

Color256 256 (8 bit) color, uint8 range at 0 - 255

颜色值使用10进制和16进制都可 0x98 = 152

颜色有两位uint8组成: 

0: color value
1: color type, Fg=0 Bg=1
>1: unset value

example: 

	fg color: [152, 0]
 bg color: [152, 1]

NOTICE: now support 256 color on windows CMD, PowerShell

func Bit8 added in v1.1.2 

func Bit8(val uint8, isBg ...bool) Color256

Bit8 create a color256

func C256 added in v1.1.2 

func C256(val uint8, isBg ...bool) Color256

C256 create a color256

func (Color256) IsEmpty added in v1.1.2 

func (c Color256) IsEmpty() bool

IsEmpty value

func (Color256) Print added in v1.1.2 

func (c Color256) Print(a ...interface{})

Print print message

func (Color256) Printf added in v1.1.2 

func (c Color256) Printf(format string, a ...interface{})

Printf format and print message

func (Color256) Println added in v1.1.2 

func (c Color256) Println(a ...interface{})

Println print message with newline

func (Color256) Sprint added in v1.1.2 

func (c Color256) Sprint(a ...interface{}) string

Sprint returns rendered message

func (Color256) Sprintf added in v1.1.2 

func (c Color256) Sprintf(format string, a ...interface{}) string

Sprintf returns format and rendered message

func (Color256) String added in v1.1.2 

func (c Color256) String() string

String convert to color code string.

func (Color256) Value added in v1.1.2 

func (c Color256) Value() uint8

Value return color value

type Printer added in v1.1.3 

type Printer struct {
	// ColorCode color code string. eg "32;45;3"
	ColorCode string
}

Printer a generic color message printer. Usage: 

p := &Printer{"32;45;3"}
p.Print("message")

func NewPrinter added in v1.1.4 

func NewPrinter(colorCode string) *Printer

NewPrinter instance

func (*Printer) IsEmpty added in v1.1.4 

func (p *Printer) IsEmpty() bool

IsEmpty color code

func (*Printer) Print added in v1.1.3 

func (p *Printer) Print(a ...interface{})

Print rendering colored messages

func (*Printer) Printf added in v1.1.3 

func (p *Printer) Printf(format string, a ...interface{})

Printf format and rendering colored messages

func (*Printer) Println added in v1.1.3 

func (p *Printer) Println(a ...interface{})

Println rendering colored messages with newline

func (*Printer) Sprint added in v1.1.3 

func (p *Printer) Sprint(a ...interface{}) string

Sprint returns rendering colored messages

func (*Printer) Sprintf added in v1.1.3 

func (p *Printer) Sprintf(format string, a ...interface{}) string

Sprintf returns format and rendering colored messages

func (*Printer) String added in v1.1.3 

func (p *Printer) String() string

String returns color code string. eg: "32;45;3"

type PrinterFace added in v1.1.3 

type PrinterFace interface {
	fmt.Stringer
	Sprint(a ...interface{}) string
	Sprintf(format string, a ...interface{}) string
	Print(a ...interface{})
	Printf(format string, a ...interface{})
	Println(a ...interface{})
}

PrinterFace interface

type RGBColor added in v1.1.2 

type RGBColor [4]uint8

RGBColor definition.

The first to third digits represent the color value. The last digit represents the foreground(0), background(1), >1 is unset value

Usage: 

// 0, 1, 2 is R,G,B.
// 3rd: Fg=0, Bg=1, >1: unset value
RGBColor{30,144,255, 0}
RGBColor{30,144,255, 1}

NOTICE: now support RGB color on windows CMD, PowerShell

func HEX added in v1.1.2 

func HEX(hex string, isBg ...bool) RGBColor

HEX create RGB color from a HEX color string. Usage: 

c := HEX("ccc") // rgb: [204 204 204]
c := HEX("aabbcc") // rgb: [170 187 204]
c := HEX("#aabbcc")
c := HEX("0xaabbcc")
c.Print("message")

func RGB added in v1.1.2 

func RGB(r, g, b uint8, isBg ...bool) RGBColor

RGB color create. Usage: 

c := RGB(30,144,255)
c := RGB(30,144,255, true)
c.Print("message")

func RGBFromString added in v1.1.3 

func RGBFromString(rgb string, isBg ...bool) RGBColor

RGBFromString create RGB color from a string. Usage: 

c := RGBFromString("170,187,204")
c.Print("message")

func (RGBColor) C256 added in v1.2.6 

func (c RGBColor) C256() Color256

C256 returns the closest approximate 256 (8 bit) color

func (RGBColor) Code added in v1.1.11 

func (c RGBColor) Code() string

Code to color code string

func (RGBColor) IsEmpty added in v1.1.2 

func (c RGBColor) IsEmpty() bool

IsEmpty value

func (RGBColor) Print added in v1.1.2 

func (c RGBColor) Print(a ...interface{})

Print print message

func (RGBColor) Printf added in v1.1.2 

func (c RGBColor) Printf(format string, a ...interface{})

Printf format and print message

func (RGBColor) Println added in v1.1.2 

func (c RGBColor) Println(a ...interface{})

Println print message with newline

func (RGBColor) Sprint added in v1.1.2 

func (c RGBColor) Sprint(a ...interface{}) string

Sprint returns rendered message

func (RGBColor) Sprintf added in v1.1.2 

func (c RGBColor) Sprintf(format string, a ...interface{}) string

Sprintf returns format and rendered message

func (RGBColor) String added in v1.1.2 

func (c RGBColor) String() string

String to color code string

func (RGBColor) Values added in v1.1.2 

func (c RGBColor) Values() []int

Values to RGB values

type RGBStyle added in v1.1.2 

type RGBStyle struct {
	// Name of the style
	Name string
	// contains filtered or unexported fields
}

RGBStyle definition.

Foreground/Background color All are composed of 4 digits uint8, the first three digits are the color value; The last bit is different from RGBColor, here it indicates whether the value is set. - 1 Has been set - ^1 Not set

func HEXStyle added in v1.1.3 

func HEXStyle(fg string, bg ...string) *RGBStyle

HEXStyle create a RGBStyle from HEX color string. Usage: 

s := HEXStyle("aabbcc", "eee")
s.Print("message")

func NewRGBStyle added in v1.1.3 

func NewRGBStyle(fg RGBColor, bg ...RGBColor) *RGBStyle

NewRGBStyle create a RGBStyle.

func RGBStyleFromString added in v1.1.3 

func RGBStyleFromString(fg string, bg ...string) *RGBStyle

RGBStyleFromString create a RGBStyle from color value string. Usage: 

s := RGBStyleFromString("170,187,204", "70,87,4")
s.Print("message")

func (*RGBStyle) Code added in v1.1.11 

func (s *RGBStyle) Code() string

Code convert to color code string

func (*RGBStyle) IsEmpty added in v1.1.3 

func (s *RGBStyle) IsEmpty() bool

IsEmpty style

func (*RGBStyle) Print added in v1.1.3 

func (s *RGBStyle) Print(a ...interface{})

Print print message

func (*RGBStyle) Printf added in v1.1.3 

func (s *RGBStyle) Printf(format string, a ...interface{})

Printf format and print message

func (*RGBStyle) Println added in v1.1.3 

func (s *RGBStyle) Println(a ...interface{})

Println print message with newline

func (*RGBStyle) Set added in v1.1.3 

func (s *RGBStyle) Set(fg, bg RGBColor) *RGBStyle

Set fg and bg color

func (*RGBStyle) SetBg added in v1.1.3 

func (s *RGBStyle) SetBg(bg RGBColor) *RGBStyle

SetBg set bg color

func (*RGBStyle) SetFg added in v1.1.3 

func (s *RGBStyle) SetFg(fg RGBColor) *RGBStyle

SetFg set fg color

func (*RGBStyle) Sprint added in v1.1.3 

func (s *RGBStyle) Sprint(a ...interface{}) string

Sprint returns rendered message

func (*RGBStyle) Sprintf added in v1.1.3 

func (s *RGBStyle) Sprintf(format string, a ...interface{}) string

Sprintf returns format and rendered message

func (*RGBStyle) String added in v1.1.2 

func (s *RGBStyle) String() string

String convert to color code string

type Style 

type Style []Color

Style a 16 color style. can add: fg color, bg color, color options

Example: 

color.Style{color.FgGreen}.Print("message")

func GetStyle 

func GetStyle(name string) Style

GetStyle get defined style by name

func New 

func New(colors ...Color) Style

New create a custom style

Usage: 

color.New(color.FgGreen).Print("message")
equals to:
color.Style{color.FgGreen}.Print("message")

func (Style) Code added in v1.1.11 

func (s Style) Code() string

Code convert to code string. returns like "32;45;3"

func (Style) IsEmpty added in v1.1.0 

func (s Style) IsEmpty() bool

IsEmpty style

func (Style) Print 

func (s Style) Print(a ...interface{})

Print render and Print text

func (Style) Printf 

func (s Style) Printf(format string, a ...interface{})

Printf render and print text

func (Style) Println 

func (s Style) Println(a ...interface{})

Println render and print text line

func (Style) Render 

func (s Style) Render(a ...interface{}) string

Render render text Usage: 

color.New(color.FgGreen).Render("text")
color.New(color.FgGreen, color.BgBlack, color.OpBold).Render("text")

func (Style) Renderln added in v1.1.11 

func (s Style) Renderln(a ...interface{}) string

Renderln render text line. like Println, will add spaces for each argument Usage: 

color.New(color.FgGreen).Renderln("text", "more")
color.New(color.FgGreen, color.BgBlack, color.OpBold).Render("text", "more")

func (Style) Save 

func (s Style) Save(name string)

Save to styles map

func (Style) Sprint added in v1.1.0 

func (s Style) Sprint(a ...interface{}) string

Sprint is alias of the 'Render'

func (Style) Sprintf added in v1.1.3 

func (s Style) Sprintf(format string, a ...interface{}) string

Sprintf format and render message.

func (Style) String added in v1.1.2 

func (s Style) String() string

String convert to code string. returns like "32;45;3"

type Style256 added in v1.1.2 

type Style256 struct {

	// Name of the style
	Name string
	// contains filtered or unexported fields
}

Style256 definition

前/背景色 都是由两位uint8组成, 第一位是色彩值； 第二位与Bit8Color不一样的是，在这里表示是否设置了值 0 未设置 ^0 已设置

func S256 added in v1.1.2 

func S256(fgAndBg ...uint8) *Style256

S256 create a color256 style Usage: 

s := color.S256()
s := color.S256(132) // fg
s := color.S256(132, 203) // fg and bg

func (*Style256) Code added in v1.1.11 

func (s *Style256) Code() string

Code convert to color code string

func (*Style256) Print added in v1.1.2 

func (s *Style256) Print(a ...interface{})

Print print message

func (*Style256) Printf added in v1.1.2 

func (s *Style256) Printf(format string, a ...interface{})

Printf format and print message

func (*Style256) Println added in v1.1.2 

func (s *Style256) Println(a ...interface{})

Println print message with newline

func (*Style256) Set added in v1.1.2 

func (s *Style256) Set(fgVal, bgVal uint8) *Style256

Set fg and bg color value

func (*Style256) SetBg added in v1.1.2 

func (s *Style256) SetBg(bgVal uint8) *Style256

SetBg set bg color value

func (*Style256) SetFg added in v1.1.2 

func (s *Style256) SetFg(fgVal uint8) *Style256

SetFg set fg color value

func (*Style256) Sprint added in v1.1.2 

func (s *Style256) Sprint(a ...interface{}) string

Sprint returns rendered message

func (*Style256) Sprintf added in v1.1.2 

func (s *Style256) Sprintf(format string, a ...interface{}) string

Sprintf returns format and rendered message

func (*Style256) String added in v1.1.2 

func (s *Style256) String() string

String convert to color code string

type Tag 

type Tag string

Tag value is a defined style name Usage: 

Tag("info").Println("message")

func (Tag) Print 

func (tg Tag) Print(a ...interface{})

Print messages

func (Tag) Printf 

func (tg Tag) Printf(format string, a ...interface{})

Printf format and print messages

func (Tag) Println 

func (tg Tag) Println(a ...interface{})

Println messages line

func (Tag) Sprint added in v1.1.0 

func (tg Tag) Sprint(a ...interface{}) string

Sprint render messages

func (Tag) Sprintf added in v1.1.4 

func (tg Tag) Sprintf(format string, a ...interface{}) string

Sprintf format and render messages

type Theme added in v1.1.1 

type Theme struct {
	// Name theme name
	Name string
	// Style for the theme
	Style
}

Theme definition. extends from Style

func GetTheme added in v1.1.1 

func GetTheme(name string) *Theme

GetTheme get defined theme by name

func NewTheme added in v1.1.1 

func NewTheme(name string, style Style) *Theme

NewTheme instance

func (*Theme) Block added in v1.1.1 

func (t *Theme) Block(format string, a ...interface{})

Block like Prompt, but will wrap a empty line

func (*Theme) Prompt added in v1.1.1 

func (t *Theme) Prompt(format string, a ...interface{})

Prompt use name as title, and apply style for message

func (*Theme) Save added in v1.1.2 

func (t *Theme) Save()

Save to themes map

func (*Theme) Tips added in v1.1.1 

func (t *Theme) Tips(format string, a ...interface{})

Tips use name as title, only apply style for name

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.