termcolours

README

go-termcolours

ANSI colour escape codes for Go.

Installation

go get -u github.com/thijzert/go-termcolours

Usage

package main

import (
	"fmt"
	"github.com/thijzert/go-termcolours" tc
)

func main() {
	fmt.Printf( "This is %s; this is %s.\n", tc.Green("green"), tc.Blue("blue") )
}

License

This repository is shared under a BSD 3-clause license. See the file COPYING for details.

Documentation

Index

• Constants
• Variables
• func Background24(c color.Color, s string) string
• func Background8(colour C256, s string) string
• func Bblack(s string) string
• func Bblue(s string) string
• func Bcyan(s string) string
• func Bgreen(s string) string
• func Black(s string) string
• func Blue(s string) string
• func Bpurple(s string) string
• func Bred(s string) string
• func Bwhite(s string) string
• func Byellow(s string) string
• func Cyan(s string) string
• func Foreground24(c color.Color, s string) string
• func Foreground8(colour C256, s string) string
• func Green(s string) string
• func Purple(s string) string
• func Red(s string) string
• func White(s string) string
• func Yellow(s string) string
• type C256
  • func Colour256(r, g, b int) C256
  • func Convert256(col color.Color) C256
  • func (c C256) RGBA() (r, g, b, a uint32)

Constants

const ESC = '\x1b'

Variables

var TerminalSupports24Bit bool = false

Functions

func Background24

func Background24(c color.Color, s string) string

func Background8

func Background8(colour C256, s string) string

func Bblack

func Bblack(s string) string

Bright or bold colours:

func Bblue

func Bblue(s string) string

func Bcyan

func Bcyan(s string) string

func Bgreen

func Bgreen(s string) string

func Black

func Black(s string) string

'Normal' colours:

func Blue

func Blue(s string) string

func Bpurple

func Bpurple(s string) string

func Bred

func Bred(s string) string

func Bwhite

func Bwhite(s string) string

func Byellow

func Byellow(s string) string

func Cyan

func Cyan(s string) string

func Foreground24

func Foreground24(c color.Color, s string) string

func Foreground8

func Foreground8(colour C256, s string) string

func Green

func Green(s string) string

func Purple

func Purple(s string) string

func Red

func Red(s string) string

func White

func White(s string) string

func Yellow

func Yellow(s string) string

Types

type C256

type C256 uint8

A 256-colour type. C256 implements image/color.Color

func Colour256

func Colour256(r, g, b int) C256

func Convert256

func Convert256(col color.Color) C256

func (C256) RGBA

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