tui

Documentation

Index

• Constants
• Variables
• type Colorizer
  • func NewColorizer(enabled bool) Colorizer
  • func (c Colorizer) Wrap(code, text string) string
• type Spinner
  • func NewSpinner(out io.Writer, opts ...SpinnerOption) *Spinner
  • func (s *Spinner) Start(msg string)
  • func (s *Spinner) Stop(clear bool)
  • func (s *Spinner) Update(msg string)
• type SpinnerOption
  • func WithColor(colorizer Colorizer, frameColor string) SpinnerOption
  • func WithFrames(frames []string) SpinnerOption
  • func WithHideCursor(hide bool) SpinnerOption
  • func WithInterval(d time.Duration) SpinnerOption

Constants

const (
	ColorReset  = "\x1b[0m"
	ColorRed    = "\x1b[31m"
	ColorGreen  = "\x1b[32m"
	ColorYellow = "\x1b[33m"
	ColorDim    = "\x1b[90m"
)

Variables

var DefaultFrames = []string{"⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"}

Types

type Colorizer

type Colorizer struct {
	Enabled bool
}

func NewColorizer

func NewColorizer(enabled bool) Colorizer

func (Colorizer) Wrap

func (c Colorizer) Wrap(code, text string) string

type Spinner

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

func NewSpinner

func NewSpinner(out io.Writer, opts ...SpinnerOption) *Spinner

func (*Spinner) Start

func (s *Spinner) Start(msg string)

func (*Spinner) Stop

func (s *Spinner) Stop(clear bool)

func (*Spinner) Update

func (s *Spinner) Update(msg string)

type SpinnerOption

type SpinnerOption func(*Spinner)

func WithColor

func WithColor(colorizer Colorizer, frameColor string) SpinnerOption

func WithFrames

func WithFrames(frames []string) SpinnerOption

func WithHideCursor

func WithHideCursor(hide bool) SpinnerOption

func WithInterval

func WithInterval(d time.Duration) SpinnerOption