nipponcolors

README

nippon-colors

Traditional Japan colors for 24bit terminal

Overview

Nippon colors is a collection of colors traditionally used in Japanese arts and crafts. This library exposes those colors for 24bit terminal output as a collection of wrappers of gookit.Color types. The color list and data taken from nipponcolor PWA repository.

Usage

import (
	color "github.com/eiri/nippon-colors"
)

func main() {
    color.Tsutsuji.Print("Azalea")
}

License

MIT

Documentation

Overview

THIS MODULE WAS GENERATED, DO NOT EDIT MANUALLY

Index

• Constants
• type Color
  • func (c Color) Hue() string
  • func (c Color) Name() string
  • func (c Color) Print(args ...interface{})
  • func (c Color) Printf(format string, args ...interface{})
  • func (c Color) Println(args ...interface{})
  • func (c Color) Shade() string
  • func (c Color) String() string
• type NipponColor

Constants

const (
	Red hue = iota + 305
	Black
	White
	Purple
	Cyan
	Green
	Yellow
)

const (
	Dark shade = iota + 300
	Bright
)

Types

type Color

type Color uint8

Color is an integer representation of a color

const (
	Nadeshiko Color = iota
	Kohbai
	Suoh
	Taikoh
	Ikkonzome
	Kuwazome
	Momo
	Ichigo
	Usubeni
	Imayoh
	Nakabeni
	Sakura
	Umenezumi
	Karakurenai
	Enji
	Kurenai
	Toki
	Cyohsyun
	Kokiake
	Sakuranezumi
	Jinzamomi
	Azuki
	Suohkoh
	Akabeni
	Shinsyu
	Haizakura
	Kuriume
	Ebicha
	Ginsyu
	Kurotobi
	Benitobi
	Akebono
	Benikaba
	Mizugaki
	Sangosyu
	Benihiwada
	Syojyohi
	Entan
	Shikancha
	Hiwada
	Kakishibu
	Ake
	Tobi
	Benihi
	Kurikawacha
	Bengara
	Terigaki
	Edocha
	Araisyu
	Momoshiocha
	Karacha
	Tokigaracha
	Ohni
	Sohi
	Ensyucha
	Kabacha
	Kogecha
	Akakoh
	Suzumecha
	Shishi
	Sodenkaracha
	Kaba
	Kokikuchinashi
	Kurumi
	Taisya
	Araigaki
	Kohrozen
	Akakuchiba
	Tonocha
	Akashirotsurubami
	Sencha
	Kanzo
	Sharegaki
	Beniukon
	Umezome
	Biwacha
	Chojicha
	Kenpohzome
	Kohaku
	Usugaki
	Kyara
	Chojizome
	Fushizome
	Kuchiba
	Kincha
	Kitsune
	Susutake
	Usukoh
	Tonoko
	Ginsusutake
	Ohdo
	Shiracha
	Kobicha
	Kigaracha
	Yamabuki
	Yamabukicha
	Hajizome
	Kuwacha
	Tamago
	Shirotsurubami
	Kitsurubami
	Tamamorokoshi
	Hanaba
	Namakabe
	Torinoko
	Usuki
	Kikuchiba
	Kuchinashi
	Tohoh
	Ukon
	Karashi
	Higosusutake
	Rikyushiracha
	Aku
	Rikyucha
	Rokohcha
	Nataneyu
	Uguisucha
	Kimirucha
	Mirucha
	Kariyasu
	Nanohana
	Kihada
	Mushikuri
	Aokuchiba
	Ominaeshi
	Hiwacha
	Hiwa
	Uguisu
	Yanagicha
	Koke
	Kikujin
	Rikancha
	Aikobicha
	Miru
	Sensaicha
	Baikocha
	Hiwamoegi
	Yanagizome
	Urayanagi
	Iwaicha
	Moegi
	Nae
	Yanagisusutake
	Matsuba
	Aoni
	Usuao
	Yanaginezumi
	Tokiwa
	Wakatake
	Chitosemidori
	Midori
	Byakuroku
	Oitake
	Tokusa
	Onandocha
	Rokusyoh
	Sabiseiji
	Aotake
	Veludo
	Mushiao
	Aimirucha
	Tonocha2
	Aomidori
	Seiji
	Tetsu
	Mizuasagi
	Seiheki
	Sabitetsuonando
	Korainando
	Byakugun
	Omeshicha
	Kamenozoki
	Fukagawanezumi
	Sabiasagi
	Mizu
	Asagi
	Onando
	Ai
	Shinbashi
	Sabionando
	Tetsuonando
	Hanaasagi
	Ainezumi
	Masuhana
	Sora
	Noshimehana
	Chigusa
	Omeshionando
	Hanada
	Wasurenagusa
	Gunjyo
	Tsuyukusa
	Kurotsurubami
	Kon
	Kachi
	Ruri
	Rurikon
	Benimidori
	Fujinezumi
	Tetsukon
	Konjyo
	Benikakehana
	Konkikyo
	Fuji
	Futaai
	Ouchi
	Fujimurasaki
	Kikyo
	Shion
	Messhi
	Usu
	Hashita
	Edomurasaki
	Shikon
	Kokimurasaki
	Sumire
	Murasaki
	Ayame
	Fujisusutake
	Benifuji
	Kurobeni
	Nasukon
	Budohnezumi
	Hatobanezumi
	Kakitsubata
	Ebizome
	Botan
	Umemurasaki
	Nisemurasaki
	Tsutsuji
	Murasakitobi
	Shironeri
	Gofun
	Shironezumi
	Ginnezumi
	Namari
	Hai
	Sunezumi
	Rikyunezumi
	Nibi
	Aonibi
	Dobunezumi
	Benikeshinezumi
	Aisumicha
	Binrojizome
	Keshizumi
	Sumi
	Kuro
	Ro
)

func (Color) Hue

func (c Color) Hue() string

Hue returns string representation of a hue for a given color

func (Color) Name

func (c Color) Name() string

Name returns original kanji name of a given color

func (Color) Print

func (c Color) Print(args ...interface{})

Print marshals arguments to according wrapped gookit.Color method

func (Color) Printf

func (c Color) Printf(format string, args ...interface{})

Printf marshals arguments to according wrapped gookit.Color method

func (Color) Println

func (c Color) Println(args ...interface{})

Println marshals arguments to according wrapped gookit.Color method

func (Color) Shade

func (c Color) Shade() string

Shade returns string representation of a shade for a given color

func (Color) String

func (c Color) String() string

String implements stringer interface for a given color

type NipponColor

type NipponColor struct {
	Name           string `json:"name"`
	Color          string `json:"color"`
	Shade          shade  `json:"shade"`
	Hue            hue    `json:"hue"`
	Red            uint8  `json:"red"`
	Green          uint8  `json:"green"`
	Blue           uint8  `json:"blue"`
	color.RGBColor `json:"-"`
}

NipponColor is a wrapper for gookit/color's RGBColor type