colorhash

README

colorhash

Deterministic color assignment from arbitrary input. Feed it a string or byte stream and get back a consistent color every time.

Features

• Deterministic — same input always produces the same color
• Pluggable palettes — bring your own ColorSet or use simplecolorpalettes
• Multiple output formats — color.Color, ANSI escape codes, true-color terminal strings
• String and byte input — hash strings directly or stream bytes via io.Reader

Install

go get github.com/taigrr/colorhash

Usage

Hash a string to a color

import (
    "github.com/taigrr/colorhash"
    "github.com/taigrr/simplecolorpalettes/palettes/html"
)

palette := html.GetPalette() // or any ColorSet
c := colorhash.StringToColor(palette, "username")
// c is a deterministic color.Color

ANSI terminal colors

fmt.Println(colorhash.Red("error message"))
fmt.Println(colorhash.Green("success"))
fmt.Println(colorhash.BIYellow("bold high-intensity yellow"))

Automatic color from a palette

sp := colorhash.CreateStringerPalette(false, false, palette)
colored := sp.GetString("username") // wraps "username" in its assigned color

License

0BSD

Documentation

Index

• Constants
• Variables
• func BytesToColor(p ColorSet, r io.Reader) color.Color
• func GenerateOKLCHPalette(n int, l, c float64) simplecolor.SimplePalette
• func GetBackgroundColor(c color.Color) color.Color
• func HashBytes(r io.Reader) int
• func HashString(s string) int
• func StringToColor(p ColorSet, s string) color.Color
• type ColorSet
• type ColorStringer
  • func ColorString(colorString string) ColorStringer
• type StringerPalette
  • func (sp StringerPalette) GetString(s string) string

Constants

const (
	MaxUint = ^uint(0)
	MaxInt  = int(MaxUint >> 1)
)

Variables

var (
	Info  = Teal
	Warn  = Yellow
	Fatal = Red
)

var (
	Black   = ColorString("\033[1;30m%s\033[0m")
	Red     = ColorString("\033[1;31m%s\033[0m")
	Green   = ColorString("\033[1;32m%s\033[0m")
	Yellow  = ColorString("\033[1;33m%s\033[0m")
	Purple  = ColorString("\033[1;34m%s\033[0m")
	Magenta = ColorString("\033[1;35m%s\033[0m")
	Teal    = ColorString("\033[0;97m%s\033[0m")
	White   = ColorString("\033[1;37m%s\033[0m")
	//  Bold
	BBlack  = ColorString("\033[1;30m%s\033[0m")
	BRed    = ColorString("\033[1;31m%s\033[0m")
	BGreen  = ColorString("\033[1;32m%s\033[0m")
	BYellow = ColorString("\033[1;33m%s\033[0m")
	BBlue   = ColorString("\033[1;34m%s\033[0m")
	BPurple = ColorString("\033[1;35m%s\033[0m")
	BCyan   = ColorString("\033[1;36m%s\033[0m")
	BWhite  = ColorString("\033[1;37m%s\033[0m")

	//  Underline
	UBlack  = ColorString("\033[4;30m%s\033[0m")
	URed    = ColorString("\033[4;31m%s\033[0m")
	UGreen  = ColorString("\033[4;32m%s\033[0m")
	UYellow = ColorString("\033[4;33m%s\033[0m")
	UBlue   = ColorString("\033[4;34m%s\033[0m")
	UPurple = ColorString("\033[4;35m%s\033[0m")
	UCyan   = ColorString("\033[4;36m%s\033[0m")
	UWhite  = ColorString("\033[4;37m%s\033[0m")

	//  Background
	OnBlack  = ColorString("\033[40m%s\033[0m")
	OnRed    = ColorString("\033[41m%s\033[0m")
	OnGreen  = ColorString("\033[42m%s\033[0m")
	OnYellow = ColorString("\033[43m%s\033[0m")
	OnBlue   = ColorString("\033[44m%s\033[0m")
	OnPurple = ColorString("\033[45m%s\033[0m")
	OnCyan   = ColorString("\033[46m%s\033[0m")
	OnWhite  = ColorString("\033[47m%s\033[0m")

	//  High Intensty
	IBlack  = ColorString("\033[0;90m%s\033[0m")
	IRed    = ColorString("\033[0;91m%s\033[0m")
	IGreen  = ColorString("\033[0;92m%s\033[0m")
	IYellow = ColorString("\033[0;93m%s\033[0m")
	IBlue   = ColorString("\033[0;94m%s\033[0m")
	IPurple = ColorString("\033[0;95m%s\033[0m")
	ICyan   = ColorString("\033[0;96m%s\033[0m")
	IWhite  = ColorString("\033[0;97m%s\033[0m")

	//  Bold High Intensty
	BIBlack  = ColorString("\033[1;90m%s\033[0m")
	BIRed    = ColorString("\033[1;91m%s\033[0m")
	BIGreen  = ColorString("\033[1;92m%s\033[0m")
	BIYellow = ColorString("\033[1;93m%s\033[0m")
	BIBlue   = ColorString("\033[1;94m%s\033[0m")
	BIPurple = ColorString("\033[1;95m%s\033[0m")
	BICyan   = ColorString("\033[1;96m%s\033[0m")
	BIWhite  = ColorString("\033[1;97m%s\033[0m")

	//  High Intensty backgrounds
	OnIBlack  = ColorString("\033[0;100m%s\033[0m")
	OnIRed    = ColorString("\033[0;101m%s\033[0m")
	OnIGreen  = ColorString("\033[0;102m%s\033[0m")
	OnIYellow = ColorString("\033[0;103m%s\033[0m")
	OnIBlue   = ColorString("\033[0;104m%s\033[0m")
	OnIPurple = ColorString("\033[10;95m%s\033[0m")
	OnICyan   = ColorString("\033[0;106m%s\033[0m")
	OnIWhite  = ColorString("\033[0;107m%s\033[0m")
)

Functions

func BytesToColor

func BytesToColor(p ColorSet, r io.Reader) color.Color

func GenerateOKLCHPalette

func GenerateOKLCHPalette(n int, l, c float64) simplecolor.SimplePalette

GenerateOKLCHPalette generates n evenly-spaced colors in the OKLCH color space at the given lightness and chroma. This produces a perceptually uniform palette where all colors appear equally bright and saturated.

func GetBackgroundColor

func GetBackgroundColor(c color.Color) color.Color

func HashBytes

func HashBytes(r io.Reader) int

func HashString

func HashString(s string) int

func StringToColor

func StringToColor(p ColorSet, s string) color.Color

Types

type ColorSet

type ColorSet interface {
	ToPalette() color.Palette
	Get(int) color.Color
	Len() int
}

type ColorStringer

type ColorStringer func(...interface{}) string

func ColorString

func ColorString(colorString string) ColorStringer

type StringerPalette

type StringerPalette []ColorStringer

func (StringerPalette) GetString

func (sp StringerPalette) GetString(s string) string