ansicolor

Documentation

Index

• Variables
• func Format(text string, fmtf Flag) string
• func Text(text string, fg, bg Color, flags Flag) string
• type Color
  • func HEX(hex string) (c Color)
  • func RGB(r, g, b byte) Color
  • func (c Color) RGB() color.RGBA
• type Flag
• type Style
  • func (s Style) String(text string) string
• type Theme
  • func New() Theme

Variables

var ErrInvalidHex = errors.New("invalid HEX color code")

var InvalidColor = Color{/* contains filtered or unexported fields */}

Functions

func Format

func Format(text string, fmtf Flag) string

func Text

func Text(text string, fg, bg Color, flags Flag) string

Types

type Color

type Color struct {
	// contains filtered or unexported fields
}

func HEX

func HEX(hex string) (c Color)

HEX converts a hex color code to an Color.

func RGB

func RGB(r, g, b byte) Color

func (Color) RGB

func (c Color) RGB() color.RGBA

type Flag

type Flag uint32

const (
	Reset Flag = 1 << iota
	Bold
	Faint
	Italic
	Underline
	Reverse
	Conceal
	CrossedOut
	Overlined
	BrightForeground
	BrightBackground
)

type Style

type Style struct {
	FG     Color
	BG     Color
	Format Flag
}

func (Style) String

func (s Style) String(text string) string

type Theme

type Theme struct {
	Primary        Color // Primary color for standard text
	Secondary      Color // Secondary color for accentuating text
	Accent         Color // Accent color for highlighting text
	Success        Color // Color for success messages
	Info           Color // Color for informational messages
	Warning        Color // Color for warning messages
	Error          Color // Color for error messages
	Debug          Color // Color for debugging messages
	Notice         Color // Color for notice messages
	NotImplemented Color // Color for not implemented features
	Deprecated     Color // Color for deprecated features or elements
	BUG            Color // Color for bug reports or critical issues
	Light          Color // Light color
	Dark           Color // Dark color
	Muted          Color // Muted color
}

func New

func New() Theme