catppuccingo

README

Catppuccin for Go

Usage

1. Run go get github.com/catppuccin/go.
2. Add import catppuccin "github.com/catppuccin/go" to your file.
3. Refer to the pkg.go.dev documentation and _examples/main.go for usage.

Contributing

This repository uses Whiskers to generate the Go flavor files.

Ensure whiskers and go are in your $PATH, and run:

go generate ./...

💝 Thanks to

• Carlos Becker

 

Copyright © 2021-present Catppuccin Org

Documentation

Index

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

Types

type Color

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

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

func (Color) RGBA

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

RGBA implements color.Color

type Flavor

type Flavor 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
}

Flavor is an interface implemented by all Catppuccin variations.

var Frappe Flavor = frappe{}

Frappé flavor variant

var Latte Flavor = latte{}

Latte flavor variant

var Macchiato Flavor = macchiato{}

Macchiato flavor variant

var Mocha Flavor = mocha{}

Mocha flavor variant

type Flavour

type Flavour = Flavor

Theme and Flavour are type aliases of Flavor to keep compatibility with previous versions.

type Theme

type Theme = Flavour

Theme and Flavour are type aliases of Flavor to keep compatibility with previous versions.

func Variant

func Variant(flavor string) Theme

Variant returns the Theme variant by name.