color

package

v0.2.3 Latest Latest Go to latest Published: Sep 1, 2015 License: MIT Imports: 6 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cosiner/gohper

Links

Open Source Insights

Documentation ¶

Overview ¶

Package color enable color output for terminal use ansi escape code

Index ¶

Constants
Variables
func Has(c string) bool
type Renderer
type Writer
- func (w Writer) Write(bs []byte) (int, error)

Constants ¶

View Source

const (
	BLACK   = "black"
	RED     = "red"
	GREEN   = "green"
	YELLOW  = "yellow"
	BLUE    = "blue"
	MAGENTA = "magenta"
	CYAN    = "cyan"
	WHITE   = "white"
)

Variables ¶

View Source

var (
	LightBlack   = FgHl(BLACK)
	LightRed     = FgHl(RED)
	LightGreen   = FgHl(GREEN)
	LightYellow  = FgHl(YELLOW)
	LightBlue    = FgHl((BLUE))
	LightMagenta = FgHl(MAGENTA)
	LightCyan    = FgHl(CYAN)
	LightWhite   = FgHl(WHITE)

	Black   = Fg(BLACK)
	Red     = Fg(RED)
	Green   = Fg(GREEN)
	Yellow  = Fg(YELLOW)
	Blue    = Fg((BLUE))
	Magenta = Fg(MAGENTA)
	Cyan    = Fg(CYAN)
	White   = Fg(WHITE)
)

Functions ¶

func Has ¶

func Has(c string) bool

Has check whether a color can be use

Types ¶

type Renderer ¶

type Renderer struct {
	// contains filtered or unexported fields
}

Renderer is a render for terminal string

func Fg ¶

func Fg(color string) *Renderer

Fg is a quick way to New().Fg(color).Finish()

func FgHl ¶

func FgHl(color string) *Renderer

FgHl is a quick way to New().Fg(color).Highlight().Finish()

func New ¶

func New(codes ...string) *Renderer

New a terminal color render,

func (*Renderer) Begin ¶

func (r *Renderer) Begin(w io.Writer) error

func (*Renderer) Disable ¶

func (r *Renderer) Disable()

Disable color render

func (*Renderer) End ¶

func (r *Renderer) End(w io.Writer) error

func (*Renderer) Error ¶

func (r *Renderer) Error(args ...interface{}) (int, error)

func (*Renderer) Errorf ¶

func (r *Renderer) Errorf(format string, args ...interface{}) (int, error)

func (*Renderer) Errorln ¶

func (r *Renderer) Errorln(args ...interface{}) (int, error)

func (*Renderer) Fprint ¶

func (r *Renderer) Fprint(w io.Writer, args ...interface{}) (int, error)

func (*Renderer) Fprintf ¶

func (r *Renderer) Fprintf(w io.Writer, format string, args ...interface{}) (int, error)

func (*Renderer) Fprintln ¶

func (r *Renderer) Fprintln(w io.Writer, args ...interface{}) (int, error)

func (*Renderer) Print ¶

func (r *Renderer) Print(args ...interface{}) (int, error)

func (*Renderer) Printf ¶

func (r *Renderer) Printf(format string, args ...interface{}) (int, error)

func (*Renderer) Println ¶

func (r *Renderer) Println(args ...interface{}) (int, error)

func (*Renderer) Render ¶

func (r *Renderer) Render(str string) string

Render rend a string

func (*Renderer) RenderTo ¶

func (r *Renderer) RenderTo(w io.Writer, str string) (int, error)

RenderTo render string to writer

func (*Renderer) Sprint ¶

func (r *Renderer) Sprint(args ...interface{}) string

func (*Renderer) Sprintf ¶

func (r *Renderer) Sprintf(format string, args ...interface{}) string

func (*Renderer) Sprintln ¶

func (r *Renderer) Sprintln(args ...interface{}) string

func (*Renderer) Writer ¶

func (r *Renderer) Writer(prefix string, w io.Writer) io.Writer

type Writer ¶

type Writer struct {
	Prefix string
	io.Writer
	*Renderer
}

func (Writer) Write ¶

func (w Writer) Write(bs []byte) (int, error)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
output

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL