tuigo

README

tuigo

a terminal UI framework written in Go using the bubbletea library.

see example/ for an example usage of tuigo. the scheme below shows roughly the structure of the API.

%%{
  init: {
    'theme': 'base', 
    'themeVariables': { 
        'fontFamily': 'monospace',
        'primaryColor': '#4C2FAD',
        'primaryTextColor': '#FFFFFF',
        'lineColor': '#E840E0',
        'primaryBorderColor': '#E840E0'
      }
    }
}%%

classDiagram
class tuigo["tuigo"]
class tui_utils["tuigo/utils"]
class tui_field["tuigo"]
class tui_component["tuigo"]

tuigo <-- tui_utils : initial state
tuigo <-- tui_field : mapping from states to fields
tuigo : NewApp(utils.State, map[utils.State]Field, bool) App
tuigo : App

tui_utils : Label() string
tui_utils : Next() utils.State
tui_utils : Prev() utils.State
tui_utils : utils.State

tui_field : NewField(string, bool, bool) Field
tui_field : Field

tui_component : Field.AddElement(&component) Field
tui_component : NewButton(string, utils.ButtonType, tea.Msg) button.Model
tui_component : NewSelector([]string, bool) selector.Model
tui_component : NewRadio(string) radio.Model
tui_component : NewInput(string, string, string, utils.InputType) button.Model

tui_field <-- tui_component : populate the field with interactive components

TODO

• customizable theme
• more components
• grid structure
• key help menu
• field validator
• unit tests

Documentation

Index

• func NewButton(label string, btnType utils.ButtonType, msg tea.Msg) button.Model
• func NewInput(label, def, placeholder string, inputtype utils.InputType) input.Model
• func NewRadio(label string) radio.Model
• func NewSelector(options []string, multiselect bool) selector.Model
• type Actor
• type App
  • func NewApp(state utils.State, fields map[utils.State]Field, enable_debug bool) App
  • func (m App) AddField(st utils.State, f Field) App
  • func (m App) Init() tea.Cmd
  • func (m App) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m App) View() string
• type Field
  • func NewField(label string, isFirstField bool, isLastField bool) Field
  • func (f Field) AddElement(element component.Viewer) Field
  • func (f *Field) FocusFirst()
  • func (f *Field) FocusLast()
  • func (f *Field) FocusNext()
  • func (f *Field) FocusPrev()
  • func (f Field) GetControls() []component.Viewer
  • func (f Field) GetFocusers() []component.Focuser
  • func (f Field) GetViewersWithoutControls() []component.Viewer
  • func (f Field) Init() tea.Cmd
  • func (f Field) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (f Field) View() string
• type Messenger
• type State

Functions

func NewButton

func NewButton(label string, btnType utils.ButtonType, msg tea.Msg) button.Model

func NewInput

func NewInput(label, def, placeholder string, inputtype utils.InputType) input.Model

func NewRadio

func NewRadio(label string) radio.Model

func NewSelector

func NewSelector(options []string, multiselect bool) selector.Model

Types

type Actor

type Actor interface {
	Action() tea.Msg
}

type App

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

func NewApp

func NewApp(state utils.State, fields map[utils.State]Field, enable_debug bool) App

func (App) AddField

func (m App) AddField(st utils.State, f Field) App

func (App) Init

func (m App) Init() tea.Cmd

func (App) Update

func (m App) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (App) View

func (m App) View() string

type Field

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

func NewField

func NewField(label string, isFirstField bool, isLastField bool) Field

func (Field) AddElement

func (f Field) AddElement(element component.Viewer) Field

func (*Field) FocusFirst

func (f *Field) FocusFirst()

func (*Field) FocusLast

func (f *Field) FocusLast()

func (*Field) FocusNext

func (f *Field) FocusNext()

func (*Field) FocusPrev

func (f *Field) FocusPrev()

func (Field) GetControls

func (f Field) GetControls() []component.Viewer

func (Field) GetFocusers

func (f Field) GetFocusers() []component.Focuser

func (Field) GetViewersWithoutControls

func (f Field) GetViewersWithoutControls() []component.Viewer

func (Field) Init

func (f Field) Init() tea.Cmd

func (Field) Update

func (f Field) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (Field) View

func (f Field) View() string

type Messenger

type Messenger interface {
	Message() string
}

type State

type State interface {
	Label() string
	Next() State
	Prev() State
}