2021-03-02 02:29:00 +03:00
|
|
|
package lipgloss
|
|
|
|
|
2021-03-04 03:23:52 +03:00
|
|
|
import (
|
2022-06-28 20:28:35 +03:00
|
|
|
"strconv"
|
2021-04-05 16:39:11 +03:00
|
|
|
|
2021-03-04 03:23:52 +03:00
|
|
|
"github.com/muesli/termenv"
|
|
|
|
)
|
2021-03-02 02:29:00 +03:00
|
|
|
|
2022-06-28 20:28:35 +03:00
|
|
|
// TerminalColor is a color intended to be rendered in the terminal.
|
2021-03-31 05:19:38 +03:00
|
|
|
type TerminalColor interface {
|
2021-03-31 05:28:54 +03:00
|
|
|
RGBA() (r, g, b, a uint32)
|
2021-03-02 02:29:00 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
// 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:
|
|
|
|
//
|
2022-08-24 19:05:18 +03:00
|
|
|
// var style = someStyle.Copy().Background(lipgloss.NoColor{})
|
2021-03-18 21:34:39 +03:00
|
|
|
type NoColor struct{}
|
2021-03-02 02:29:00 +03:00
|
|
|
|
2022-06-28 20:28:35 +03:00
|
|
|
var noColor = NoColor{}
|
2021-03-26 22:57:47 +03:00
|
|
|
|
2021-03-31 05:28:54 +03:00
|
|
|
// 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
|
2022-08-30 23:38:15 +03:00
|
|
|
// black with 100% opacity.
|
2021-04-02 17:05:53 +03:00
|
|
|
//
|
|
|
|
// Red: 0x0, Green: 0x0, Blue: 0x0, Alpha: 0xFFFF.
|
2021-03-31 05:28:54 +03:00
|
|
|
func (n NoColor) RGBA() (r, g, b, a uint32) {
|
2021-04-02 17:05:53 +03:00
|
|
|
return 0x0, 0x0, 0x0, 0xFFFF
|
2021-03-31 05:28:54 +03:00
|
|
|
}
|
|
|
|
|
2021-03-02 02:29:00 +03:00
|
|
|
// Color specifies a color by hex or ANSI value. For example:
|
|
|
|
//
|
2022-08-24 19:05:18 +03:00
|
|
|
// ansiColor := lipgloss.Color("21")
|
|
|
|
// hexColor := lipgloss.Color("#0000ff")
|
2021-03-02 02:29:00 +03:00
|
|
|
type Color string
|
|
|
|
|
2021-03-26 22:57:47 +03:00
|
|
|
func (c Color) color() termenv.Color {
|
2021-04-05 16:39:11 +03:00
|
|
|
return ColorProfile().Color(string(c))
|
2021-03-26 22:57:47 +03:00
|
|
|
}
|
|
|
|
|
2021-04-02 17:05:53 +03:00
|
|
|
// 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:
|
|
|
|
//
|
2022-09-30 05:59:08 +03:00
|
|
|
// Red: 0x0, Green: 0x0, Blue: 0x0, Alpha: 0xFFFF.
|
2021-03-31 05:28:54 +03:00
|
|
|
func (c Color) RGBA() (r, g, b, a uint32) {
|
2022-09-30 05:40:12 +03:00
|
|
|
return termenv.ConvertToRGB(c.color()).RGBA()
|
2021-03-31 05:28:54 +03:00
|
|
|
}
|
|
|
|
|
2022-06-28 20:28:35 +03:00
|
|
|
// 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()
|
|
|
|
}
|
|
|
|
|
2021-03-26 17:36:23 +03:00
|
|
|
// AdaptiveColor provides color options for light and dark backgrounds. The
|
2022-02-06 02:35:33 +03:00
|
|
|
// appropriate color will be returned at runtime based on the darkness of the
|
2021-03-31 05:28:54 +03:00
|
|
|
// terminal background color.
|
2021-03-02 02:29:00 +03:00
|
|
|
//
|
|
|
|
// Example usage:
|
|
|
|
//
|
2022-08-24 19:05:18 +03:00
|
|
|
// color := lipgloss.AdaptiveColor{Light: "#0000ff", Dark: "#000099"}
|
2021-03-02 02:29:00 +03:00
|
|
|
type AdaptiveColor struct {
|
|
|
|
Light string
|
|
|
|
Dark string
|
|
|
|
}
|
|
|
|
|
2021-03-31 05:28:54 +03:00
|
|
|
func (ac AdaptiveColor) value() string {
|
2021-04-05 16:39:11 +03:00
|
|
|
if HasDarkBackground() {
|
2021-03-31 05:28:54 +03:00
|
|
|
return ac.Dark
|
2021-03-02 02:29:00 +03:00
|
|
|
}
|
2021-03-31 05:28:54 +03:00
|
|
|
return ac.Light
|
|
|
|
}
|
|
|
|
|
|
|
|
func (ac AdaptiveColor) color() termenv.Color {
|
2021-04-05 16:39:11 +03:00
|
|
|
return ColorProfile().Color(ac.value())
|
2021-03-02 02:29:00 +03:00
|
|
|
}
|
2021-03-26 22:57:47 +03:00
|
|
|
|
2021-04-02 17:05:53 +03:00
|
|
|
// 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:
|
|
|
|
//
|
2022-09-30 05:59:08 +03:00
|
|
|
// Red: 0x0, Green: 0x0, Blue: 0x0, Alpha: 0xFFFF.
|
2021-03-31 05:28:54 +03:00
|
|
|
func (ac AdaptiveColor) RGBA() (r, g, b, a uint32) {
|
2022-09-30 05:40:12 +03:00
|
|
|
return termenv.ConvertToRGB(ac.color()).RGBA()
|
2021-03-26 22:57:47 +03:00
|
|
|
}
|
2022-07-06 02:11:11 +03:00
|
|
|
|
2022-08-30 23:38:15 +03:00
|
|
|
// CompleteColor specifies exact values for truecolor, ANSI256, and ANSI color
|
2022-11-08 12:55:11 +03:00
|
|
|
// profiles. Automatic color degradation will not be performed.
|
2022-08-30 23:38:15 +03:00
|
|
|
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 {
|
2022-06-28 20:28:35 +03:00
|
|
|
return ColorProfile().Color(c.value())
|
2022-08-30 23:38:15 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
// 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:
|
|
|
|
//
|
2022-09-30 05:59:08 +03:00
|
|
|
// Red: 0x0, Green: 0x0, Blue: 0x0, Alpha: 0xFFFF.
|
2022-08-30 23:38:15 +03:00
|
|
|
func (c CompleteColor) RGBA() (r, g, b, a uint32) {
|
2022-09-30 05:40:12 +03:00
|
|
|
return termenv.ConvertToRGB(c.color()).RGBA()
|
2022-08-30 23:38:15 +03:00
|
|
|
}
|
|
|
|
|
2022-11-08 12:55:11 +03:00
|
|
|
// CompleteAdaptiveColor specifies exact values for truecolor, ANSI256, and ANSI color
|
2022-08-30 23:38:15 +03:00
|
|
|
// profiles, with separate options for light and dark backgrounds. Automatic
|
2022-11-08 12:55:11 +03:00
|
|
|
// color degradation will not be performed.
|
2022-08-30 23:38:15 +03:00
|
|
|
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:
|
|
|
|
//
|
2022-09-30 05:59:08 +03:00
|
|
|
// Red: 0x0, Green: 0x0, Blue: 0x0, Alpha: 0xFFFF.
|
2022-08-30 23:38:15 +03:00
|
|
|
func (cac CompleteAdaptiveColor) RGBA() (r, g, b, a uint32) {
|
2022-09-30 05:40:12 +03:00
|
|
|
return termenv.ConvertToRGB(cac.color()).RGBA()
|
2022-07-06 02:11:11 +03:00
|
|
|
}
|