README
¶
CLI Color
A command-line color library with true color support, universal API methods and Windows support.
Basic color preview:
Now, 256 colors and RGB colors have also been supported to work in Windows CMD and PowerShell:
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.4the 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 windowscmdpowerShell - 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 gitee.com/lorock/color
Quick start
package main
import (
"fmt"
"gitee.com/lorock/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
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.Boldcolor.Blackcolor.Whitecolor.Graycolor.Redcolor.Greencolor.Yellowcolor.Bluecolor.Magentacolor.Cyan
color.Bold.Println("bold message")
color.Yellow.Println("yellow message")
Run demo: go run ./_examples/basiccolor.go
Additional styles
Supported on any Windows version.
color.Infocolor.Notecolor.Warncolor.Lightcolor.Errorcolor.Dangercolor.Debugcolor.Noticecolor.Successcolor.Commentcolor.Primarycolor.Questioncolor.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
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
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
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
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
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
Use RGB color
RGB colors support Windows
CMD,PowerShellenvironment afterv1.2.4
Preview:
Run demo:
Run demo: go run ./_examples/color_rgb.go
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 renderSetOutput(io.Writer)custom set the colored text output writerForceOpenColor()force open color renderClearCode(str string) stringUse for clear color codesClearTag(s string) stringclear all color html-tag for a stringIsConsole(w io.Writer)Determine whether w is one of stderr, stdout, stdinHexToRgb(hex string) (rgb []int)Convert hex color string to RGB numbersRgbToHex(rgb []int) stringConvert 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://gitee.com/lorock
See also
License
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://gitee.com/lorock/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 ¶
- Constants
- Variables
- func AddStyle(name string, s Style)
- func AddTheme(name string, style Style)
- func ApplyTag(tag string, a ...interface{}) string
- func ClearCode(str string) string
- func ClearTag(s string) string
- func Disable() bool
- func Errorf(format string, a ...interface{})
- func Errorln(a ...interface{})
- func ForceColor() bool
- func ForceOpenColor() bool
- func Fprint(w io.Writer, a ...interface{})
- func Fprintf(w io.Writer, format string, a ...interface{})
- func Fprintln(w io.Writer, a ...interface{})
- func GetColorTags() map[string]string
- func GetErrors() []error
- func GetTagCode(name string) string
- func Hex2rgb(hex string) []int
- func HexToRGB(hex string) []int
- func HexToRgb(hex string) (rgb []int)
- func Infof(format string, a ...interface{})
- func Infoln(a ...interface{})
- func IsConsole(w io.Writer) bool
- func IsDefinedTag(name string) bool
- func IsLikeInCmd() bool
- func IsMSys() bool
- func IsSupport256Color() bool
- func IsSupportColor() bool
- func IsSupportTrueColor() bool
- func IsTerminal(_ int) bool
- func Lprint(l *log.Logger, a ...interface{})
- func NotRenderTag()
- func ParseCodeFromAttr(attr string) (code string)
- func Print(a ...interface{})
- func Printf(format string, a ...interface{})
- func Println(a ...interface{})
- func Render(a ...interface{}) string
- func RenderCode(code string, args ...interface{}) string
- func RenderString(code string, str string) string
- func RenderWithSpaces(code string, args ...interface{}) string
- func ReplaceTag(str string) string
- func Reset() (int, error)
- func ResetOptions()
- func ResetOutput()
- func Rgb2hex(rgb []int) string
- func RgbToHex(rgb []int) string
- func Set(colors ...Color) (int, error)
- func SetOutput(w io.Writer)
- func Sprint(args ...interface{}) string
- func Sprintf(format string, a ...interface{}) string
- func String(s string) string
- func Text(s string) string
- func Warnf(format string, a ...interface{})
- func Warnln(a ...interface{})
- func WrapTag(s string, tag string) string
- type Color
- func (c Color) Code() string
- func (c Color) Darken() Color
- func (c Color) IsValid() bool
- func (c Color) Light() Color
- func (c Color) Print(args ...interface{})
- func (c Color) Printf(format string, a ...interface{})
- func (c Color) Println(a ...interface{})
- func (c Color) Render(a ...interface{}) string
- func (c Color) Renderln(a ...interface{}) string
- func (c Color) Sprint(a ...interface{}) string
- func (c Color) Sprintf(format string, args ...interface{}) string
- func (c Color) String() string
- func (c Color) Text(message string) string
- type Color256
- func (c Color256) IsEmpty() bool
- func (c Color256) Print(a ...interface{})
- func (c Color256) Printf(format string, a ...interface{})
- func (c Color256) Println(a ...interface{})
- func (c Color256) Sprint(a ...interface{}) string
- func (c Color256) Sprintf(format string, a ...interface{}) string
- func (c Color256) String() string
- func (c Color256) Value() uint8
- type Printer
- func (p *Printer) IsEmpty() bool
- func (p *Printer) Print(a ...interface{})
- func (p *Printer) Printf(format string, a ...interface{})
- func (p *Printer) Println(a ...interface{})
- func (p *Printer) Sprint(a ...interface{}) string
- func (p *Printer) Sprintf(format string, a ...interface{}) string
- func (p *Printer) String() string
- type PrinterFace
- type RGBColor
- func (c RGBColor) C256() Color256
- func (c RGBColor) Code() string
- func (c RGBColor) IsEmpty() bool
- func (c RGBColor) Print(a ...interface{})
- func (c RGBColor) Printf(format string, a ...interface{})
- func (c RGBColor) Println(a ...interface{})
- func (c RGBColor) Sprint(a ...interface{}) string
- func (c RGBColor) Sprintf(format string, a ...interface{}) string
- func (c RGBColor) String() string
- func (c RGBColor) Values() []int
- type RGBStyle
- func (s *RGBStyle) Code() string
- func (s *RGBStyle) IsEmpty() bool
- func (s *RGBStyle) Print(a ...interface{})
- func (s *RGBStyle) Printf(format string, a ...interface{})
- func (s *RGBStyle) Println(a ...interface{})
- func (s *RGBStyle) Set(fg, bg RGBColor) *RGBStyle
- func (s *RGBStyle) SetBg(bg RGBColor) *RGBStyle
- func (s *RGBStyle) SetFg(fg RGBColor) *RGBStyle
- func (s *RGBStyle) Sprint(a ...interface{}) string
- func (s *RGBStyle) Sprintf(format string, a ...interface{}) string
- func (s *RGBStyle) String() string
- type Style
- func (s Style) Code() string
- func (s Style) IsEmpty() bool
- func (s Style) Print(a ...interface{})
- func (s Style) Printf(format string, a ...interface{})
- func (s Style) Println(a ...interface{})
- func (s Style) Render(a ...interface{}) string
- func (s Style) Renderln(a ...interface{}) string
- func (s Style) Save(name string)
- func (s Style) Sprint(a ...interface{}) string
- func (s Style) Sprintf(format string, a ...interface{}) string
- func (s Style) String() string
- type Style256
- func (s *Style256) Code() string
- func (s *Style256) Print(a ...interface{})
- func (s *Style256) Printf(format string, a ...interface{})
- func (s *Style256) Println(a ...interface{})
- func (s *Style256) Set(fgVal, bgVal uint8) *Style256
- func (s *Style256) SetBg(bgVal uint8) *Style256
- func (s *Style256) SetFg(fgVal uint8) *Style256
- func (s *Style256) Sprint(a ...interface{}) string
- func (s *Style256) Sprintf(format string, a ...interface{}) string
- func (s *Style256) String() string
- type Tag
- type Theme
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 Errorf ¶ added in v1.3.1
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 ForceOpenColor ¶ added in v1.3.1
func ForceOpenColor() bool
ForceOpenColor force open color render
func Fprintf ¶
Fprintf print format and rendered messages to writer. Notice: will ignore print error
func GetTagCode ¶ added in v1.1.2
GetTagCode get color code by tag name
func HexToRgb ¶ added in v1.3.1
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.3.1
func Infof(format string, a ...interface{})
Infof print message with Info style
func IsMSys ¶ added in v1.1.2
func IsMSys() bool
IsMSys msys(MINGW64) environment, does not necessarily support color
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.3.1
func IsSupportTrueColor() bool
IsSupportTrueColor render. IsSupportRGBColor
func IsTerminal ¶ added in v1.3.1
IsTerminal check currently is terminal
func Lprint ¶ added in v1.3.1
Lprint passes colored messages to a log.Logger for printing. Notice: should be goroutine safe
func NotRenderTag ¶ added in v1.3.1
func NotRenderTag()
NotRenderTag on call color.Xprint, color.PrintX
func ParseCodeFromAttr ¶
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 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
RenderCode render message by color code. Usage:
msg := RenderCode("3;32;45", "some", "message")
func RenderString ¶ added in v1.1.2
RenderString render a string with color code. Usage:
msg := RenderString("3;32;45", "a message")
func RenderWithSpaces ¶ added in v1.3.1
RenderWithSpaces Render code with spaces. If the number of args is > 1, a space will be added between the args
func ReplaceTag ¶
ReplaceTag parse string, replace color tag and return rendered string
func ResetOptions ¶ added in v1.3.1
func ResetOptions()
ResetOptions reset all package option setting
func RgbToHex ¶ added in v1.3.1
RgbToHex convert RGB to hex code Usage:
hex := RgbToHex([]int{170, 187, 204}) // hex: "aabbcc"
func Sprint ¶ added in v1.1.1
func Sprint(args ...interface{}) string
Sprint parse color tags, return rendered string
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) Darken ¶ added in v1.1.4
Darken current color. eg. 96(FgLightCyan) -> 36(FgCyan) Usage:
cyan := LightCyan.Darken()
cyan.Print("message")
func (Color) Light ¶ added in v1.1.4
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 ¶
Printf format and print messages. Usage:
color.Cyan.Printf("string %s", "arg0")
func (Color) Render ¶
Render messages by color setting Usage:
green := color.FgGreen.Render
fmt.Println(green("message"))
func (Color) Renderln ¶ added in v1.3.1
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
Sprint render messages by color setting. is alias of the Render()
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 (Color256) Print ¶ added in v1.1.2
func (c Color256) Print(a ...interface{})
Print print message
func (Color256) Println ¶ added in v1.1.2
func (c Color256) Println(a ...interface{})
Println print message with newline
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 (*Printer) Print ¶ added in v1.1.3
func (p *Printer) Print(a ...interface{})
Print rendering colored messages
func (*Printer) Println ¶ added in v1.1.3
func (p *Printer) Println(a ...interface{})
Println rendering colored messages with newline
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
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
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
RGBFromString create RGB color from a string. Usage:
c := RGBFromString("170,187,204")
c.Print("message")
func (RGBColor) Print ¶ added in v1.1.2
func (c RGBColor) Print(a ...interface{})
Print print message
func (RGBColor) Println ¶ added in v1.1.2
func (c RGBColor) Println(a ...interface{})
Println print message with newline
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
HEXStyle create a RGBStyle from HEX color string. Usage:
s := HEXStyle("aabbcc", "eee")
s.Print("message")
func NewRGBStyle ¶ added in v1.1.3
NewRGBStyle create a RGBStyle.
func RGBStyleFromString ¶ added in v1.1.3
RGBStyleFromString create a RGBStyle from color value string. Usage:
s := RGBStyleFromString("170,187,204", "70,87,4")
s.Print("message")
func (*RGBStyle) Print ¶ added in v1.1.3
func (s *RGBStyle) Print(a ...interface{})
Print print message
func (*RGBStyle) Println ¶ added in v1.1.3
func (s *RGBStyle) Println(a ...interface{})
Println print message with newline
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 New ¶
New create a custom style
Usage:
color.New(color.FgGreen).Print("message")
equals to:
color.Style{color.FgGreen}.Print("message")
func (Style) Render ¶
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.3.1
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")
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
S256 create a color256 style Usage:
s := color.S256() s := color.S256(132) // fg s := color.S256(132, 203) // fg and bg
func (*Style256) Print ¶ added in v1.1.2
func (s *Style256) Print(a ...interface{})
Print print message
func (*Style256) Println ¶ added in v1.1.2
func (s *Style256) Println(a ...interface{})
Println print message with newline
type Tag ¶
type Tag string
Tag value is a defined style name Usage:
Tag("info").Println("message")
type Theme ¶ added in v1.1.1
Theme definition. extends from Style
Source Files
Click to show internal directories.
Click to hide internal directories.