color

README

color

Fluent color manipulations for Go

Documentation

Index

• Constants
• type Color
  • func NewColor() Color
  • func Parse(value any) Color
  • func ParseHex(value string) Color
  • func ParseRGB(value string) Color
  • func (c Color) ColorMode() string
  • func (c Color) Contrast(percent int) Color
  • func (c Color) Darken(percent int) Color
  • func (c Color) Hex() string
  • func (c Color) IsDark() bool
  • func (c Color) IsEmpty() bool
  • func (c Color) IsLight() bool
  • func (c Color) Lighten(percent int) Color
  • func (c Color) Mean() int
  • func (c Color) Mix(other any, percent int) Color
  • func (color Color) NotEmpty() bool
  • func (c Color) RGBA() string
  • func (c Color) String() string
  • func (c Color) Text() Color
  • func (c Color) TextExt() Color

Constants

const ColorModeAuto = "auto"

const ColorModeDark = "dark"

const ColorModeExtDark = "dark"

const ColorModeExtLight = "light"

const ColorModeExtMediumDark = "medium-dark"

const ColorModeExtMediumLight = "medium-light"

const ColorModeLight = "light"

const HexBlack = "#000000"

const HexWhite = "#FFFFFF"

Types

type Color

type Color struct {
	Red     int
	Green   int
	Blue    int
	Opacity float64
}

var Black Color = Color{
	Red:     0,
	Green:   0,
	Blue:    0,
	Opacity: 1.0,
}

var White Color = Color{
	Red:     255,
	Green:   255,
	Blue:    255,
	Opacity: 1.0,
}

func NewColor

func NewColor() Color

func Parse

func Parse(value any) Color

func ParseHex

func ParseHex(value string) Color

func ParseRGB

func ParseRGB(value string) Color

func (Color) ColorMode

func (c Color) ColorMode() string

ColorMode returns "light" if this is a light color, or "dark" if this is a dark color.

func (Color) Contrast

func (c Color) Contrast(percent int) Color

Contrast mixes this color with either black or white. Light colors become darker, and dark colors become lighter. The percentage determines how much to mix the colors.

func (Color) Darken

func (c Color) Darken(percent int) Color

Darken mixes this color with black, moving towards black by the specified percentage.

func (Color) Hex

func (c Color) Hex() string

func (Color) IsDark

func (c Color) IsDark() bool

func (Color) IsEmpty

func (c Color) IsEmpty() bool

IsEmpty returns TRUE if this color is empty. This represents a Nil color

func (Color) IsLight

func (c Color) IsLight() bool

func (Color) Lighten

func (c Color) Lighten(percent int) Color

Lighten mixes this color with white, moving towards white by the specified percentage.

func (Color) Mean

func (c Color) Mean() int

Mean returns the average of the red, green, and blue values.

func (Color) Mix

func (c Color) Mix(other any, percent int) Color

Mix combines this color with another one, moving towards the 'other' color by a specified percentage. 0% will return this color, 100% will return the 'other' color.

func (Color) NotEmpty

func (color Color) NotEmpty() bool

NotEmpty returns TRUE if this color is NOT empty

func (Color) RGBA

func (c Color) RGBA() string

func (Color) String

func (c Color) String() string

func (Color) Text

func (c Color) Text() Color

Text returns either black or white to use as text on top of the current color.

func (Color) TextExt

func (c Color) TextExt() Color

TextExt uses the extended color tools to return a color that is suitable for text on top of the current color. It returns black or white for medium-range colors, and a blended value for very light and very dark colors.