ui

Documentation

Index

• Constants
• Variables
• func Confirm(message string, defaultYes bool) bool
• func Error(format string, args ...any)
• func Header(text string)
• func Info(format string, args ...any)
• func PrintCdHint(path string)
• func Success(format string, args ...any)
• func Truncate(s string, max int) string
• func Warn(format string, args ...any)
• type Spinner
  • func NewSpinner(message string) *Spinner
  • func NewSpinnerRich(message string) *Spinner
  • func (s *Spinner) Stop()

Constants

const (
	Current   = "●"
	Pending   = "◐"
	Pass      = "✓"
	Fail      = "✗"
	ArrowDown = "⇣"
	ArrowUp   = "⇡"
	PushUp    = "⬆"
	Dash      = "—"
	NoReview  = "○"
	ErrorMark = "✗"
)

Glyphs used throughout the UI.

Variables

var (
	Green   = color.New(color.FgGreen).SprintFunc()
	Yellow  = color.New(color.FgYellow).SprintFunc()
	Red     = color.New(color.FgRed).SprintFunc()
	Blue    = color.New(color.FgBlue).SprintFunc()
	Cyan    = color.New(color.FgCyan).SprintFunc()
	Magenta = color.New(color.FgMagenta).SprintFunc()
	Dim     = color.New(color.FgHiBlack).SprintFunc()
	Bold    = color.New(color.Bold).SprintFunc()

	GreenF  = color.New(color.FgGreen).PrintfFunc()
	YellowF = color.New(color.FgYellow).PrintfFunc()
	BlueF   = color.New(color.FgBlue).PrintfFunc()
	CyanF   = color.New(color.FgCyan).PrintfFunc()
	DimF    = color.New(color.FgHiBlack).PrintfFunc()
)

Color shortcuts — matches the fish script's set_color calls.

Functions

func Confirm

func Confirm(message string, defaultYes bool) bool

Confirm prompts the user with a y/n question. defaultYes: if true, pressing Enter means yes (Y/n); if false, means no (y/N).

func Error

func Error(format string, args ...any)

Error prints an error message with ✗ prefix.

func Header

func Header(text string)

Header prints a dim section header (like "WORKTREES").

func Info

func Info(format string, args ...any)

Info prints a regular message.

func PrintCdHint

func PrintCdHint(path string)

PrintCdHint tells the shell wrapper to cd into the given path. When WT_CD_FILE is set (by the shell wrapper), writes the path to that file. Otherwise prints a hint so the user knows to cd manually.

func Success

func Success(format string, args ...any)

Success prints a success message with ✓ prefix.

func Truncate

func Truncate(s string, max int) string

Truncate shortens a string to max length, adding "…" if truncated.

func Warn

func Warn(format string, args ...any)

Warn prints a warning message.

Types

type Spinner

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

Spinner shows an animated wave indicator for long-running operations. The animation uses block element characters rendered as a 3-bar equalizer.

func NewSpinner

func NewSpinner(message string) *Spinner

NewSpinner starts an animated spinner with the given message (auto-dimmed). Call Stop() to clear the spinner line and release resources.

func NewSpinnerRich

func NewSpinnerRich(message string) *Spinner

NewSpinnerRich starts a spinner that renders the message as-is, without wrapping it in Dim. Use this when the message contains its own ANSI colors.

func (*Spinner) Stop

func (s *Spinner) Stop()

Stop clears the spinner line and joins the goroutine. Safe to call multiple times.