Documentation ¶
Overview ¶
Chalk is a Go Package which can be used for making terminal output more vibrant with text colors, text styles and background colors. The styling factors are: - Text Color - Text Style - Background Color
Text Color ¶
There are sixteen Colors. You can use them as follow :
fmt.Println(chalk.Black("Black-Text")) fmt.Println(chalk.BlackLight("BlackLight-Text")) fmt.Println(chalk.Red("Red-Text")) fmt.Println(chalk.RedLight("RedLight-Text")) fmt.Println(chalk.Green("Green-Text")) fmt.Println(chalk.GreenLight("GreenLight-Text")) fmt.Println(chalk.Yellow("Yellow-Text")) fmt.Println(chalk.YellowLight("YellowLight-Text")) fmt.Println(chalk.Blue("Blue-Text")) fmt.Println(chalk.BlueLight("BlueLight-Text")) fmt.Println(chalk.Magenta("Magenta-Text")) fmt.Println(chalk.MagentaLight("MagentaLight-Text")) fmt.Println(chalk.Cyan("Cyan-Text")) fmt.Println(chalk.CyanLight("CyanLight-Text")) fmt.Println(chalk.White("White-Text")) fmt.Println(chalk.WhiteLight("WhiteLight-Text"))
Text Style ¶
There are seven text styles. You can use them as follow:
fmt.Println(chalk.Bold("Bold-Text")) fmt.Println(chalk.Dim("Dim-Text")) fmt.Println(chalk.Italic("Italic-Text")) fmt.Println(chalk.Underline("Underline-Text")) fmt.Println(chalk.Inverse("Inverse-Text")) fmt.Println(chalk.Hidden("Hidden-Text")) fmt.Println(chalk.Strikethrough("Strikethrough-Text"))
Background Color ¶
There are sixteen background colors. You can use them as follow:
fmt.Println(chalk.WhiteLight().BgBlack("WhiteLight-Text-on-BgBlack")) fmt.Println(chalk.WhiteLight().BgBlackLight("WhiteLight-Text-on-BgBlackLight")) fmt.Println(chalk.Black().BgRed("Black-Text-on-BgRed")) fmt.Println(chalk.Black().BgRedLight("Black-Text-on-BgRedLight")) fmt.Println(chalk.Black().BgGreen("Black-Text-on-BgGreen")) fmt.Println(chalk.Black().BgGreenLight("Black-Text-on-BgGreenLight")) fmt.Println(chalk.Black().BgYellow("Black-Text-on-BgYellow")) fmt.Println(chalk.Black().BgYellowLight("Black-Text-on-BgYellowLight")) fmt.Println(chalk.Black().BgBlue("Black-Text-on-BgBlue")) fmt.Println(chalk.Black().BgBlueLight("Black-Text-on-BgBlueLight")) fmt.Println(chalk.Black().BgMagenta("Black-Text-on-BgMagenta")) fmt.Println(chalk.Black().BgMagentaLight("Black-Text-on-BgMagentaLight")) fmt.Println(chalk.Black().BgCyan("Black-Text-on-BgCyan")) fmt.Println(chalk.Black().BgCyanLight("Black-Text-on-BgCyanLight")) fmt.Println(chalk.Black().BgWhite("Black-Text-on-BgWhite")) fmt.Println(chalk.Black().BgWhiteLight("Black-Text-on-BgWhiteLight"))
You can use above functions in combinations. Following are some examples to refer:
fmt.Println(chalk.Red().Italic("Red-Italic-Text")) fmt.Println(chalk.Green().Strikethrough("Green-Strikethrough-Text")) fmt.Println(chalk.Cyan().Underline().BgBlackLight("Cyan-underline-text-on-BgBlackLight")) fmt.Println(chalk.Yellow().BgRed().Inverse("Yellow-text-on-red-inverted"))
You can save formatting configuration in a variable and reuse them multiple times. examples to refer:
SuccessMessage := chalk.Green().Bold("SUCCESS : ") WarningMessage := chalk.YellowLight().Bold("WARNING : ") ErrorMessage := chalk.RedLight().Bold("ERROR : ") fmt.Println(SuccessMessage.Apply("Completed successfully")) fmt.Println(SuccessMessage.Apply("Process Complete")) fmt.Println(WarningMessage.Apply("Call Deprecated")) fmt.Println(ErrorMessage.Apply("Fatal error ocurred"))
Index ¶
- Variables
- func Reset() string
- type Color
- func (c Color) Apply(msgs ...interface{}) Color
- func (c *Color) BgBlack(msgs ...interface{}) *Color
- func (c *Color) BgBlackLight(msgs ...interface{}) *Color
- func (c *Color) BgBlue(msgs ...interface{}) *Color
- func (c *Color) BgBlueLight(msgs ...interface{}) *Color
- func (c *Color) BgCyan(msgs ...interface{}) *Color
- func (c *Color) BgCyanLight(msgs ...interface{}) *Color
- func (c *Color) BgGreen(msgs ...interface{}) *Color
- func (c *Color) BgGreenLight(msgs ...interface{}) *Color
- func (c *Color) BgMagenta(msgs ...interface{}) *Color
- func (c *Color) BgMagentaLight(msgs ...interface{}) *Color
- func (c *Color) BgRed(msgs ...interface{}) *Color
- func (c *Color) BgRedLight(msgs ...interface{}) *Color
- func (c *Color) BgWhite(msgs ...interface{}) *Color
- func (c *Color) BgWhiteLight(msgs ...interface{}) *Color
- func (c *Color) BgYellow(msgs ...interface{}) *Color
- func (c *Color) BgYellowLight(msgs ...interface{}) *Color
- func (c *Color) Black(msgs ...interface{}) *Color
- func (c *Color) BlackLight(msgs ...interface{}) *Color
- func (c *Color) Blue(msgs ...interface{}) *Color
- func (c *Color) BlueLight(msgs ...interface{}) *Color
- func (c *Color) Bold(msgs ...interface{}) *Color
- func (c *Color) Cyan(msgs ...interface{}) *Color
- func (c *Color) CyanLight(msgs ...interface{}) *Color
- func (c *Color) Dim(msgs ...interface{}) *Color
- func (c *Color) Green(msgs ...interface{}) *Color
- func (c *Color) GreenLight(msgs ...interface{}) *Color
- func (c *Color) Hidden(msgs ...interface{}) *Color
- func (c *Color) Inverse(msgs ...interface{}) *Color
- func (c *Color) Italic(msgs ...interface{}) *Color
- func (c *Color) Magenta(msgs ...interface{}) *Color
- func (c *Color) MagentaLight(msgs ...interface{}) *Color
- func (c *Color) Red(msgs ...interface{}) *Color
- func (c *Color) RedLight(msgs ...interface{}) *Color
- func (c *Color) SetText(msgs []interface{}) *Color
- func (c *Color) Strikethrough(msgs ...interface{}) *Color
- func (c Color) String() string
- func (c *Color) Underline(msgs ...interface{}) *Color
- func (c *Color) White(msgs ...interface{}) *Color
- func (c *Color) WhiteLight(msgs ...interface{}) *Color
- func (c *Color) Yellow(msgs ...interface{}) *Color
- func (c *Color) YellowLight(msgs ...interface{}) *Color
- type PrintableText
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // Text Colors Black = func(msgs ...interface{}) *Color { return newColor().Black(msgs...) } Red = func(msgs ...interface{}) *Color { return newColor().Red(msgs...) } Green = func(msgs ...interface{}) *Color { return newColor().Green(msgs...) } Yellow = func(msgs ...interface{}) *Color { return newColor().Yellow(msgs...) } Blue = func(msgs ...interface{}) *Color { return newColor().Blue(msgs...) } Magenta = func(msgs ...interface{}) *Color { return newColor().Magenta(msgs...) } Cyan = func(msgs ...interface{}) *Color { return newColor().Cyan(msgs...) } White = func(msgs ...interface{}) *Color { return newColor().White(msgs...) } // Text Light Colors BlackLight = func(msgs ...interface{}) *Color { return newColor().BlackLight(msgs...) } RedLight = func(msgs ...interface{}) *Color { return newColor().RedLight(msgs...) } GreenLight = func(msgs ...interface{}) *Color { return newColor().GreenLight(msgs...) } YellowLight = func(msgs ...interface{}) *Color { return newColor().YellowLight(msgs...) } BlueLight = func(msgs ...interface{}) *Color { return newColor().BlueLight(msgs...) } MagentaLight = func(msgs ...interface{}) *Color { return newColor().MagentaLight(msgs...) } CyanLight = func(msgs ...interface{}) *Color { return newColor().CyanLight(msgs...) } WhiteLight = func(msgs ...interface{}) *Color { return newColor().WhiteLight(msgs...) } // Text Styles Bold = func(msgs ...interface{}) *Color { return newColor().Bold(msgs...) } Dim = func(msgs ...interface{}) *Color { return newColor().Dim(msgs...) } Italic = func(msgs ...interface{}) *Color { return newColor().Italic(msgs...) } Underline = func(msgs ...interface{}) *Color { return newColor().Underline(msgs...) } Inverse = func(msgs ...interface{}) *Color { return newColor().Inverse(msgs...) } Hidden = func(msgs ...interface{}) *Color { return newColor().Hidden(msgs...) } Strikethrough = func(msgs ...interface{}) *Color { return newColor().Strikethrough(msgs...) } // Background Colors BgBlack = func(msgs ...interface{}) *Color { return newColor().BgBlack(msgs...) } BgRed = func(msgs ...interface{}) *Color { return newColor().BgRed(msgs...) } BgGreen = func(msgs ...interface{}) *Color { return newColor().BgGreen(msgs...) } BgYellow = func(msgs ...interface{}) *Color { return newColor().BgYellow(msgs...) } BgBlue = func(msgs ...interface{}) *Color { return newColor().BgBlue(msgs...) } BgMagenta = func(msgs ...interface{}) *Color { return newColor().BgMagenta(msgs...) } BgCyan = func(msgs ...interface{}) *Color { return newColor().BgCyan(msgs...) } BgWhite = func(msgs ...interface{}) *Color { return newColor().BgWhite(msgs...) } BgBlackLight = func(msgs ...interface{}) *Color { return newColor().BgBlackLight(msgs...) } BgRedLight = func(msgs ...interface{}) *Color { return newColor().BgRedLight(msgs...) } BgGreenLight = func(msgs ...interface{}) *Color { return newColor().BgGreenLight(msgs...) } BgYellowLight = func(msgs ...interface{}) *Color { return newColor().BgYellowLight(msgs...) } BgBlueLight = func(msgs ...interface{}) *Color { return newColor().BgBlueLight(msgs...) } BgMagentaLight = func(msgs ...interface{}) *Color { return newColor().BgMagentaLight(msgs...) } BgCyanLight = func(msgs ...interface{}) *Color { return newColor().BgCyanLight(msgs...) } BgWhiteLight = func(msgs ...interface{}) *Color { return newColor().BgWhiteLight(msgs...) } )
Functions ¶
Types ¶
type Color ¶
type Color struct {
// contains filtered or unexported fields
}
func (*Color) BgBlackLight ¶
func (*Color) BgBlueLight ¶
func (*Color) BgCyanLight ¶
func (*Color) BgGreenLight ¶
func (*Color) BgMagentaLight ¶
func (*Color) BgRedLight ¶
func (*Color) BgWhiteLight ¶
func (*Color) BgYellowLight ¶
func (*Color) BlackLight ¶
func (*Color) GreenLight ¶
func (*Color) MagentaLight ¶
func (*Color) Strikethrough ¶
func (*Color) WhiteLight ¶
func (*Color) YellowLight ¶
type PrintableText ¶ added in v1.1.2
type PrintableText interface {
String() string
}
Click to show internal directories.
Click to hide internal directories.