ui

Documentation

Index

• Constants
• func Close()
• func Init() error
• type Form
  • func NewForm() *Form
  • func (f *Form) HandleEvent(e ui.Event)
  • func (f *Form) Render()
  • func (f *Form) Resize()
  • func (f *Form) SetInfos(s string)
  • func (f *Form) SetNodes(n []*widgets.FormNode)
  • func (f *Form) SetTitle(title string)
• type Header
  • func NewHeader() *Header
  • func (h *Header) HandleEvent(e ui.Event)
  • func (h *Header) Render()
  • func (h *Header) Resize()
• type Item
• type ItemType
• type Menu
  • func NewMenu() *Menu
  • func (m *Menu) AddOption(o MenuOption)
  • func (m *Menu) AddOptions(os []MenuOption)
  • func (m *Menu) HandleEvent(e ui.Event)
  • func (m *Menu) Render()
  • func (m *Menu) Resize()
• type MenuOption
• type Modale
  • func NewModale(s string, t ModaleType) *Modale
  • func (m *Modale) HandleEvent(e ui.Event)
  • func (m *Modale) Render()
  • func (m *Modale) Resize()
• type ModaleOption
• type ModaleType
• type Screen
  • func NewScreen() *Screen
  • func (s *Screen) HandleEvents()
  • func (s *Screen) Render()
  • func (s *Screen) RenderModale(msg string, t ModaleType)
  • func (s *Screen) Resize()
  • func (s *Screen) Restore()
  • func (s *Screen) Run()
  • func (s *Screen) SetForm(f *Form)
  • func (s *Screen) SetMenu(m *Menu)
  • func (s *Screen) SetModale(m *Modale)
  • func (s *Screen) Stop()
• type Status

Constants

const (
	Running = iota
	Stopped
)

Functions

func Close

func Close()

func Init

func Init() error

Types

type Form

type Form struct {
	Content *widgets.Form
	Infos   *widgets.Paragraph
}

func NewForm

func NewForm() *Form

func (*Form) HandleEvent

func (f *Form) HandleEvent(e ui.Event)

HandleEvent implements Item interface

func (*Form) Render

func (f *Form) Render()

Render implements Item interface

func (*Form) Resize

func (f *Form) Resize()

Resize implements Item interface

func (*Form) SetInfos

func (f *Form) SetInfos(s string)

func (*Form) SetNodes

func (f *Form) SetNodes(n []*widgets.FormNode)

func (*Form) SetTitle

func (f *Form) SetTitle(title string)

type Header

type Header struct {
	Logo *widgets.Paragraph
	Help *widgets.Paragraph
}

func NewHeader

func NewHeader() *Header

func (*Header) HandleEvent

func (h *Header) HandleEvent(e ui.Event)

HandleEvent implements Item interface

func (*Header) Render

func (h *Header) Render()

Render implements Item interface

func (*Header) Resize

func (h *Header) Resize()

Resize implements Item interface

type Item

type Item interface {
	HandleEvent(e ui.Event)
	Render()
	Resize()
}

type ItemType

type ItemType int

const (
	HeaderItem ItemType = iota
	CenteredItem
	ModaleItem
)

type Menu

type Menu struct {
	Options     *widgets.List
	Description *widgets.Paragraph
	// contains filtered or unexported fields
}

func NewMenu

func NewMenu() *Menu

func (*Menu) AddOption

func (m *Menu) AddOption(o MenuOption)

func (*Menu) AddOptions

func (m *Menu) AddOptions(os []MenuOption)

func (*Menu) HandleEvent

func (m *Menu) HandleEvent(e ui.Event)

HandleEvent implements Item interface

func (*Menu) Render

func (m *Menu) Render()

Render implements Item interface

func (*Menu) Resize

func (m *Menu) Resize()

Resize implements Item interface

type MenuOption

type MenuOption struct {
	Name        string
	Description string
	Handler     func(...string)
}

type Modale

type Modale struct {
	Text *widgets.Paragraph
	Type ModaleType
}

func NewModale

func NewModale(s string, t ModaleType) *Modale

func (*Modale) HandleEvent

func (m *Modale) HandleEvent(e ui.Event)

HandleEvent implements Item interface

func (*Modale) Render

func (m *Modale) Render()

Render implements Item interface

func (*Modale) Resize

func (m *Modale) Resize()

Resize implements Item interface

type ModaleOption

type ModaleOption struct {
	Name        string
	Description string
	Handler     func(...string)
}

type ModaleType

type ModaleType int

const (
	ModaleTypeInfo ModaleType = iota
	ModaleTypeErr
	ModaleTypeWrn
)

type Screen

type Screen struct {
	Headers *Header

	Items       []Item
	FocusedItem Item
	// contains filtered or unexported fields
}

func NewScreen

func NewScreen() *Screen

func (*Screen) HandleEvents

func (s *Screen) HandleEvents()

func (*Screen) Render

func (s *Screen) Render()

func (*Screen) RenderModale

func (s *Screen) RenderModale(msg string, t ModaleType)

func (*Screen) Resize

func (s *Screen) Resize()

func (*Screen) Restore

func (s *Screen) Restore()

func (*Screen) Run

func (s *Screen) Run()

func (*Screen) SetForm

func (s *Screen) SetForm(f *Form)

func (*Screen) SetMenu

func (s *Screen) SetMenu(m *Menu)

func (*Screen) SetModale

func (s *Screen) SetModale(m *Modale)

func (*Screen) Stop

func (s *Screen) Stop()

type Status

type Status int