termui

type GaugeColumn ¶

type GaugeColumn struct {
	termui.Gauge
}

GaugeColumn is a termui.Gauge to be used as a Grid column. It is borderless, has a height of 1 and its label is left-aligned.

func NewGaugeColumn() *GaugeColumn

func NewThemedGaugeColumn(theme *ui.ColorTheme) *GaugeColumn

func (w *GaugeColumn) Reset()

type KeyValuePar ¶

type KeyValuePar struct {
	X, Y   int
	Width  int
	Height int
	// contains filtered or unexported fields
}

KeyValuePar is a widget for key value pairs

func NewKeyValuePar(key, value string, theme *ui.ColorTheme) *KeyValuePar

func (kv *KeyValuePar) Buffer() gtermui.Buffer

func (kv *KeyValuePar) GetHeight() int

func (kv *KeyValuePar) SetWidth(width int)

func (kv *KeyValuePar) SetX(x int)

func (kv *KeyValuePar) SetY(y int)

type MarkupPar ¶

type MarkupPar struct {
	gizaktermui.Paragraph
	// contains filtered or unexported fields
}

MarkupPar is a paragraph with marked-up text

func NewParFromMarkupText(theme *ui.ColorTheme, str string) *MarkupPar

func (p *MarkupPar) Buffer() gizaktermui.Buffer

func (p *MarkupPar) Content(str string)

type ParColumn ¶

type ParColumn struct {
	termui.Paragraph
}

ParColumn is a termui.Par that can be used in a grid to show text

func NewParColumn(s string) *ParColumn

func NewThemedParColumn(theme *ui.ColorTheme, s string) *ParColumn

func (w *ParColumn) Content(s string)

func (w *ParColumn) Reset()

func (w *ParColumn) SetWidth(width int)

type Row ¶

type Row struct {
	X, Y    int
	Width   int
	Height  int
	Columns []gtermui.GridBufferer
	Table   Table
}

Row is a widget for table rows

func (row *Row) AddColumn(c gtermui.GridBufferer)

func (row *Row) Buffer() gtermui.Buffer

func (row *Row) GetHeight() int

func (row *Row) SetWidth(width int)

func (row *Row) SetX(x int)

func (row *Row) SetY(y int)

type SizableBufferer ¶

type SizableBufferer interface {
	gizak.Bufferer
	GetHeight() int
	SetWidth(int)
	SetX(int)
	SetY(int)
}

SizableBufferer is a termui.Bufferer with dimensions and position

type Table ¶

type Table interface {
	ColumnWidths() []int
}

Table defines common behaviour for table widgets

type TableHeader ¶

type TableHeader struct {
	X, Y          int
	Height, Width int
	Columns       []*termui.Paragraph
	ColumnSpacing int

	Theme *ui.ColorTheme
	// contains filtered or unexported fields
}

TableHeader is a table header widget

func NewHeader(Theme *ui.ColorTheme) *TableHeader

func (th *TableHeader) AddColumn(s string)

func (th *TableHeader) AddFixedWidthColumn(s string, width int)

func (th *TableHeader) Buffer() termui.Buffer

func (th *TableHeader) ColumnCount() int

func (th *TableHeader) ColumnWidths() []int

func (th *TableHeader) GetHeight() int

func (th *TableHeader) SetWidth(w int)

func (th *TableHeader) SetX(x int)

func (th *TableHeader) SetY(y int)

type TextInput ¶

type TextInput struct {
	termui.Block

	TextFgColor termui.Attribute
	TextBgColor termui.Attribute
	TextBuilder termui.TextBuilder

	sync.RWMutex
	// contains filtered or unexported fields
}

TextInput is a widget to capture user input

func NewTextInput(c cursor, s string) *TextInput

func (i *TextInput) Buffer() termui.Buffer

func (i *TextInput) OnFocus(event ui.EventSource) error

func (i *TextInput) Text() (string, bool)

type Widget ¶

type Widget interface {
	Buffer() gizaktermui.Buffer
	Mount() error
	Name() string
	Unmount() error
}

Widget defines how a UI widget responds to its lifecycle events:

• Buffer returns the content of the widget as termui.Buffer, it will be invoked every time the widget is render.
• Mount will be invoked before the Buffer method, it can be used to prepare the widget for rendering.
• Unmount will be invoked to signal that the widget is not going to be used anymore, it can be used for cleaning up.

Widget are identified by its name.