ui

Documentation

Index

• type FileReader
• type FileWriter
• type InputOption
  • func WithDefault(d string) InputOption
  • func WithHelp(help string) InputOption
  • func WithSuggestion(fn func(toComplete string) []string) InputOption
• type RGB
  • func HEX(hex string) (RGB, error)
  • func (c RGB) B() int
  • func (c RGB) G() int
  • func (c RGB) R() int
  • func (c RGB) Values() []int
• type UI
  • func NewUI(in FileReader, out FileWriter, err io.Writer) UI

Types

type FileReader

type FileReader interface {
	io.Reader
	Fd() uintptr
}

FileReader represents the input of a terminal

type FileWriter

type FileWriter interface {
	io.Writer
	Fd() uintptr
}

FileWriter represents the output of a terminal

type InputOption

type InputOption func(*survey.Input)

InputOption represets a funcion the customizes a survey.Input object

func WithDefault

func WithDefault(d string) InputOption

WithDefault will set a default answer to the question

func WithHelp

func WithHelp(help string) InputOption

WithHelp add help to input question

func WithSuggestion

func WithSuggestion(fn func(toComplete string) []string) InputOption

WithSuggestion applies the suggestion function to the input question

type RGB

type RGB [3]int

func HEX

func HEX(hex string) (RGB, error)

func (RGB) B

func (c RGB) B() int

func (RGB) G

func (c RGB) G() int

func (RGB) R

func (c RGB) R() int

func (RGB) Values

func (c RGB) Values() []int

type UI

type UI interface {
	// SetPageSize changes how many entries are shown on AskFromOptions and
	// AskManyFromOptions at a time
	SetPageSize(p uint) UI
	// AskForText interactively ask for one string from the user
	AskForText(m string, opts ...InputOption) (string, error)
	// AskForValidText for a string interactively from the user and validates
	// it
	AskForValidText(
		m string, validate func(string) error, opts ...InputOption,
	) (string, error)
	// AskForDateTime interactively ask for one date and time from the user
	AskForDateTime(m, d string, ct convertTime) (time.Time, error)
	// AskForDateTimeOrNil interactively ask for one date and time from the
	// user, but allows a empty response
	AskForDateTimeOrNil(m, d string, ct convertTime) (*time.Time, error)
	// AskForInt interactively ask for one int from the user
	AskForInt(m string, d int) (int, error)
	// AskFromOptions interactively ask the user to choose one option or none
	AskFromOptions(m string, o []string, d string) (string, error)
	// AskManyFromOptions interactively ask the user to choose none or many
	// option
	AskManyFromOptions(
		m string, o, d []string, validade func([]string) error,
	) ([]string, error)
	// Confirm interactively ask the user a yes/no question
	Confirm(m string, d bool) (bool, error)
}

UI provides functions to prompt information from a terminal

func NewUI

func NewUI(in FileReader, out FileWriter, err io.Writer) UI

NewUI creates a new UI instance