color

package module
v0.4.0 Latest Latest
Warning

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

 Go to latest Published: Sep 10, 2025 License: MIT Imports: 5 Imported by: 1

README

color

Terminal output with ANSI colors in Go.

  • Support chain call
  • Support nested color
  • Support enable/disable color (default follow terminal support)

go get github.com/mengdu/color

func main() {
  // color.Std = color.New(false) // reset global instance
  fmt.Println(color.Red().String("Hello, world!"))
  fmt.Println(color.Bolb().Italic().Underline().Red().String("Hello, world!"))

  c := color.New(color.EnableColor(true)) // new instance
  fmt.Println(c.Red().String("Red"))
}

Examples

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var Std = New(EnableColor(false))

Functions

func EnableColor 

func EnableColor(fromCache bool) (result bool)

EnableColor returns true if color is enabled

Types

type ColorFn 

type ColorFn func(s string) (open []string, clase []string, out string, enableColor bool)

func BgBlack added in v0.3.0 

func BgBlack() ColorFn

func BgBlue added in v0.3.0 

func BgBlue() ColorFn

func BgBlueBright added in v0.3.0 

func BgBlueBright() ColorFn

func BgCyan added in v0.3.0 

func BgCyan() ColorFn

func BgCyanBright added in v0.3.0 

func BgCyanBright() ColorFn

func BgGray added in v0.3.0 

func BgGray() ColorFn

func BgGreen added in v0.3.0 

func BgGreen() ColorFn

func BgGreenBright added in v0.3.0 

func BgGreenBright() ColorFn

func BgMagenta added in v0.3.0 

func BgMagenta() ColorFn

func BgMagentaBright added in v0.3.0 

func BgMagentaBright() ColorFn

func BgRed added in v0.3.0 

func BgRed() ColorFn

func BgRedBright added in v0.3.0 

func BgRedBright() ColorFn

func BgWhite added in v0.3.0 

func BgWhite() ColorFn

func BgWhiteBright added in v0.3.0 

func BgWhiteBright() ColorFn

func BgYellow added in v0.3.0 

func BgYellow() ColorFn

func BgYellowBright added in v0.3.0 

func BgYellowBright() ColorFn

func Black added in v0.3.0 

func Black() ColorFn

func Blue added in v0.3.0 

func Blue() ColorFn

func BlueBright added in v0.3.0 

func BlueBright() ColorFn

func Bold added in v0.3.0 

func Bold() ColorFn

func Cyan added in v0.3.0 

func Cyan() ColorFn

func CyanBright added in v0.3.0 

func CyanBright() ColorFn

func Dim added in v0.3.0 

func Dim() ColorFn

func Gray added in v0.3.0 

func Gray() ColorFn

func Green added in v0.3.0 

func Green() ColorFn

func GreenBright added in v0.3.0 

func GreenBright() ColorFn

func Invisible added in v0.3.0 

func Invisible() ColorFn

func Italic added in v0.3.0 

func Italic() ColorFn

func Magenta added in v0.3.0 

func Magenta() ColorFn

func MagentaBright added in v0.3.0 

func MagentaBright() ColorFn

func New 

func New(enable bool) ColorFn

func Other added in v0.3.0 

func Other(start string, end string) ColorFn

func Red added in v0.3.0 

func Red() ColorFn

func RedBright added in v0.3.0 

func RedBright() ColorFn

func Reverse added in v0.3.0 

func Reverse() ColorFn

func StrikeThrough added in v0.3.0 

func StrikeThrough() ColorFn

func Underline added in v0.3.0 

func Underline() ColorFn

func White added in v0.3.0 

func White() ColorFn

func WhiteBright added in v0.3.0 

func WhiteBright() ColorFn

func Yellow added in v0.3.0 

func Yellow() ColorFn

func YellowBright added in v0.3.0 

func YellowBright() ColorFn

func (ColorFn) BgBlack 

func (c ColorFn) BgBlack() ColorFn

func (ColorFn) BgBlue 

func (c ColorFn) BgBlue() ColorFn

func (ColorFn) BgBlueBright 

func (c ColorFn) BgBlueBright() ColorFn

func (ColorFn) BgCyan 

func (c ColorFn) BgCyan() ColorFn

func (ColorFn) BgCyanBright 

func (c ColorFn) BgCyanBright() ColorFn

func (ColorFn) BgGray 

func (c ColorFn) BgGray() ColorFn

func (ColorFn) BgGreen 

func (c ColorFn) BgGreen() ColorFn

func (ColorFn) BgGreenBright 

func (c ColorFn) BgGreenBright() ColorFn

func (ColorFn) BgMagenta 

func (c ColorFn) BgMagenta() ColorFn

func (ColorFn) BgMagentaBright 

func (c ColorFn) BgMagentaBright() ColorFn

func (ColorFn) BgRed 

func (c ColorFn) BgRed() ColorFn

func (ColorFn) BgRedBright 

func (c ColorFn) BgRedBright() ColorFn

func (ColorFn) BgWhite 

func (c ColorFn) BgWhite() ColorFn

func (ColorFn) BgWhiteBright 

func (c ColorFn) BgWhiteBright() ColorFn

func (ColorFn) BgYellow 

func (c ColorFn) BgYellow() ColorFn

func (ColorFn) BgYellowBright 

func (c ColorFn) BgYellowBright() ColorFn

func (ColorFn) Black 

func (c ColorFn) Black() ColorFn

func (ColorFn) Blue 

func (c ColorFn) Blue() ColorFn

func (ColorFn) BlueBright 

func (c ColorFn) BlueBright() ColorFn

func (ColorFn) Bold 

func (c ColorFn) Bold() ColorFn

func (ColorFn) Cyan 

func (c ColorFn) Cyan() ColorFn

func (ColorFn) CyanBright 

func (c ColorFn) CyanBright() ColorFn

func (ColorFn) Dim 

func (c ColorFn) Dim() ColorFn

func (ColorFn) Gray 

func (c ColorFn) Gray() ColorFn

func (ColorFn) Green 

func (c ColorFn) Green() ColorFn

func (ColorFn) GreenBright 

func (c ColorFn) GreenBright() ColorFn

func (ColorFn) Invisible 

func (c ColorFn) Invisible() ColorFn

func (ColorFn) Italic 

func (c ColorFn) Italic() ColorFn

func (ColorFn) Magenta 

func (c ColorFn) Magenta() ColorFn

func (ColorFn) MagentaBright 

func (c ColorFn) MagentaBright() ColorFn

func (ColorFn) Other 

func (c ColorFn) Other(start string, end string) ColorFn

See: https://en.wikipedia.org/wiki/ANSI_escape_code#CSI_codes

func (ColorFn) Red 

func (c ColorFn) Red() ColorFn

func (ColorFn) RedBright 

func (c ColorFn) RedBright() ColorFn

func (ColorFn) Reverse 

func (c ColorFn) Reverse() ColorFn

func (ColorFn) StrikeThrough 

func (c ColorFn) StrikeThrough() ColorFn

func (ColorFn) String 

func (f ColorFn) String(s string) string

func (ColorFn) Underline 

func (c ColorFn) Underline() ColorFn

func (ColorFn) White 

func (c ColorFn) White() ColorFn

func (ColorFn) WhiteBright 

func (c ColorFn) WhiteBright() ColorFn

func (ColorFn) Yellow 

func (c ColorFn) Yellow() ColorFn

func (ColorFn) YellowBright 

func (c ColorFn) YellowBright() ColorFn

Source Files

View all Source files

Directories

Path Synopsis

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.