Documentation
¶
Index ¶
- Variables
- func Confirm(text string) bool
- func DisableColor()
- func EnableColor()
- func IsColorEnabled() bool
- func NewHandler(w io.Writer, format string, level string) *pterm.SlogHandler
- func NewTable(w io.Writer, headers []string) *pterm.TablePrinter
- func ParseLevel(level string) pterm.LogLevel
- func Prompt(header, defaultValue string) (string, error)
- func Select(header string, options []string) (string, error)
- func SetDefaultOutput(w io.Writer)
- func Spin(spinner *pterm.SpinnerPrinter, text string, fun func(Spinner) error) error
- func UpdateSpinnerText(s Spinner, text string)
- type Spinner
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 IsColorEnabled ¶ added in v0.8.9
func IsColorEnabled() bool
func NewHandler ¶
func NewTable ¶
func NewTable(w io.Writer, headers []string) *pterm.TablePrinter
NewTable creates a new table with the given headers
func ParseLevel ¶
func SetDefaultOutput ¶
SetOutput sets the default output writer for the UI
func Spin ¶
Spin runs a spinner with the given text and function. If the terminal is not a TTY, the spinner is not shown.
func UpdateSpinnerText ¶
Hack - clear line when updating text - https://github.com/pterm/pterm/pull/656/files
Types ¶
type Spinner ¶
type Spinner = *pterm.SpinnerPrinter
Click to show internal directories.
Click to hide internal directories.