ui

package
v0.7.169 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 4, 2026 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	IconOK   = "✓"
	IconWarn = "⚠"
	IconFail = "✗"
)

Status icons. Keep these in one place so prompts, results, and plain-text fallbacks all use the same glyph.

Variables

View Source 
var (

	// SuccessStyle is for completed actions and passing status glyphs.
	SuccessStyle = lipgloss.NewStyle().Foreground(lipgloss.Color("2"))
	// WarningStyle is for warnings and cautionary prompts.
	WarningStyle = lipgloss.NewStyle().Foreground(lipgloss.Color("3"))
	// ErrorStyle is for failures and error glyphs.
	ErrorStyle = lipgloss.NewStyle().Foreground(lipgloss.Color("1"))
	// TitleStyle is for prompt headings and emphasized labels.
	TitleStyle = lipgloss.NewStyle().Bold(true)
	// HelperStyle is for de-emphasized hint text and secondary labels.
	HelperStyle = lipgloss.NewStyle().Foreground(_ld(lipgloss.Color("252"), lipgloss.Color("250")))
	// NoColorStyle is the fallback when color output is disabled.
	NoColorStyle = lipgloss.NewStyle().Foreground(lipgloss.NoColor{})
)
View Source 
var ErrCancelled = errors.New("cancelled")

ErrCancelled is returned when the user cancels input (Ctrl+C or Esc).

View Source 
var ErrNoTTY = errors.New("no interactive terminal available")

ErrNoTTY is returned when a TUI prompt is called without an interactive terminal.

Functions

func Bold 

func Bold(text string) string

func CommandList 

func CommandList(cmds []CommandEntry) string

CommandList formats commands in aligned columns.

func Confirm added in v0.7.169 

func Confirm(label string, defaultYes bool) (bool, error)

Confirm presents a y/n prompt and returns the boolean result. Returns ErrCancelled if the user presses Ctrl+C or Esc. Returns ErrNoTTY if stdin is not a terminal.

func Cyan 

func Cyan(text string) string

func Dim 

func Dim(text string) string

func ErrBold added in v0.7.51 

func ErrBold(text string) string

func ErrDim added in v0.7.51 

func ErrDim(text string) string

func ErrError added in v0.7.136 

func ErrError(msg string) string

ErrError formats a failure message using stderr color detection.

func ErrGreen added in v0.7.51 

func ErrGreen(text string) string

func ErrRed added in v0.7.136 

func ErrRed(text string) string

func ErrSuccess added in v0.7.51 

func ErrSuccess(msg string) string

ErrSuccess formats a success message using stderr color detection.

func ErrWarning added in v0.7.51 

func ErrWarning(msg string) string

ErrWarning formats a warning message using stderr color detection.

func ErrYellow added in v0.7.51 

func ErrYellow(text string) string

func FormatDuration added in v0.7.136 

func FormatDuration(d time.Duration) string

FormatDuration formats a duration for display in status messages.

func FormatError 

func FormatError(brief string, detail string, suggestion string) string

FormatError formats a red error with optional detail and suggestion.

func Gray 

func Gray(text string) string

func Green 

func Green(text string) string

func Label 

func Label(text string, width int) string

Label pads and bolds a label for aligned key-value output.

func PromptHidden added in v0.7.169 

func PromptHidden(label string) (string, error)

PromptHidden prompts the user for hidden input (e.g. API keys). Returns ErrCancelled if the user presses Ctrl+C or Esc. Returns ErrNoTTY if stdin is not a terminal.

func PromptText added in v0.7.169 

func PromptText(label, defaultVal string) (string, error)

PromptText prompts for text input with an optional default value shown as placeholder. If the user enters nothing and presses Enter, the default value is returned. Returns ErrCancelled if the user presses Ctrl+C or Esc. Returns ErrNoTTY if stdin is not a terminal or CI is set.

func Red 

func Red(text string) string

func RequireStdoutTTY added in v0.7.169 

func RequireStdoutTTY() error

RequireStdoutTTY returns ErrNoTTY if stdout is not an interactive terminal. Use this for full-screen TUI programs that write to stdout.

func SelectFromList added in v0.7.169 

func SelectFromList(label string, items []string) (int, error)

SelectFromList presents a list of items and returns the selected index. Returns ErrCancelled if the user presses Ctrl+C or Esc. Returns ErrNoTTY if stdin is not a terminal.

func SetColorEnabled 

func SetColorEnabled(enabled bool)

SetColorEnabled overrides automatic color detection for both stdout and stderr.

func Step 

func Step(current, total int, title string) string

Step formats a numbered pipeline step header: "Step 1/3 Title".

func Success 

func Success(msg string) string

Success formats a green checkmark success message.

func Warning 

func Warning(msg string) string

Warning formats a yellow warning message.

func Yellow 

func Yellow(text string) string

Types

type CommandEntry 

type CommandEntry struct {
	Name        string
	Run         string
	Description string
}

CommandEntry describes a command for list formatting.

type Spinner 

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

Spinner shows a braille dot animation on stderr during long operations. No-op when stderr is not a TTY.

func NewSpinner 

func NewSpinner() *Spinner

NewSpinner creates a spinner that writes to stderr.

func (*Spinner) Log 

func (s *Spinner) Log(message string)

Log prints a message on its own line while keeping the spinner running.

func (*Spinner) Start 

func (s *Spinner) Start(message string)

func (*Spinner) Stop 

func (s *Spinner) Stop()

func (*Spinner) StopWithMessage 

func (s *Spinner) StopWithMessage(message string)

func (*Spinner) Update 

func (s *Spinner) Update(message string)

Source Files

View all Source files

Directories

Path Synopsis
Package watch implements the chunk watch TUI dashboard.
 Package watch implements the chunk watch TUI dashboard.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.