style

Documentation

Index

• Constants
• Variables
• func BgColor256(s string, c byte) string
• func BgColorRGB(s string, r, g, b byte) string
• func BgRed(s string) string
• func Blue(s string) string
• func ByStyles(s string, styles ...Style) string
• func Color256(s string, c byte) string
• func ColorDepth() (int, error)
• func ColorRGB(s string, r, g, b byte) string
• func Custom(text string, begin, end any) string
• func Cyan(s string) string
• func EnableColor() bool
• func Gradient(text string, begin, end colorRGB) string
• func GradientMultiLine(text string, begin, end colorRGB) string
• func GradientMultiLineRandom(text string) string
• func GradientRandom(text string) string
• func Gray(s string) string
• func Green(s string) string
• func Magenta(s string) string
• func Move(n int, direction direction) string
• func NewColorRGB(r, g, b byte) colorRGB
• func Rainbow(text string) string
• func RainbowMultiLine(text string) string
• func Red(s string) string
• func SetPosition(x, y int) string
• func Yellow(s string) string
• type Style
  • func (d Style) String() string

Constants

const (
	DirectionUp    direction = "A"
	DirectionDown  direction = "B"
	DirectionRight direction = "C"
	DirectionLeft  direction = "D"
)

const (
	OperationSave          operation = "s"
	OperationRestore       operation = "u"
	OperationClear         operation = "2J"
	OperationClearLineTail operation = "K"
	OperationHide          operation = "?25l"
	OperationDisplay       operation = "?25h"
)

const (
	DecorationResetBold = 22 + iota

	DecorationResetUnderline
	DecorationResetFlashing

	DecorationResetReverse
)

Variables

var (
	RainbowRGB       = [...]colorRGB{RainbowRedRGB, RainbowOrangeRGB, RainbowYellowRGB, RainbowGreenRGB, RainbowCyanRGB, RainbowBlueRGB, RainbowPurpleRGB}
	RainbowRedRGB    = NewColorRGB(255, 0, 0)
	RainbowOrangeRGB = NewColorRGB(255, 165, 0)
	RainbowYellowRGB = NewColorRGB(255, 255, 0)
	RainbowGreenRGB  = NewColorRGB(0, 255, 0)
	RainbowCyanRGB   = NewColorRGB(0, 255, 255)
	RainbowBlueRGB   = NewColorRGB(0, 0, 255)
	RainbowPurpleRGB = NewColorRGB(128, 0, 128)
)

Functions

func BgColor256

func BgColor256(s string, c byte) string

func BgColorRGB

func BgColorRGB(s string, r, g, b byte) string

func BgRed

func BgRed(s string) string

func Blue

func Blue(s string) string

func ByStyles

func ByStyles(s string, styles ...Style) string

func Color256

func Color256(s string, c byte) string

func ColorDepth

func ColorDepth() (int, error)

func ColorRGB

func ColorRGB(s string, r, g, b byte) string

func Custom

func Custom(text string, begin, end any) string

func Cyan

func Cyan(s string) string

func EnableColor

func EnableColor() bool

func Gradient

func Gradient(text string, begin, end colorRGB) string

func GradientMultiLine

func GradientMultiLine(text string, begin, end colorRGB) string

func GradientMultiLineRandom

func GradientMultiLineRandom(text string) string

func GradientRandom

func GradientRandom(text string) string

func Gray

func Gray(s string) string

func Green

func Green(s string) string

func Magenta

func Magenta(s string) string

func Move

func Move(n int, direction direction) string

func NewColorRGB

func NewColorRGB(r, g, b byte) colorRGB

func Rainbow

func Rainbow(text string) string

func RainbowMultiLine

func RainbowMultiLine(text string) string

func Red

func Red(s string) string

func SetPosition

func SetPosition(x, y int) string

func Yellow

func Yellow(s string) string

Types

type Style

type Style int

const (
	DecorationNormal Style = iota
	DecorationBold

	DecorationItalic
	DecorationUnderline
	DecorationFlashing

	DecorationReverse
)

const (
	ColorBlack Style = 30 + iota
	ColorRed
	ColorGreen
	ColorYellow
	ColorBlue
	ColorMagenta
	ColorCyan
	ColorGray
)

const (
	HighLightColorBlack Style = 90 + iota
	HighLightColorRed
	HighLightColorGreen
	HighLightColorYellow
	HighLightColorBlue
	HighLightColorMagenta
	HighLightColorCyan
	HighLightColorGray
)

const (
	BackGroundBlack Style = 40 + iota
	BackgroundRed
	BackgroundGreen
	BackgroundYellow
	BackgroundBlue
	BackgroundMagenta
	BackgroundCyan
	BackgroundGray
)

const (
	HighLightBackGroundBlack Style = 100 + iota
	HighLightBackGroundRed
	HighLightBackGroundGreen
	HighLightBackGroundYellow
	HighLightBackGroundBlue
	HighLightBackGroundMagenta
	HighLightBackGroundCyan
	HighLightBackGroundGray
)

func (Style) String

func (d Style) String() string