ui

Documentation

Index

• Constants
• Variables
• type ErrorMsg
  • func NewErrorMsg(err error) *ErrorMsg
• type LineTermination
  • func (p LineTermination) Rune(defaultRune rune) rune
• type LineType
  • func (l LineType) Rune() rune
  • func (l LineType) String() string
• type OutputWidget
  • func NewOutputWidget(title string, ui tui.UI) *OutputWidget
  • func (w *OutputWidget) Scroll(dx, dy int)
  • func (w *OutputWidget) SetBuildStatus(s builder.BuildState)
  • func (w *OutputWidget) SetText(s string)
• type TailBox
  • func NewTailBox(w ...tui.Widget) *TailBox
  • func (t *TailBox) Draw(p *tui.Painter)
  • func (t *TailBox) Resize(size image.Point)
  • func (t *TailBox) SetContents(w ...tui.Widget)
• type Term
  • func NewTerm(ctx context.Context) *Term
  • func (t *Term) Run()

Constants

const (
	HorizontalLine LineType = iota
	VerticalLine
	LineTerminationNormal LineTermination = iota
	LineTerminationHighlight
	LineTerminationNone
)

Variables

var (
	VerticalDivider   *tui.Label
	HorizontalDivider *tui.Label
)

Types

type ErrorMsg

type ErrorMsg struct {
	tui.Widget
	Err error
}

func NewErrorMsg

func NewErrorMsg(err error) *ErrorMsg

type LineTermination

type LineTermination int

func (LineTermination) Rune

func (p LineTermination) Rune(defaultRune rune) rune

type LineType

type LineType int

func (LineType) Rune

func (l LineType) Rune() rune

func (LineType) String

func (l LineType) String() string

type OutputWidget

type OutputWidget struct {
	*tui.Box
	// contains filtered or unexported fields
}

func NewOutputWidget

func NewOutputWidget(title string, ui tui.UI) *OutputWidget

func (*OutputWidget) Scroll

func (w *OutputWidget) Scroll(dx, dy int)

func (*OutputWidget) SetBuildStatus

func (w *OutputWidget) SetBuildStatus(s builder.BuildState)

func (*OutputWidget) SetText

func (w *OutputWidget) SetText(s string)

type TailBox

type TailBox struct {
	tui.WidgetBase
	// contains filtered or unexported fields
}

TailBox is a container Widget that may not show all its Widgets. While tui.Box attempts to show every contained Widget - sometimes shrinking those Widgets to do so- TailBox prioritizes completely displaying its last Widget, then the next-to-last widget, etc. It is vertically-aligned, i.e. all the contained Widgets have the same width.

func NewTailBox

func NewTailBox(w ...tui.Widget) *TailBox

NewTailBox returns a new TailBox widget.

func (*TailBox) Draw

func (t *TailBox) Draw(p *tui.Painter)

Draw renders the TailBox.

func (*TailBox) Resize

func (t *TailBox) Resize(size image.Point)

Resize recalculates the layout of the box's contents.

func (*TailBox) SetContents

func (t *TailBox) SetContents(w ...tui.Widget)

SetContents sets the component widgets of the TailBox.

type Term

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

func NewTerm

func NewTerm(ctx context.Context) *Term

func (*Term) Run

func (t *Term) Run()