cliui

Documentation

Index

• Variables
• func Bold(s string) string
• func BoldFmt() pretty.Formatter
• func Code(s string) string
• func Color(s string) termenv.Color
• func Field(s string) string
• func Keyword(s string) string
• func Placeholder(s string) string
• func Timestamp(t time.Time) string
• func ValidateNotEmpty(s string) error
• func Wrap(s string) string
• type Styles

Variables

var (
	Green   = Color("#04B575")
	Red     = Color("#ED567A")
	Fuchsia = Color("#EE6FF8")
	Yellow  = Color("#ECFD65")
	Blue    = Color("#5000ff")
)

var Canceled = xerrors.New("canceled")

Functions

func Bold

func Bold(s string) string

Bold returns a formatter that renders text in bold if the terminal supports it.

func BoldFmt

func BoldFmt() pretty.Formatter

BoldFmt returns a formatter that renders text in bold if the terminal supports it.

func Code

func Code(s string) string

Code formats code for display.

func Color

func Color(s string) termenv.Color

Color returns a color for the given string.

func Field

func Field(s string) string

Field formats a field for display.

func Keyword

func Keyword(s string) string

Keyword formats a keyword for display.

func Placeholder

func Placeholder(s string) string

Placeholder formats a placeholder for display.

func Timestamp

func Timestamp(t time.Time) string

Timestamp formats a timestamp for display.

func ValidateNotEmpty

func ValidateNotEmpty(s string) error

ValidateNotEmpty is a helper function to disallow empty inputs!

func Wrap

func Wrap(s string) string

Wrap prevents the text from overflowing the terminal.

Types

type Styles

type Styles struct {
	Code,
	DateTimeStamp,
	Error,
	Field,
	Keyword,
	Placeholder,
	Prompt,
	FocusedPrompt,
	Fuchsia,
	Warn,
	Wrap,
	Disabled,
	Enabled pretty.Style
}

var DefaultStyles Styles

DefaultStyles compose visual elements of the UI.