ux

Documentation

Index

• Variables
• type MockProgressIndicator
  • func NewMockProgressIndicator() *MockProgressIndicator
  • func (s MockProgressIndicator) Canceled(string)
  • func (s *MockProgressIndicator) Fail(string)
  • func (s *MockProgressIndicator) Start(string)
  • func (s MockProgressIndicator) Stop()
  • func (s MockProgressIndicator) Success(string)
• type MockPrompter
  • func NewMockPrompter() *MockPrompter
  • func (p *MockPrompter) MultiSelect(msg string, options []string) ([]string, error)
  • func (p *MockPrompter) PromptYesNo(msg string) (bool, error)
• type PlainProgress
  • func NewPlainProgress() *PlainProgress
  • func (p *PlainProgress) Canceled(msg string)
  • func (p *PlainProgress) Fail(msg string)
  • func (p *PlainProgress) Start(msg string)
  • func (p *PlainProgress) Stop()
  • func (p *PlainProgress) Success(msg string)
• type ProgressIndicator
• type PromptUIPrompter
  • func NewPromptUIPrompter() *PromptUIPrompter
  • func (p *PromptUIPrompter) MultiSelect(msg string, options []string) ([]string, error)
  • func (p *PromptUIPrompter) PromptYesNo(msg string) (bool, error)
• type Spinner
  • func NewSpinner() *Spinner
  • func (s *Spinner) Canceled(msg string)
  • func (s *Spinner) Fail(msg string)
  • func (s *Spinner) Start(msg string)
  • func (s *Spinner) Stop()
  • func (s *Spinner) Success(msg string)

Variables

var (
	IconCheckmark      = "\u2714"
	IconMultiplication = "\u274C"
	IconMinus          = "\u2212"
	IconArrowRight     = "\u2B95"
	IconExclamation    = "\u0021"
	IconCircleSlash    = "\u2298"

	IconSuccess     = color.GreenString(IconCheckmark)
	IconError       = color.YellowString(IconExclamation) // We display "warning"	 symbol to avoid scary "red" colors
	IconUnsupported = color.RedString(IconCircleSlash)
)

Unicode characters https://unicode-table.com/en/

Types

type MockProgressIndicator

type MockProgressIndicator struct{}

func NewMockProgressIndicator

func NewMockProgressIndicator() *MockProgressIndicator

func (MockProgressIndicator) Canceled

func (s MockProgressIndicator) Canceled(string)

func (*MockProgressIndicator) Fail

func (s *MockProgressIndicator) Fail(string)

func (*MockProgressIndicator) Start

func (s *MockProgressIndicator) Start(string)

func (MockProgressIndicator) Stop

func (s MockProgressIndicator) Stop()

func (MockProgressIndicator) Success

func (s MockProgressIndicator) Success(string)

type MockPrompter

type MockPrompter struct {
	PromptYesNoVal             bool
	PromptMultiSelectAll       bool
	PromptYesNoErr             error
	PromptYesNoCallCount       int
	PromptMultiSelectVal       []string
	PromptMultiSelectErr       error
	PromptMultiSelectCallCount int
}

func NewMockPrompter

func NewMockPrompter() *MockPrompter

func (*MockPrompter) MultiSelect

func (p *MockPrompter) MultiSelect(msg string, options []string) ([]string, error)

func (*MockPrompter) PromptYesNo

func (p *MockPrompter) PromptYesNo(msg string) (bool, error)

type PlainProgress

type PlainProgress struct {
}

func NewPlainProgress

func NewPlainProgress() *PlainProgress

func (*PlainProgress) Canceled

func (p *PlainProgress) Canceled(msg string)

func (*PlainProgress) Fail

func (p *PlainProgress) Fail(msg string)

func (*PlainProgress) Start

func (p *PlainProgress) Start(msg string)

func (*PlainProgress) Stop

func (p *PlainProgress) Stop()

func (*PlainProgress) Success

func (p *PlainProgress) Success(msg string)

type ProgressIndicator

type ProgressIndicator interface {
	Canceled(string)
	Fail(string)
	Success(string)
	Start(string)
	Stop()
}

type PromptUIPrompter

type PromptUIPrompter struct{}

func NewPromptUIPrompter

func NewPromptUIPrompter() *PromptUIPrompter

func (*PromptUIPrompter) MultiSelect

func (p *PromptUIPrompter) MultiSelect(msg string, options []string) ([]string, error)

func (*PromptUIPrompter) PromptYesNo

func (p *PromptUIPrompter) PromptYesNo(msg string) (bool, error)

type Spinner

type Spinner struct {
	*spinnerLib.Spinner
}

func NewSpinner

func NewSpinner() *Spinner

func (*Spinner) Canceled

func (s *Spinner) Canceled(msg string)

func (*Spinner) Fail

func (s *Spinner) Fail(msg string)

func (*Spinner) Start

func (s *Spinner) Start(msg string)

func (*Spinner) Stop

func (s *Spinner) Stop()

func (*Spinner) Success

func (s *Spinner) Success(msg string)