ui

Documentation

Index

• Variables
• func Ask(message, provided string, defaultValue ...string) string
• func AskOrReturnToExit(message string, defaultValue ...string) string
• func GetValidatorFor(prop validation.Validatable) survey.Validator
• func HandleError(err error)
• func MultiSelect(message string, options []string, defaultValues []string) []string
• func OutputError(msg string)
• func OutputMessage(msg string)
• func OutputSelection(msg, choice string)
• func Proceed(message string) bool
• func Select(message string, options []string, defaultValue ...string) string
• func SelectFromOtherErrorMessage(msg, wrong string) string
• func SelectOrCheckExisting(parameterValue *string, capitalizedParameterName string, validValues []string, ...)
• type Displayable
  • func SelectDisplayable(message string, options DisplayableMap, defaultValue ...string) Displayable
• type DisplayableMap
  • func NewDisplayableMap(size int) DisplayableMap
  • func (d *DisplayableMap) Add(displayable Displayable)
  • func (d DisplayableMap) AsDisplayableOptions() []string
  • func (d DisplayableMap) GetByIndex(i int) Displayable
  • func (d DisplayableMap) GetByName(name string) (Displayable, bool)
  • func (d DisplayableMap) Len() int
  • func (d DisplayableMap) Less(i, j int) bool
  • func (d DisplayableMap) Swap(i, j int)

Variables

var Empty = DisplayableMap{}

Functions

func Ask

func Ask(message, provided string, defaultValue ...string) string

func AskOrReturnToExit

func AskOrReturnToExit(message string, defaultValue ...string) string

func GetValidatorFor

func GetValidatorFor(prop validation.Validatable) survey.Validator

GetValidatorFor returns an implementation specific validator for the given validatable to avoid type casting at each calling site

func HandleError

func HandleError(err error)

HandleError handles UI-related errors, in particular useful to gracefully handle ctrl-c interrupts gracefully

func MultiSelect

func MultiSelect(message string, options []string, defaultValues []string) []string

func OutputError

func OutputError(msg string)

func OutputMessage

func OutputMessage(msg string)

func OutputSelection

func OutputSelection(msg, choice string)

func Proceed

func Proceed(message string) bool

Proceed displays a given message and asks the user if they want to proceed

func Select

func Select(message string, options []string, defaultValue ...string) string

func SelectFromOtherErrorMessage

func SelectFromOtherErrorMessage(msg, wrong string) string

func SelectOrCheckExisting

func SelectOrCheckExisting(parameterValue *string, capitalizedParameterName string, validValues []string, validator func() bool)

Types

type Displayable

type Displayable interface {
	Help() string
	Display() string
	Name() string
	GetUnderlying() interface{}
}

func SelectDisplayable

func SelectDisplayable(message string, options DisplayableMap, defaultValue ...string) Displayable

type DisplayableMap

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

func NewDisplayableMap

func NewDisplayableMap(size int) DisplayableMap

func (*DisplayableMap) Add

func (d *DisplayableMap) Add(displayable Displayable)

func (DisplayableMap) AsDisplayableOptions

func (d DisplayableMap) AsDisplayableOptions() []string

func (DisplayableMap) GetByIndex

func (d DisplayableMap) GetByIndex(i int) Displayable

func (DisplayableMap) GetByName

func (d DisplayableMap) GetByName(name string) (Displayable, bool)

func (DisplayableMap) Len

func (d DisplayableMap) Len() int

func (DisplayableMap) Less

func (d DisplayableMap) Less(i, j int) bool

func (DisplayableMap) Swap

func (d DisplayableMap) Swap(i, j int)