package lipgloss import ( "strconv" "github.com/muesli/termenv" ) // TerminalColor is a color intended to be rendered in the terminal. type TerminalColor interface { RGBA() (r, g, b, a uint32) } // NoColor is used to specify the absence of color styling. When this is active // foreground colors will be rendered with the terminal's default text color, // and background colors will not be drawn at all. // // Example usage: // // var style = someStyle.Copy().Background(lipgloss.NoColor{}) type NoColor struct{} var noColor = NoColor{} // RGBA returns the RGBA value of this color. Because we have to return // something, despite this color being the absence of color, we're returning // black with 100% opacity. // // Red: 0x0, Green: 0x0, Blue: 0x0, Alpha: 0xFFFF. func (n NoColor) RGBA() (r, g, b, a uint32) { return 0x0, 0x0, 0x0, 0xFFFF } // Color specifies a color by hex or ANSI value. For example: // // ansiColor := lipgloss.Color("21") // hexColor := lipgloss.Color("#0000ff") type Color string func (c Color) color() termenv.Color { return ColorProfile().Color(string(c)) } // RGBA returns the RGBA value of this color. This satisfies the Go Color // interface. Note that on error we return black with 100% opacity, or: // // Red: 0x0, Green: 0x0, Blue: 0x0, Alpha: 0xFFFF. func (c Color) RGBA() (r, g, b, a uint32) { return termenv.ConvertToRGB(c.color()).RGBA() } // ANSIColor is a color specified by an ANSI color value. It's merely syntactic // sugar for the more general Color function. Invalid colors will render as // black. // // Example usage: // // // These two statements are equivalent. // colorA := lipgloss.ANSIColor(21) // colorB := lipgloss.Color("21") type ANSIColor uint // RGBA returns the RGBA value of this color. This satisfies the Go Color // interface. Note that on error we return black with 100% opacity, or: // // Red: 0x0, Green: 0x0, Blue: 0x0, Alpha: 0xFFFF. func (ac ANSIColor) RGBA() (r, g, b, a uint32) { cf := Color(strconv.FormatUint(uint64(ac), 10)) return cf.RGBA() } // AdaptiveColor provides color options for light and dark backgrounds. The // appropriate color will be returned at runtime based on the darkness of the // terminal background color. // // Example usage: // // color := lipgloss.AdaptiveColor{Light: "#0000ff", Dark: "#000099"} type AdaptiveColor struct { Light string Dark string } func (ac AdaptiveColor) value() string { if HasDarkBackground() { return ac.Dark } return ac.Light } func (ac AdaptiveColor) color() termenv.Color { return ColorProfile().Color(ac.value()) } // RGBA returns the RGBA value of this color. This satisfies the Go Color // interface. Note that on error we return black with 100% opacity, or: // // Red: 0x0, Green: 0x0, Blue: 0x0, Alpha: 0xFFFF. func (ac AdaptiveColor) RGBA() (r, g, b, a uint32) { return termenv.ConvertToRGB(ac.color()).RGBA() } // CompleteColor specifies exact values for truecolor, ANSI256, and ANSI color // profiles. Automatic color degradation will not be performed. type CompleteColor struct { TrueColor string ANSI256 string ANSI string } func (c CompleteColor) value() string { switch ColorProfile() { case termenv.TrueColor: return c.TrueColor case termenv.ANSI256: return c.ANSI256 case termenv.ANSI: return c.ANSI default: return "" } } func (c CompleteColor) color() termenv.Color { return ColorProfile().Color(c.value()) } // RGBA returns the RGBA value of this color. This satisfies the Go Color // interface. Note that on error we return black with 100% opacity, or: // // Red: 0x0, Green: 0x0, Blue: 0x0, Alpha: 0xFFFF. func (c CompleteColor) RGBA() (r, g, b, a uint32) { return termenv.ConvertToRGB(c.color()).RGBA() } // CompleteAdaptiveColor specifies exact values for truecolor, ANSI256, and ANSI color // profiles, with separate options for light and dark backgrounds. Automatic // color degradation will not be performed. type CompleteAdaptiveColor struct { Light CompleteColor Dark CompleteColor } func (cac CompleteAdaptiveColor) value() string { if HasDarkBackground() { return cac.Dark.value() } return cac.Light.value() } func (cac CompleteAdaptiveColor) color() termenv.Color { return ColorProfile().Color(cac.value()) } // RGBA returns the RGBA value of this color. This satisfies the Go Color // interface. Note that on error we return black with 100% opacity, or: // // Red: 0x0, Green: 0x0, Blue: 0x0, Alpha: 0xFFFF. func (cac CompleteAdaptiveColor) RGBA() (r, g, b, a uint32) { return termenv.ConvertToRGB(cac.color()).RGBA() }