catppuccingo

README

Catppuccin for Go

Usage

1. go get github.com/catppuccin/go
2. Add animport catppuccin "github.com/catppuccin/go" to your file
3. Use the flavours as you wish.

🙋 FAQ (optional)

• Q: "Where can I find the doc?"
  A: https://pkg.go.dev/github.com/catppuccin/go

💝 Thanks to

• Carlos Becker

 

Copyright © 2021-present Catppuccin Org

Documentation

Index

• type Color
  • func (c Color) RGBA() (r uint32, g uint32, b uint32, a uint32)
• type Flavour
• type Theme
  • func Variant(flavour string) Theme

Types

type Color

type Color struct {
	Hex string
	RGB [3]uint32
	HSL [3]float32
}

Color is a color in Hex, RGB, and HSL.

func (Color) RGBA

func (c Color) RGBA() (r uint32, g uint32, b uint32, a uint32)

RGBA implements color.Color

type Flavour

type Flavour interface {
	Rosewater() Color
	Flamingo() Color
	Pink() Color
	Mauve() Color
	Red() Color
	Maroon() Color
	Peach() Color
	Yellow() Color
	Green() Color
	Teal() Color
	Sky() Color
	Sapphire() Color
	Blue() Color
	Lavender() Color
	Text() Color
	Subtext1() Color
	Subtext0() Color
	Overlay2() Color
	Overlay1() Color
	Overlay0() Color
	Surface2() Color
	Surface1() Color
	Surface0() Color
	Crust() Color
	Mantle() Color
	Base() Color
	Name() string
}

Flavour is an interface implemented by all Catppuccin variations.

var Frappe Flavour = frappe{}

Frappe flavour variant.

var Latte Flavour = latte{}

Latte flavour variant.

var Macchiato Flavour = macchiato{}

Macchiato flavour variant.

var Mocha Flavour = mocha{}

Mocha flavour variant.

type Theme

type Theme = Flavour

Theme is a type alias of Flavour to keep compatibility with previous versions.

func Variant

func Variant(flavour string) Theme

Variant returns the Theme variant by name.