cell

Documentation

Overview

Package cell implements cell options and attributes.

Index

• type Color
  • func ColorNumber(n int) Color
  • func ColorRGB24(r, g, b int) Color
  • func ColorRGB6(r, g, b int) Color
  • func (cc Color) String() string
• type Option
  • func BgColor(color Color) Option
  • func FgColor(color Color) Option
• type Options
  • func NewOptions(opts ...Option) *Options
  • func (o *Options) Set(other *Options)

Types

type Color

type Color int

Color is the color of a cell.

const (
	ColorDefault Color = iota

	// 8 "system" colors.
	ColorBlack
	ColorRed
	ColorGreen
	ColorYellow
	ColorBlue
	ColorMagenta
	ColorCyan
	ColorWhite
)

The supported terminal colors.

func ColorNumber

func ColorNumber(n int) Color

ColorNumber sets a color using its number. Make sure your terminal is set to a terminalapi.ColorMode that supports the target color. The provided value must be in the range 0-255. Larger or smaller values will be reset to the default color.

For reference on these colors see the Xterm number in: https://jonasjacek.github.io/colors/

func ColorRGB24

func ColorRGB24(r, g, b int) Color

ColorRGB24 sets a color using the 24 bit web color scheme. Make sure your terminal is set to the terminalapi.ColorMode256 mode. The provided values (r, g, b) must be in the range 0-255. Larger or smaller values will be reset to the default color.

For reference on these colors see the RGB column in: https://jonasjacek.github.io/colors/

func ColorRGB6

func ColorRGB6(r, g, b int) Color

ColorRGB6 sets a color using the 6x6x6 terminal color. Make sure your terminal is set to the terminalapi.ColorMode256 mode. The provided values (r, g, b) must be in the range 0-5. Larger or smaller values will be reset to the default color.

For reference on these colors see: https://superuser.com/questions/783656/whats-the-deal-with-terminal-colors

func (Color) String

func (cc Color) String() string

String implements fmt.Stringer()

type Option

type Option interface {
	// Set sets the provided option.
	Set(*Options)
}

Option is used to provide options for cells on a 2-D terminal.

func BgColor

func BgColor(color Color) Option

BgColor sets the background color of the cell.

func FgColor

func FgColor(color Color) Option

FgColor sets the foreground color of the cell.

type Options

type Options struct {
	FgColor Color
	BgColor Color
}

Options stores the provided options.

func NewOptions

func NewOptions(opts ...Option) *Options

NewOptions returns a new Options instance after applying the provided options.

func (*Options) Set

func (o *Options) Set(other *Options)

Set allows existing options to be passed as an option.