ux

Documentation

Index

• Variables
• func ActionLipGloss(title string, value string)
• func BulletListLipGloss(title string, items []string)
• func Ferror(w io.Writer, format string, a ...any)
• func Fwarning(w io.Writer, format string, a ...any)
• func InfoLipGloss(title string, value string)
• func OutputLipgloss()
• func Progress() *pterm.ProgressbarPrinter
• func Spinner() *pterm.SpinnerPrinter
• func Table() *pterm.TablePrinter
• func ThreeColumnList(col1Title string, col1Items []string, col2Title string, col2Items []string, ...)
• func WarningLipGloss(title string, value string)

Variables

var (
	// Info returns a PrefixPrinter, which can be used to print text with an "info" Prefix.
	Info = pterm.PrefixPrinter{
		MessageStyle: infoMessageStyle,
		Prefix:       infoPrefix,
	}

	// Warning returns a PrefixPrinter, which can be used to print text with a "warning" Prefix.
	Warning = pterm.PrefixPrinter{
		MessageStyle: warningMessageStyle,
		Prefix:       warningPrefix,
	}

	// Success returns a PrefixPrinter, which can be used to print text with a "success" Prefix.
	Success = pterm.PrefixPrinter{
		MessageStyle: successMessageStyle,
		Prefix:       successPrefix,
	}

	// Error returns a PrefixPrinter, which can be used to print text with an "error" Prefix.
	Error = pterm.PrefixPrinter{
		MessageStyle: errorMessageStyle,
		Prefix:       errorPrefix,
	}

	// Fatal returns a PrefixPrinter, which can be used to print text with an "fatal" Prefix.
	// NOTICE: Fatal terminates the application immediately!
	Fatal = pterm.PrefixPrinter{
		MessageStyle: fatalMessageStyle,
		Prefix:       fatalPrefix,
		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.
	Debug = pterm.PrefixPrinter{
		MessageStyle: debugMessageStyle,
		Prefix:       debugPrefix,
		Debugger:     true,
	}

	// Description returns a PrefixPrinter, which can be used to print text with a "description" Prefix.
	Description = pterm.PrefixPrinter{
		MessageStyle: descriptionMessageStyle,
		Prefix:       descriptionPrefix,
	}
)

Functions

func ActionLipGloss

func ActionLipGloss(title string, value string)

func BulletListLipGloss

func BulletListLipGloss(title string, items []string)

func Ferror

func Ferror(w io.Writer, format string, a ...any)

func Fwarning

func Fwarning(w io.Writer, format string, a ...any)

func InfoLipGloss

func InfoLipGloss(title string, value string)

func OutputLipgloss

func OutputLipgloss()

func Progress

func Progress() *pterm.ProgressbarPrinter

func Spinner

func Spinner() *pterm.SpinnerPrinter

func Table

func Table() *pterm.TablePrinter

func ThreeColumnList

func ThreeColumnList(col1Title string,
	col1Items []string,
	col2Title string,
	col2Items []string,
	col3Title string,
	col3Items []string)

func WarningLipGloss

func WarningLipGloss(title string, value string)