ui

Documentation

Index

• func Hint(str string, noPadding bool, label *string)
• func Init(preferences *prefs.Preferences)
• func Line(format string, a ...interface{})
• func LineIndent(indent int, format string, a ...interface{})
• func Progress(str string)
• type UI
  • func Child(indent int) *UI
  • func (u *UI) Child(indent int) *UI
  • func (u *UI) Hint(str string, noPadding bool, label *string)
  • func (u *UI) Line(format string, a ...interface{})
  • func (u *UI) LineIndent(indent int, format string, a ...interface{})
  • func (u *UI) Progress(str string)
  • func (u *UI) Write(p []byte) (n int, err error)

Functions

func Hint

func Hint(str string, noPadding bool, label *string)

Hint calls hint on the default UI

func Init

func Init(preferences *prefs.Preferences)

Init initializes a default global UI, accessible via the package functions.

func Line

func Line(format string, a ...interface{})

Line calls Line on the default UI

func LineIndent

func LineIndent(indent int, format string, a ...interface{})

LineIndent calls LineIndent on the default UI

func Progress

func Progress(str string)

Progress calls Progress on the default UI

Types

type UI

type UI struct {
	Indent int

	// Cols holds the column width for text wrapping. For the default UI and
	// its children, It is either the width of the  terminal, or defaultCols,
	// minus rightPad.
	Cols int

	// EnableProgress is whether progress events should be displayed
	EnableProgress bool

	// EnableHints is whether hints should be displayed
	EnableHints bool
}

UI exposes methods for creating a terminal ui

func Child

func Child(indent int) *UI

Child calls Child on the default UI

func (*UI) Child

func (u *UI) Child(indent int) *UI

Child returns a new UI, with settings from the receiver UI, and Indent increased by the provided value.

func (*UI) Hint

func (u *UI) Hint(str string, noPadding bool, label *string)

Hint handles the ui output for hint/onboarding messages, when enabled

func (*UI) Line

func (u *UI) Line(format string, a ...interface{})

Line writes a formatted string followed by a newline to stdout. Output is word wrapped, and terminated by a newline.

func (*UI) LineIndent

func (u *UI) LineIndent(indent int, format string, a ...interface{})

LineIndent writes a formatted string followed by a newline to stdout. Output is word wrapped, and terminated by a newline. All lines after the first are indented by indent number of spaces (in addition to the indenting enforced by this UI instance.

func (*UI) Progress

func (u *UI) Progress(str string)

Progress handles the ui output for progress events, when enabled

func (*UI) Write

func (u *UI) Write(p []byte) (n int, err error)

Write implements the io.Writer interface The provided bytes are split on newlines, and written with the UI's configured indent.