ui

Documentation

Index

• type Checkmark
• type Printer
• type Spinner
• type UI
  • func NewPTermUI() UI

Types

type Checkmark

type Checkmark struct {
	Checked   string
	Unchecked string
}

type Printer

type Printer interface {
	Printfln(format string, a ...interface{})
	Printf(format string, a ...interface{})
	Println(a ...interface{})
	Print(a ...interface{})
}

type Spinner

type Spinner interface {
	Success(message ...interface{})
	Warning(message ...interface{})
	Fail(message ...interface{})
}

type UI

type UI interface {
	AskForUsersInput(message string) string
	DisplayInteractiveMultiselect(msg string, options []string, checkMark Checkmark, optionsDefaultAll, filter bool, maxHeight int) []string
	DisplayInteractiveSelect(msg string, options []string, filter bool, maxHeight int) string
	DisplaySelectedItems(items []string)
	AskForUsersConfirmation(message string) bool
	StartSpinner(message string) Spinner

	// Printers
	Info() Printer
	Success() Printer
	Error() Printer
	Warning() Printer
	DefaultBox() Printer

	// Colors
	Green(...interface{}) string
	Red(...interface{}) string
	Yellow(...interface{}) string
	Blue(...interface{}) string

	//
	BasicCheckmark() Checkmark
}

func NewPTermUI

func NewPTermUI() UI

NewPTermUI creates a new ptermUI instance