README
¶
Color
Style terminal text.
Installation
go get github.com/labstack/gommon/color
Windows?
Try cmder or https://github.com/mattn/go-colorable
Usage
import github.com/labstack/gommon/color
Colored text
color.Println(color.Black("black"))
color.Println(color.Red("red"))
color.Println(color.Green("green"))
color.Println(color.Yellow("yellow"))
color.Println(color.Blue("blue"))
color.Println(color.Magenta("magenta"))
color.Println(color.Cyan("cyan"))
color.Println(color.White("white"))
color.Println(color.Grey("grey"))
Colored background
color.Println(color.BlackBg("black background", color.Wht))
color.Println(color.RedBg("red background"))
color.Println(color.GreenBg("green background"))
color.Println(color.YellowBg("yellow background"))
color.Println(color.BlueBg("blue background"))
color.Println(color.MagentaBg("magenta background"))
color.Println(color.CyanBg("cyan background"))
color.Println(color.WhiteBg("white background"))
Emphasis
color.Println(color.Bold("bold"))
color.Println(color.Dim("dim"))
color.Println(color.Italic("italic"))
color.Println(color.Underline("underline"))
color.Println(color.Inverse("inverse"))
color.Println(color.Hidden("hidden"))
color.Println(color.Strikeout("strikeout"))
Mix and match
color.Println(color.Green("bold green with white background", color.B, color.WhtBg))
color.Println(color.Red("underline red", color.U))
color.Println(color.Yellow("dim yellow", color.D))
color.Println(color.Cyan("inverse cyan", color.In))
color.Println(color.Blue("bold underline dim blue", color.B, color.U, color.D))
Enable/Disable the package
color.Disable()
color.Enable()
New instance
c := New()
c.Green("green")
Documentation
¶
Index ¶
- Constants
- func Black(msg interface{}, styles ...string) string
- func BlackBg(msg interface{}, styles ...string) string
- func Blue(msg interface{}, styles ...string) string
- func BlueBg(msg interface{}, styles ...string) string
- func Bold(msg interface{}, styles ...string) string
- func Cyan(msg interface{}, styles ...string) string
- func CyanBg(msg interface{}, styles ...string) string
- func Dim(msg interface{}, styles ...string) string
- func Disable()
- func Enable()
- func Green(msg interface{}, styles ...string) string
- func GreenBg(msg interface{}, styles ...string) string
- func Grey(msg interface{}, styles ...string) string
- func Hidden(msg interface{}, styles ...string) string
- func Inverse(msg interface{}, styles ...string) string
- func Italic(msg interface{}, styles ...string) string
- func Magenta(msg interface{}, styles ...string) string
- func MagentaBg(msg interface{}, styles ...string) string
- func Output() io.Writer
- func Print(args ...interface{})
- func Printf(format string, args ...interface{})
- func Println(args ...interface{})
- func Red(msg interface{}, styles ...string) string
- func RedBg(msg interface{}, styles ...string) string
- func Reset(msg interface{}, styles ...string) string
- func SetOutput(w io.Writer)
- func Strikeout(msg interface{}, styles ...string) string
- func Underline(msg interface{}, styles ...string) string
- func White(msg interface{}, styles ...string) string
- func WhiteBg(msg interface{}, styles ...string) string
- func Yellow(msg interface{}, styles ...string) string
- func YellowBg(msg interface{}, styles ...string) string
- type Color
- func (c *Color) Black(msg interface{}, styles ...string) string
- func (c *Color) BlackBg(msg interface{}, styles ...string) string
- func (c *Color) Blue(msg interface{}, styles ...string) string
- func (c *Color) BlueBg(msg interface{}, styles ...string) string
- func (c *Color) Bold(msg interface{}, styles ...string) string
- func (c *Color) Cyan(msg interface{}, styles ...string) string
- func (c *Color) CyanBg(msg interface{}, styles ...string) string
- func (c *Color) Dim(msg interface{}, styles ...string) string
- func (c *Color) Disable()
- func (c *Color) Enable()
- func (c *Color) Green(msg interface{}, styles ...string) string
- func (c *Color) GreenBg(msg interface{}, styles ...string) string
- func (c *Color) Grey(msg interface{}, styles ...string) string
- func (c *Color) Hidden(msg interface{}, styles ...string) string
- func (c *Color) Inverse(msg interface{}, styles ...string) string
- func (c *Color) Italic(msg interface{}, styles ...string) string
- func (c *Color) Magenta(msg interface{}, styles ...string) string
- func (c *Color) MagentaBg(msg interface{}, styles ...string) string
- func (c *Color) Output() io.Writer
- func (c *Color) Print(args ...interface{})
- func (c *Color) Printf(format string, args ...interface{})
- func (c *Color) Println(args ...interface{})
- func (c *Color) Red(msg interface{}, styles ...string) string
- func (c *Color) RedBg(msg interface{}, styles ...string) string
- func (c *Color) Reset(msg interface{}, styles ...string) string
- func (c *Color) SetOutput(w io.Writer)
- func (c *Color) Strikeout(msg interface{}, styles ...string) string
- func (c *Color) Underline(msg interface{}, styles ...string) string
- func (c *Color) White(msg interface{}, styles ...string) string
- func (c *Color) WhiteBg(msg interface{}, styles ...string) string
- func (c *Color) Yellow(msg interface{}, styles ...string) string
- func (c *Color) YellowBg(msg interface{}, styles ...string) string
Constants ¶
View Source
const ( // Blk Black text style Blk = "30" // Rd red text style Rd = "31" // Grn green text style Grn = "32" // Yel yellow text style Yel = "33" // Blu blue text style Blu = "34" // Mgn magenta text style Mgn = "35" // Cyn cyan text style Cyn = "36" // Wht white text style Wht = "37" // Gry grey text style Gry = "90" // BlkBg black background style BlkBg = "40" // RdBg red background style RdBg = "41" // GrnBg green background style GrnBg = "42" // YelBg yellow background style YelBg = "43" // BluBg blue background style BluBg = "44" // MgnBg magenta background style MgnBg = "45" // CynBg cyan background style CynBg = "46" // WhtBg white background style WhtBg = "47" // R reset emphasis style R = "0" // B bold emphasis style B = "1" // D dim emphasis style D = "2" // I italic emphasis style I = "3" // U underline emphasis style U = "4" // In inverse emphasis style In = "7" // H hidden emphasis style H = "8" // S strikeout emphasis style S = "9" )
Color styles
Variables ¶
This section is empty.
Functions ¶
func Print ¶ added in v0.1.0
func Print(args ...interface{})
Print is analogous to `fmt.Print` with termial detection.
func Printf ¶ added in v0.1.0
func Printf(format string, args ...interface{})
Printf is analogous to `fmt.Printf` with termial detection.
Types ¶
type Color ¶ added in v0.1.0
type Color struct {
// contains filtered or unexported fields
}
func (*Color) Disable ¶ added in v0.1.0
func (c *Color) Disable()
Disable disables the colors and styles.
func (*Color) Enable ¶ added in v0.1.0
func (c *Color) Enable()
Enable enables the colors and styles.
func (*Color) Print ¶ added in v0.1.0
func (c *Color) Print(args ...interface{})
Print is analogous to `fmt.Print` with termial detection.
func (*Color) Println ¶ added in v0.1.0
func (c *Color) Println(args ...interface{})
Println is analogous to `fmt.Println` with termial detection.
Source Files
Click to show internal directories.
Click to hide internal directories.