tui

Documentation

Overview

this is a wrapper on tea.InfoCard since I need my implementation to update

Index

• Variables
• func InitList(tabkind tabId) listModel
• func StartTUI(debug bool) error
• type ContainerSize
• type ContainerSizeManager
• type InfoCardWrapperModel
  • func (m InfoCardWrapperModel) Init() tea.Cmd
  • func (m InfoCardWrapperModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m InfoCardWrapperModel) View() string
• type MainModel
  • func NewModel() MainModel
  • func (m MainModel) Init() tea.Cmd
  • func (m MainModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m MainModel) View() string
• type SpinnerModel
  • func (m SpinnerModel) Init() tea.Cmd
  • func (m SpinnerModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m SpinnerModel) View() string
• type TabOrderingMap
• type TableModel
  • func NewTable(scoutData dockercmd.ScoutData) *TableModel
  • func (m TableModel) Init() tea.Cmd
  • func (m TableModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m TableModel) View() string
• type TickMsg
• type VolumeItem
  • func (i VolumeItem) Description() string
  • func (v VolumeItem) FilterValue() string
  • func (i VolumeItem) Title() string
• type WindowTooSmallModel
  • func MakeNewWindowTooSmallModel() WindowTooSmallModel
  • func (m WindowTooSmallModel) Init() tea.Cmd
  • func (m WindowTooSmallModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m WindowTooSmallModel) View() string

Variables

var (
	IMAGES     tabId
	CONTAINERS tabId
	VOLUMES    tabId
)

var CONFIG_POLLING_TIME time.Duration

var CONFIG_TAB_ORDERING []string

var ContainerKeymap = contKeymap{
	ToggleListAll: key.NewBinding(
		key.WithKeys("a"),
		key.WithHelp("a", "toggle list all"),
	),
	ToggleStartStop: key.NewBinding(
		key.WithKeys("s"),
		key.WithHelp("s", "toggle Start/Stop"),
	),
	TogglePause: key.NewBinding(
		key.WithKeys("t"),
		key.WithHelp("t", "toggle Pause/unPause"),
	),
	Restart: key.NewBinding(
		key.WithKeys("r"),
		key.WithHelp("r", "restart"),
	),
	Delete: key.NewBinding(
		key.WithKeys("d"),
		key.WithHelp("d", "delete"),
	),
	DeleteForce: key.NewBinding(
		key.WithKeys("D"),
		key.WithHelp("D", "delete (force)"),
	),
	Prune: key.NewBinding(
		key.WithKeys("p"),
		key.WithHelp("p", "prune"),
	),
	Exec: key.NewBinding(
		key.WithKeys("x"),
		key.WithHelp("x", "exec"),
	),
	CopyId: key.NewBinding(
		key.WithKeys("c"),
		key.WithHelp("c", "copy ID"),
	),
}

var ImageKeymap = imgKeymap{
	Run: key.NewBinding(
		key.WithKeys("r"),
		key.WithHelp("r", "run"),
	),
	Rename: key.NewBinding(
		key.WithKeys("R"),
		key.WithHelp("r", "rename"),
	),
	Delete: key.NewBinding(
		key.WithKeys("d"),
		key.WithHelp("d", "delete"),
	),
	DeleteForce: key.NewBinding(
		key.WithKeys("D"),
		key.WithHelp("D", "delete (force)"),
	),
	Scout: key.NewBinding(
		key.WithKeys("s"),
		key.WithHelp("s", "scout"),
	),
	Prune: key.NewBinding(
		key.WithKeys("p"),
		key.WithHelp("p", "prune images"),
	),
	CopyId: key.NewBinding(
		key.WithKeys("c"),
		key.WithHelp("c", "copy Image ID"),
	),
	RunAndExec: key.NewBinding(
		key.WithKeys("x"),
		key.WithHelp("x", "run and exec"),
	),
}

var KeymapAvailableWidth int

var NavKeymap = navigationKeymap{
	Enter: key.NewBinding(
		key.WithKeys("enter"),
		key.WithHelp("enter", "select"),
	),
	Back: key.NewBinding(
		key.WithKeys("esc"),
		key.WithHelp("esc", "back"),
	),
	Quit: key.NewBinding(
		key.WithKeys("ctrl+c", "q"),
		key.WithHelp("q", "quit"),
	),
	NextTab: key.NewBinding(
		key.WithKeys("right", "l", "tab"),
		key.WithHelp("->/l/tab", "next"),
	),
	PrevTab: key.NewBinding(
		key.WithKeys("left", "h", "shift+tab"),
		key.WithHelp("<-/h/S-tab", "prev"),
	),
	NextItem: key.NewBinding(
		key.WithKeys("down", "j"),
		key.WithHelp("↓/j", "next item"),
	),
	PrevItem: key.NewBinding(
		key.WithKeys("up", "k"),
		key.WithHelp("↑/h", "prev item"),
	),
	PrevPage: key.NewBinding(
		key.WithKeys("["),
		key.WithHelp("[", "prev page"),
	),
	NextPage: key.NewBinding(
		key.WithKeys("]"),
		key.WithHelp("]", "next page"),
	),
}

var VolumeKeymap = volKeymap{
	Delete: key.NewBinding(
		key.WithKeys("d"),
		key.WithHelp("d", "delete"),
	),
	Prune: key.NewBinding(
		key.WithKeys("p"),
		key.WithHelp("p", "prune"),
	),
	CopyId: key.NewBinding(
		key.WithKeys("c"),
		key.WithHelp("c", "copy Name"),
	),
}

Functions

func InitList

func InitList(tabkind tabId) listModel

func StartTUI

func StartTUI(debug bool) error

Types

type ContainerSize

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

type ContainerSizeManager

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

type InfoCardWrapperModel

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

func (InfoCardWrapperModel) Init

func (m InfoCardWrapperModel) Init() tea.Cmd

func (InfoCardWrapperModel) Update

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

func (InfoCardWrapperModel) View

func (m InfoCardWrapperModel) View() string

View renders the program's UI, which is just a string. The view is rendered after every Update.

type MainModel

type MainModel struct {
	Tabs       []string
	TabContent []listModel
	// contains filtered or unexported fields
}

func NewModel

func NewModel() MainModel

func (MainModel) Init

func (m MainModel) Init() tea.Cmd

func (MainModel) Update

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

func (MainModel) View

func (m MainModel) View() string

type SpinnerModel

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

func (SpinnerModel) Init

func (m SpinnerModel) Init() tea.Cmd

func (SpinnerModel) Update

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

func (SpinnerModel) View

func (m SpinnerModel) View() string

type TabOrderingMap

type TabOrderingMap map[string]tabId

type TableModel

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

func NewTable

func NewTable(scoutData dockercmd.ScoutData) *TableModel

func (TableModel) Init

func (m TableModel) Init() tea.Cmd

func (TableModel) Update

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

func (TableModel) View

func (m TableModel) View() string

type TickMsg

type TickMsg time.Time

type VolumeItem

type VolumeItem struct {
	volume.Volume
}

func (VolumeItem) Description

func (i VolumeItem) Description() string

func (VolumeItem) FilterValue

func (v VolumeItem) FilterValue() string

func (VolumeItem) Title

func (i VolumeItem) Title() string

type WindowTooSmallModel

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

func MakeNewWindowTooSmallModel

func MakeNewWindowTooSmallModel() WindowTooSmallModel

func (WindowTooSmallModel) Init

func (m WindowTooSmallModel) Init() tea.Cmd

func (WindowTooSmallModel) Update

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

func (WindowTooSmallModel) View

func (m WindowTooSmallModel) View() string