uiutil

Documentation

Index

• Variables
• type Component
• type ListTable
  • func NewListTable() *ListTable
  • func (t *ListTable) AddHeader(header ...string) *ListTable
  • func (t *ListTable) AddRow(row ...interface{}) *ListTable
  • func (t *ListTable) UITable() *uitable.Table
• type Printer
  • func NewPrinter(out io.Writer) Printer
• type Title
  • func NewTitle(text string) *Title
  • func (t *Title) Bytes() []byte
  • func (t *Title) String() string
  • func (t *Title) WithUnderliner(u string) *Title

Variables

var Out = os.Stdout

Out is the default out

var TitleUnderliner = "="

TitleUnderliner is the underline character for the title

Types

type Component

type Component interface {
	Bytes() []byte
}

Component in the interface that UI components need to implement

type ListTable

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

func NewListTable

func NewListTable() *ListTable

func (*ListTable) AddHeader

func (t *ListTable) AddHeader(header ...string) *ListTable

func (*ListTable) AddRow

func (t *ListTable) AddRow(row ...interface{}) *ListTable

func (*ListTable) UITable

func (t *ListTable) UITable() *uitable.Table

type Printer

type Printer interface {
	Component
	AddTitle(string) Printer
	Add(Component) Printer
	Flush() error
}

func NewPrinter

func NewPrinter(out io.Writer) Printer

NewPrinter returns a pointer to a new printer object

type Title

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

Title is a UI component that renders a title. Title implements Component interface.

func NewTitle

func NewTitle(text string) *Title

func (*Title) Bytes

func (t *Title) Bytes() []byte

String returns the formated string of the title

func (*Title) String

func (t *Title) String() string

func (*Title) WithUnderliner

func (t *Title) WithUnderliner(u string) *Title