colors

Documentation

Overview

Package colors provides helper functions to manage color and color schemes.

Index

• func Colorful(c colorful.Color) bar.Color
• func Empty() bar.Color
• func Hex(hex string) bar.Color
• func LoadFromArgs(args []string)
• func LoadFromConfig(filename string) error
• func LoadFromMap(s map[string]string)
• func Scheme(name string) bar.Color

Functions

func Colorful

func Colorful(c colorful.Color) bar.Color

Colorful constructs an i3 color from a colorful color.

func Empty

func Empty() bar.Color

Empty returns an "empty" color, which will not be sent to i3.

func Hex

func Hex(hex string) bar.Color

Hex sanity-checks and constructs a color from a hex-string. Any string that can be parsed by colorful is acceptable.

func LoadFromArgs

func LoadFromArgs(args []string)

LoadFromArgs loads a color scheme from command-line arguments of the form name=value.

func LoadFromConfig

func LoadFromConfig(filename string) error

LoadFromConfig loads a color scheme from a i3status config file by reading all keys that start with 'color_'

func LoadFromMap

func LoadFromMap(s map[string]string)

LoadFromMap sets the colour scheme from code.

func Scheme

func Scheme(name string) bar.Color

Scheme gets a color from the user-defined color scheme. Some common names are 'good', 'bad', and 'degraded'.