cell

package

v0.20.0 Latest Latest Go to latest Published: Mar 10, 2024 License: Apache-2.0 Imports: 1 Imported by: 119

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/mum4k/termdash

Links

Open Source Insights

Documentation ¶

Overview ¶

Package cell implements cell options and attributes.

Index ¶

type Color
- func (cc Color) String() string
type Option
type Options
- func NewOptions(opts ...Option) *Options
- func (o *Options) Set(other *Options)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Color ¶

type Color int

Color is the color of a cell.

const (
	ColorDefault Color = iota

	// The 16 Xterm colors.
	// See https://jonasjacek.github.io/colors/
	ColorBlack
	ColorMaroon
	ColorGreen
	ColorOlive
	ColorNavy
	ColorPurple
	ColorTeal
	ColorSilver
	ColorGray
	ColorRed
	ColorLime
	ColorYellow
	ColorBlue
	ColorFuchsia
	ColorAqua
	ColorWhite
)

The supported terminal colors.

const (
	ColorMagenta Color = ColorPurple
	ColorCyan    Color = ColorTeal
)

Colors defined for backward compatibility with termbox-go.

func ColorNumber ¶ added in v0.4.0

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 ¶ added in v0.4.0

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 ¶ added in v0.4.0

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 Blink ¶ added in v0.13.0

func Blink() Option

Blink makes the cell's text blink. Only works when using the tcell backend.

func Bold ¶ added in v0.13.0

func Bold() Option

Bold makes cell's text bold.

func Dim ¶ added in v0.17.0

func Dim() Option

Dim makes the cell foreground color dim. Only works when using the tcell backend.

func FgColor ¶

func FgColor(color Color) Option

FgColor sets the foreground color of the cell.

func Inverse ¶ added in v0.13.0

func Inverse() Option

Inverse inverts the colors of the cell's text.

func Italic ¶ added in v0.13.0

func Italic() Option

Italic makes cell's text italic. Only works when using the tcell backend.

func Strikethrough ¶ added in v0.13.0

func Strikethrough() Option

Strikethrough strikes through the cell's text. Only works when using the tcell backend.

func Underline ¶ added in v0.13.0

func Underline() Option

Underline makes cell's text underlined.

type Options ¶

type Options struct {
	FgColor       Color
	BgColor       Color
	Bold          bool
	Italic        bool
	Underline     bool
	Strikethrough bool
	Inverse       bool
	Blink         bool
	Dim           bool
}

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 ¶ added in v0.7.2

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

Set allows existing options to be passed as an option.

Source Files ¶

View all Source files

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