ui

Documentation

Index

• type Field
• type Form
  • func (f Form) Run(r io.Reader, w io.Writer) (map[string]interface{}, error)
• type ProgressBar
  • func (b ProgressBar) String() string
• type StringField
  • func (f StringField) Clean(s string) (interface{}, error)
  • func (f StringField) GetKey() string
  • func (f StringField) GetLabel() string
  • func (f StringField) GetLabelExtra() string

Types

type Field

type Field interface {
	GetKey() string        // Key for the data map.
	GetLabel() string      // Label to print as the prompt.
	GetLabelExtra() string // Extra info for the label, eg. defaults.

	// Sanitize user input and return the field's native type.
	Clean(s string) (interface{}, error)
}

A Field in a form.

type Form

type Form struct {
	Banner string
	Fields []Field
}

A Form used to handle user interactions.

func (Form) Run

func (f Form) Run(r io.Reader, w io.Writer) (map[string]interface{}, error)

Runs the form against the specified input and output.

type ProgressBar

type ProgressBar struct {
	Width    int
	Progress float64
}

func (ProgressBar) String

func (b ProgressBar) String() string

type StringField

type StringField struct {
	Key     string
	Label   string
	Default string

	// Length constraints.
	Min, Max int
}

func (StringField) Clean

func (f StringField) Clean(s string) (interface{}, error)

func (StringField) GetKey

func (f StringField) GetKey() string

func (StringField) GetLabel

func (f StringField) GetLabel() string

func (StringField) GetLabelExtra

func (f StringField) GetLabelExtra() string