ui

Documentation

Overview

Package ui implements dirt's Bubble Tea UI.

Index

• func ApplyTheme(name string)
• func SetMigrationProgram(p *tea.Program)
• func SetProgram(p *tea.Program)
• type Job
  • func (j *Job) Elapsed() time.Duration
  • func (j *Job) Running() bool
• type Model
  • func New(c *lv.Client) Model
  • func (m Model) Init() tea.Cmd
  • func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Model) View() string
  • func (m Model) WithConfig(cfg config.Config) Model
  • func (m Model) WithRefreshInterval(d time.Duration) Model

Functions

func ApplyTheme

func ApplyTheme(name string)

ApplyTheme sets the global colour variables and rebuilds styles from the named theme. Unknown names fall back to "default".

func SetMigrationProgram

func SetMigrationProgram(p *tea.Program)

SetMigrationProgram is retained for backwards compat; prefer SetProgram.

func SetProgram

func SetProgram(p *tea.Program)

SetProgram records the tea.Program used by background job goroutines to send progress and completion messages.

Types

type Job

type Job struct {
	ID         string  // unique, e.g. "migrate-vm1-1702000000"
	Kind       string  // "migrate" / "snap-create" / "snap-delete"
	Target     string  // primary subject — VM name
	Detail     string  // "→ otherhost" / "@ snap-name"
	Phase      string  // "transferring memory" / "finalising"
	Progress   float64 // 0.0–1.0, or -1 for unbounded
	DataDone   uint64  // bytes transferred so far
	DataTotal  uint64  // total bytes (0 = unknown)
	StartedAt  time.Time
	FinishedAt time.Time // zero until done
	Err        error
	Cancel     func() // may be nil for non-cancellable jobs
}

Job is a long-running background operation surfaced in the status bar and the :jobs view. Kind / Target are user-facing labels; Cancel is called when the master aborts the job.

func (*Job) Elapsed

func (j *Job) Elapsed() time.Duration

Elapsed returns how long the job has been running, or its total duration if it has finished.

func (*Job) Running

func (j *Job) Running() bool

Running reports whether the job is still active.

type Model

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

Model is the root Bubble Tea model.

func New

func New(c *lv.Client) Model

New constructs a fresh Model bound to the given libvirt client.

func (Model) Init

func (m Model) Init() tea.Cmd

func (Model) Update

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

func (Model) View

func (m Model) View() string

View is the root render — composes header, list, and status bar, or shows the detail / help / splash overlays as appropriate.

func (Model) WithConfig

func (m Model) WithConfig(cfg config.Config) Model

WithConfig applies user-level config.yaml preferences to the model: default sort column + direction and column visibility. Refresh interval is applied separately via WithRefreshInterval so the CLI --refresh flag can override the config without a second lookup.

func (Model) WithRefreshInterval

func (m Model) WithRefreshInterval(d time.Duration) Model

WithRefreshInterval returns a copy of the model with the snapshot tick rate set to d. Values below 200ms are clamped to 200ms to protect libvirt.