ui

package
v0.11.0 Latest Latest
Warning

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

Go to latest
Published: Mar 10, 2025 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Info        = pterm.Info
	Warning     = pterm.Warning
	Success     = pterm.Success
	Error       = pterm.Error
	Fatal       = pterm.Fatal
	Debug       = pterm.Debug
	Description = pterm.Description

	// InfoI returns a PrefixPrinter, which can be used to print text with an "info" Prefix.
	InfoI = pterm.PrefixPrinter{
		MessageStyle: &pterm.ThemeDefault.InfoMessageStyle,
		Prefix: pterm.Prefix{
			Style: &pterm.ThemeDefault.InfoMessageStyle,
			Text:  "🦶",
		},
	}

	// WarningI returns a PrefixPrinter, which can be used to print text with a "warning" Prefix.
	WarningI = pterm.PrefixPrinter{
		MessageStyle: &pterm.ThemeDefault.WarningMessageStyle,
		Prefix: pterm.Prefix{
			Style: &pterm.ThemeDefault.WarningMessageStyle,
			Text:  "⚠️",
		},
	}

	// SuccessI returns a PrefixPrinter, which can be used to print text with a "success" Prefix.
	SuccessI = pterm.PrefixPrinter{
		MessageStyle: &pterm.ThemeDefault.SuccessMessageStyle,
		Prefix: pterm.Prefix{
			Style: &pterm.ThemeDefault.SuccessMessageStyle,
			Text:  "✓",
		},
	}

	// ErrorI returns a PrefixPrinter, which can be used to print text with an "error" Prefix.
	ErrorI = pterm.PrefixPrinter{
		MessageStyle: &pterm.ThemeDefault.ErrorMessageStyle,
		Prefix: pterm.Prefix{
			Style: &pterm.ThemeDefault.ErrorMessageStyle,
			Text:  "✗",
		},
	}

	// Fatal returns a PrefixPrinter, which can be used to print text with an "fatal" Prefix.
	// NOTICE: Fatal terminates the application immediately!
	FatalI = pterm.PrefixPrinter{
		MessageStyle: &pterm.ThemeDefault.FatalMessageStyle,
		Prefix: pterm.Prefix{
			Style: &pterm.ThemeDefault.FatalMessageStyle,
			Text:  "💀",
		},
		Fatal: true,
	}

	// Debug Prints debug messages. By default, it will only print if PrintDebugMessages is true.
	// You can change PrintDebugMessages with EnableDebugMessages and DisableDebugMessages, or by setting the variable itself.
	DebugI = pterm.PrefixPrinter{
		MessageStyle: &pterm.ThemeDefault.DebugMessageStyle,
		Prefix: pterm.Prefix{
			Style: &pterm.ThemeDefault.DebugMessageStyle,
			Text:  "🪲",
		},
		Debugger: true,
	}

	// Check returns a PrefixPrinter, which can be used to print text with a "mark check" Prefix.
	CheckI = pterm.PrefixPrinter{
		MessageStyle: &pterm.ThemeDefault.SuccessMessageStyle,
		Prefix: pterm.Prefix{
			Style: &pterm.ThemeDefault.SuccessMessageStyle,
			Text:  "✓",
		},
	}
)
View Source
var DefaultSpinner = pterm.SpinnerPrinter{
	Sequence:            []string{" ⣾ ", " ⣽ ", " ⣻ ", " ⢿ ", " ⡿ ", " ⣟ ", " ⣯ ", " ⣷ "},
	Style:               &pterm.ThemeDefault.SpinnerStyle,
	Delay:               time.Millisecond * 100,
	ShowTimer:           false,
	TimerRoundingFactor: time.Second,
	TimerStyle:          &pterm.ThemeDefault.TimerStyle,
	MessageStyle:        &pterm.ThemeDefault.InfoMessageStyle,
	SuccessPrinter:      &SuccessI,
	FailPrinter:         &ErrorI,
	WarningPrinter:      &WarningI,
	InfoPrinter:         &InfoI,
}
View Source
var Logger *pterm.Logger

Functions

func Confirm

func Confirm(text string) bool

Confirm asks the user for confirmation

func DisableColor

func DisableColor()

DisableColor disables color output

func EnableColor

func EnableColor()

EnableColor enables color output

func IsColorEnabled added in v0.8.9

func IsColorEnabled() bool

func NewHandler

func NewHandler(w io.Writer, format string, level string) *pterm.SlogHandler

func NewTable

func NewTable(w io.Writer, headers []string) *pterm.TablePrinter

NewTable creates a new table with the given headers

func ParseLevel

func ParseLevel(level string) pterm.LogLevel

func Prompt

func Prompt(header, defaultValue string) (string, error)

Prompt displays a prompt to the user and returns the user's input

func Select

func Select(header string, options []string) (string, error)

Select displays a select prompt with the given header and options

func SetDefaultOutput

func SetDefaultOutput(w io.Writer)

SetOutput sets the default output writer for the UI

func Spin

func Spin(spinner *pterm.SpinnerPrinter, text string, fun func(Spinner) error) error

Spin runs a spinner with the given text and function. If the terminal is not a TTY, the spinner is not shown.

func UpdateSpinnerText

func UpdateSpinnerText(s Spinner, text string)

Hack - clear line when updating text - https://github.com/pterm/pterm/pull/656/files

Types

type Spinner

type Spinner = *pterm.SpinnerPrinter

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
JackTT - Gopher 🇻🇳