tui

Documentation

Index

• Variables
• func Chip(fg, bg int, content string) string
• func Ellipsis(s string, length int) string
• func Width(s string) int
• type Output
  • func NewOutput(out *streams.Out) Output
  • func (o Output) Color(clr aec.ANSI) aec.ANSI
  • func (o Output) Print(p ...any)
  • func (o Output) PrintNote(format string, args ...any)
  • func (o Output) Println(p ...any)
  • func (o Output) PrintlnWithColor(clr aec.ANSI, args ...any)
  • func (o Output) Sprint(all ...any) string
• type Str
  • func (p Str) String(isTerminal bool) string

Variables

var (
	ColorTitle     = aec.NewBuilder(aec.DefaultF, aec.Bold).ANSI
	ColorPrimary   = aec.NewBuilder(aec.DefaultF, aec.Bold).ANSI
	ColorSecondary = aec.DefaultF
	ColorTertiary  = aec.NewBuilder(aec.DefaultF, aec.Faint).ANSI
	ColorLink      = aec.NewBuilder(aec.LightCyanF, aec.Underline).ANSI
	ColorWarning   = aec.LightYellowF
	ColorFlag      = aec.NewBuilder(aec.Bold).ANSI
	ColorNone      = aec.ANSI(noColor{})
)

var InfoHeader = Str{
	Plain: " Info -> ",
	Fancy: aec.Bold.Apply(aec.LightCyanB.Apply(aec.BlackF.Apply("i")) + " " + aec.LightCyanF.Apply("Info → ")),
}

Functions

func Chip

func Chip(fg, bg int, content string) string

func Ellipsis

func Ellipsis(s string, length int) string

Ellipsis truncates a string to a given number of runes with an ellipsis at the end. It tries to persist the ANSI escape sequences.

func Width

func Width(s string) int

Width returns the width of the string, ignoring ANSI escape codes. Not all ANSI escape codes are supported yet.

Types

type Output

type Output struct {
	*streams.Out
	// contains filtered or unexported fields
}

func NewOutput

func NewOutput(out *streams.Out) Output

func (Output) Color

func (o Output) Color(clr aec.ANSI) aec.ANSI

func (Output) Print

func (o Output) Print(p ...any)

func (Output) PrintNote

func (o Output) PrintNote(format string, args ...any)

func (Output) Println

func (o Output) Println(p ...any)

func (Output) PrintlnWithColor

func (o Output) PrintlnWithColor(clr aec.ANSI, args ...any)

func (Output) Sprint

func (o Output) Sprint(all ...any) string

type Str

type Str struct {
	// Fancy is the fancy string representation of the string.
	Fancy string

	// Plain is the plain string representation of the string.
	Plain string
}

func (Str) String

func (p Str) String(isTerminal bool) string