color

Documentation

Index

• Constants
• Variables
• func Darken(colorString string) (string, error)
• func GradientToSVG(gradient Gradient) string
• func IsGradient(color string) bool
• func IsThemeColor(colorString string) bool
• func LinearGradientToSVG(gradient Gradient) string
• func Luminance(colorString string) (float64, error)
• func LuminanceCategory(colorString string) (string, error)
• func RadialGradientToSVG(gradient Gradient) string
• func UniqueGradientID(cssGradient string) string
• func ValidColor(color string) bool
• type ColorStop
• type Gradient
  • func ParseGradient(cssGradient string) (Gradient, error)
• type RGB
  • func Hex2RGB(hex string) (RGB, error)
  • func Name2RGB(name string) RGB
  • func (c *RGB) IsLight() bool

Constants

const (
	N1 = "N1" // foreground color
	N2 = "N2"
	N3 = "N3"
	N4 = "N4"
	N5 = "N5"
	N6 = "N6"
	N7 = "N7" // background color

	// Base Colors: used for containers
	B1 = "B1"
	B2 = "B2"
	B3 = "B3"
	B4 = "B4"
	B5 = "B5"
	B6 = "B6"

	// Alternative colors A
	AA2 = "AA2"
	AA4 = "AA4"
	AA5 = "AA5"

	// Alternative colors B
	AB4 = "AB4"
	AB5 = "AB5"

	// Special
	Empty = ""
	None  = "none"
)

Variables

var ColorHexRegex = regexp.MustCompile(`^#(([0-9a-fA-F]{2}){3}|([0-9a-fA-F]){3})$`)

var GradientRegex = regexp.MustCompile(`^(linear|radial)-gradient\((.+)\)$`)

var NamedColors = []string{}/* 150 elements not displayed */

Functions

func Darken

func Darken(colorString string) (string, error)

func GradientToSVG

func GradientToSVG(gradient Gradient) string

func IsGradient

func IsGradient(color string) bool

func IsThemeColor

func IsThemeColor(colorString string) bool

func LinearGradientToSVG

func LinearGradientToSVG(gradient Gradient) string

func Luminance

func Luminance(colorString string) (float64, error)

func LuminanceCategory

func LuminanceCategory(colorString string) (string, error)

func RadialGradientToSVG

func RadialGradientToSVG(gradient Gradient) string

func UniqueGradientID

func UniqueGradientID(cssGradient string) string

func ValidColor

func ValidColor(color string) bool

Types

type ColorStop

type ColorStop struct {
	Color    string
	Position string
}

type Gradient

type Gradient struct {
	Type       string
	Direction  string
	ColorStops []ColorStop
	ID         string
}

func ParseGradient

func ParseGradient(cssGradient string) (Gradient, error)

type RGB

type RGB struct {
	Red   uint8
	Green uint8
	Blue  uint8
}

func Hex2RGB

func Hex2RGB(hex string) (RGB, error)

https://gist.github.com/CraigChilds94/6514edbc6a2db5e434a245487c525c75

func Name2RGB

func Name2RGB(name string) RGB

func (*RGB) IsLight

func (c *RGB) IsLight() bool

https://github.com/go-playground/colors/blob/main/rgb.go#L89