README
¶
colr
An extremely lightweight cross-platform package to colorize text in terminals.
This is not meant for maximal compatibility, nor is it meant to handle a plethora of scenarios. It will simply wrap a message with the necessary characters, if the OS handles it.
Usage
go get g.tizu.dev/colr
Using Functions
package main
import "g.tizu.dev/colr"
func main() {
// Special
println(colr.Bold("hello!"))
println(colr.Dim("hello!"))
println(colr.Italic("hello!"))
println(colr.Underline("hello!"))
println(colr.Blink("hello!"))
println(colr.Strikethrough("hello!"))
// Text colors
println(colr.Black("hello!"))
println(colr.Red("hello!"))
println(colr.Green("hello!"))
println(colr.Yellow("hello!"))
println(colr.Blue("hello!"))
println(colr.Purple("hello!"))
println(colr.Cyan("hello!"))
println(colr.Gray("hello!"))
println(colr.White("hello!"))
// back colors
println(colr.OnBlack("hello!"))
println(colr.OnRed("hello!"))
println(colr.OnGreen("hello!"))
println(colr.OnYellow("hello!"))
println(colr.OnBlue("hello!"))
println(colr.OnPurple("hello!"))
println(colr.OnCyan("hello!"))
println(colr.OnGray("hello!"))
println(colr.OnWhite("hello!"))
// .. or combined
println(colr.BlackOnBlack("hello!"))
println(colr.BlackOnRed("hello!"))
println(colr.BlackOnGreen("hello!"))
println(colr.BlackOnYellow("hello!"))
println(colr.BlackOnBlue("hello!"))
println(colr.BlackOnPurple("hello!"))
println(colr.BlackOnCyan("hello!"))
println(colr.BlackOnGray("hello!"))
println(colr.BlackOnWhite("hello!"))
println(colr.RedOnBlack("hello!"))
println(colr.RedOnRed("hello!"))
println(colr.RedOnGreen("hello!"))
println(colr.RedOnYellow("hello!"))
println(colr.RedOnBlue("hello!"))
println(colr.RedOnPurple("hello!"))
println(colr.RedOnCyan("hello!"))
println(colr.RedOnGray("hello!"))
println(colr.RedOnWhite("hello!"))
println(colr.GreenOnBlack("hello!"))
println(colr.GreenOnRed("hello!"))
println(colr.GreenOnGreen("hello!"))
println(colr.GreenOnYellow("hello!"))
println(colr.GreenOnBlue("hello!"))
println(colr.GreenOnPurple("hello!"))
println(colr.GreenOnCyan("hello!"))
println(colr.GreenOnGray("hello!"))
println(colr.GreenOnWhite("hello!"))
println(colr.YellowOnBlack("hello!"))
println(colr.YellowOnRed("hello!"))
println(colr.YellowOnGreen("hello!"))
println(colr.YellowOnYellow("hello!"))
println(colr.YellowOnBlue("hello!"))
println(colr.YellowOnPurple("hello!"))
println(colr.YellowOnCyan("hello!"))
println(colr.YellowOnGray("hello!"))
println(colr.YellowOnWhite("hello!"))
println(colr.BlueOnBlack("hello!"))
println(colr.BlueOnRed("hello!"))
println(colr.BlueOnGreen("hello!"))
println(colr.BlueOnYellow("hello!"))
println(colr.BlueOnBlue("hello!"))
println(colr.BlueOnPurple("hello!"))
println(colr.BlueOnCyan("hello!"))
println(colr.BlueOnGray("hello!"))
println(colr.BlueOnWhite("hello!"))
println(colr.PurpleOnBlack("hello!"))
println(colr.PurpleOnRed("hello!"))
println(colr.PurpleOnGreen("hello!"))
println(colr.PurpleOnYellow("hello!"))
println(colr.PurpleOnBlue("hello!"))
println(colr.PurpleOnPurple("hello!"))
println(colr.PurpleOnCyan("hello!"))
println(colr.PurpleOnGray("hello!"))
println(colr.PurpleOnWhite("hello!"))
println(colr.CyanOnBlack("hello!"))
println(colr.CyanOnRed("hello!"))
println(colr.CyanOnGreen("hello!"))
println(colr.CyanOnYellow("hello!"))
println(colr.CyanOnBlue("hello!"))
println(colr.CyanOnPurple("hello!"))
println(colr.CyanOnCyan("hello!"))
println(colr.CyanOnGray("hello!"))
println(colr.CyanOnWhite("hello!"))
println(colr.GrayOnBlack("hello!"))
println(colr.GrayOnRed("hello!"))
println(colr.GrayOnGreen("hello!"))
println(colr.GrayOnYellow("hello!"))
println(colr.GrayOnBlue("hello!"))
println(colr.GrayOnPurple("hello!"))
println(colr.GrayOnCyan("hello!"))
println(colr.GrayOnGray("hello!"))
println(colr.GrayOnWhite("hello!"))
println(colr.WhiteOnBlack("hello!"))
println(colr.WhiteOnRed("hello!"))
println(colr.WhiteOnGreen("hello!"))
println(colr.WhiteOnYellow("hello!"))
println(colr.WhiteOnBlue("hello!"))
println(colr.WhiteOnPurple("hello!"))
println(colr.WhiteOnCyan("hello!"))
println(colr.WhiteOnGray("hello!"))
println(colr.WhiteOnWhite("hello!"))
}
Examples
println("My name is " + colr.Green("John Doe") + " and I have " + colr.Red(32) + " apples.")
Documentation
¶
Index ¶
- func Black(s any) string
- func BlackOnBlack(s any) string
- func BlackOnBlue(s any) string
- func BlackOnCyan(s any) string
- func BlackOnGray(s any) string
- func BlackOnGreen(s any) string
- func BlackOnPurple(s any) string
- func BlackOnRed(s any) string
- func BlackOnWhite(s any) string
- func BlackOnYellow(s any) string
- func Blink(s any) string
- func Blue(s any) string
- func BlueOnBlack(s any) string
- func BlueOnBlue(s any) string
- func BlueOnCyan(s any) string
- func BlueOnGray(s any) string
- func BlueOnGreen(s any) string
- func BlueOnPurple(s any) string
- func BlueOnRed(s any) string
- func BlueOnWhite(s any) string
- func BlueOnYellow(s any) string
- func Bold(s any) string
- func Cyan(s any) string
- func CyanOnBlack(s any) string
- func CyanOnBlue(s any) string
- func CyanOnCyan(s any) string
- func CyanOnGray(s any) string
- func CyanOnGreen(s any) string
- func CyanOnPurple(s any) string
- func CyanOnRed(s any) string
- func CyanOnWhite(s any) string
- func CyanOnYellow(s any) string
- func Dim(s any) string
- func Gray(s any) string
- func GrayOnBlack(s any) string
- func GrayOnBlue(s any) string
- func GrayOnCyan(s any) string
- func GrayOnGray(s any) string
- func GrayOnGreen(s any) string
- func GrayOnPurple(s any) string
- func GrayOnRed(s any) string
- func GrayOnWhite(s any) string
- func GrayOnYellow(s any) string
- func Green(s any) string
- func GreenOnBlack(s any) string
- func GreenOnBlue(s any) string
- func GreenOnCyan(s any) string
- func GreenOnGray(s any) string
- func GreenOnGreen(s any) string
- func GreenOnPurple(s any) string
- func GreenOnRed(s any) string
- func GreenOnWhite(s any) string
- func GreenOnYellow(s any) string
- func Italic(s any) string
- func OnBlack(s any) string
- func OnBlue(s any) string
- func OnCyan(s any) string
- func OnGray(s any) string
- func OnGreen(s any) string
- func OnPurple(s any) string
- func OnRed(s any) string
- func OnWhite(s any) string
- func OnYellow(s any) string
- func Purple(s any) string
- func PurpleOnBlack(s any) string
- func PurpleOnBlue(s any) string
- func PurpleOnCyan(s any) string
- func PurpleOnGray(s any) string
- func PurpleOnGreen(s any) string
- func PurpleOnPurple(s any) string
- func PurpleOnRed(s any) string
- func PurpleOnWhite(s any) string
- func PurpleOnYellow(s any) string
- func Red(s any) string
- func RedOnBlack(s any) string
- func RedOnBlue(s any) string
- func RedOnCyan(s any) string
- func RedOnGray(s any) string
- func RedOnGreen(s any) string
- func RedOnPurple(s any) string
- func RedOnRed(s any) string
- func RedOnWhite(s any) string
- func RedOnYellow(s any) string
- func Strikethrough(s any) string
- func Underline(s any) string
- func White(s any) string
- func WhiteOnBlack(s any) string
- func WhiteOnBlue(s any) string
- func WhiteOnCyan(s any) string
- func WhiteOnGray(s any) string
- func WhiteOnGreen(s any) string
- func WhiteOnPurple(s any) string
- func WhiteOnRed(s any) string
- func WhiteOnWhite(s any) string
- func WhiteOnYellow(s any) string
- func Yellow(s any) string
- func YellowOnBlack(s any) string
- func YellowOnBlue(s any) string
- func YellowOnCyan(s any) string
- func YellowOnGray(s any) string
- func YellowOnGreen(s any) string
- func YellowOnPurple(s any) string
- func YellowOnRed(s any) string
- func YellowOnWhite(s any) string
- func YellowOnYellow(s any) string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BlackOnBlack ¶
func BlackOnBlue ¶
func BlackOnCyan ¶
func BlackOnGray ¶
func BlackOnGreen ¶
func BlackOnPurple ¶
func BlackOnRed ¶
func BlackOnWhite ¶
func BlackOnYellow ¶
func BlueOnBlack ¶
func BlueOnBlue ¶
func BlueOnCyan ¶
func BlueOnGray ¶
func BlueOnGreen ¶
func BlueOnPurple ¶
func BlueOnWhite ¶
func BlueOnYellow ¶
func CyanOnBlack ¶
func CyanOnBlue ¶
func CyanOnCyan ¶
func CyanOnGray ¶
func CyanOnGreen ¶
func CyanOnPurple ¶
func CyanOnWhite ¶
func CyanOnYellow ¶
func GrayOnBlack ¶
func GrayOnBlue ¶
func GrayOnCyan ¶
func GrayOnGray ¶
func GrayOnGreen ¶
func GrayOnPurple ¶
func GrayOnWhite ¶
func GrayOnYellow ¶
func GreenOnBlack ¶
func GreenOnBlue ¶
func GreenOnCyan ¶
func GreenOnGray ¶
func GreenOnGreen ¶
func GreenOnPurple ¶
func GreenOnRed ¶
func GreenOnWhite ¶
func GreenOnYellow ¶
func PurpleOnBlack ¶
func PurpleOnBlue ¶
func PurpleOnCyan ¶
func PurpleOnGray ¶
func PurpleOnGreen ¶
func PurpleOnPurple ¶
func PurpleOnRed ¶
func PurpleOnWhite ¶
func PurpleOnYellow ¶
func RedOnBlack ¶
func RedOnGreen ¶
func RedOnPurple ¶
func RedOnWhite ¶
func RedOnYellow ¶
func Strikethrough ¶
func WhiteOnBlack ¶
func WhiteOnBlue ¶
func WhiteOnCyan ¶
func WhiteOnGray ¶
func WhiteOnGreen ¶
func WhiteOnPurple ¶
func WhiteOnRed ¶
func WhiteOnWhite ¶
func WhiteOnYellow ¶
func YellowOnBlack ¶
func YellowOnBlue ¶
func YellowOnCyan ¶
func YellowOnGray ¶
func YellowOnGreen ¶
func YellowOnPurple ¶
func YellowOnRed ¶
func YellowOnWhite ¶
func YellowOnYellow ¶
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.