style

package

v0.9.1 Latest Latest Go to latest Published: Aug 1, 2024 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/michielnijenhuis/cli

Documentation ¶

Index ¶

func BgBlack(text string) string
func BgBlue(text string) string
func BgCyan(text string) string
func BgGreen(text string) string
func BgMagenta(text string) string
func BgRed(text string) string
func BgWhite(text string) string
func BgYellow(text string) string
func Black(text string) string
func Blue(text string) string
func Bold(text string) string
func Cyan(text string) string
func Dim(text string) string
func Gray(text string) string
func Green(text string) string
func Hidden(text string) string
func Inverse(text string) string
func Italic(text string) string
func Magenta(text string) string
func Red(text string) string
func Reset(text string) string
func Strikethrough(text string) string
func Underline(text string) string
func White(text string) string
func Yellow(text string) string
type Formatter
type ProgressBar
type Style
- func NewStyle(i input.InputInterface, o output.OutputInterface) *Style
- func (s *Style) Ask(questions string, defaultValue string, validator func(string) bool) string
- func (s *Style) AskHidden(question string, validator func(string) bool) string
- func (s *Style) Box(title string, body string, footer string, color string, info string)
- func (s *Style) Caution(messages []string)
- func (s *Style) Choice(question string, choices map[string]string, defaultValue string) string
- func (s *Style) Confirm(q string, defaultValue bool) (bool, error)
- func (s *Style) Err(messages []string)
- func (s *Style) Formatter() formatter.OutputFormatterInferface
- func (s *Style) Info(messages []string)
- func (s *Style) IsDebug() bool
- func (s *Style) IsDecorated() bool
- func (s *Style) IsQuiet() bool
- func (s *Style) IsVerbose() bool
- func (s *Style) IsVeryVerbose() bool
- func (s *Style) Listing(elements []string, prefix string)
- func (s *Style) NewLine(count int)
- func (s *Style) Note(messages []string)
- func (s *Style) ProgressAdvance(step uint)
- func (s *Style) ProgressFinish()
- func (s *Style) ProgressStart(max uint)
- func (s *Style) Section(message string)
- func (s *Style) SetDecorated(decorated bool)
- func (s *Style) SetFormatter(formatter formatter.OutputFormatterInferface)
- func (s *Style) SetVerbosity(level uint)
- func (s *Style) Success(messages []string)
- func (s *Style) Table(headers []string, rows map[string]string)
- func (s *Style) Text(messages []string)
- func (s *Style) Title(message string)
- func (s *Style) Verbosity() uint
- func (s *Style) Warning(messages []string)
- func (s *Style) Write(message string, newLine bool, options uint)
- func (s *Style) WriteMany(messages []string, newLine bool, options uint)
- func (s *Style) Writeln(message string, options uint)
- func (s *Style) Writelns(messages []string, options uint)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func BgBlack ¶

func BgBlack(text string) string

func BgBlue ¶

func BgBlue(text string) string

func BgCyan ¶

func BgCyan(text string) string

func BgGreen ¶

func BgGreen(text string) string

func BgMagenta ¶

func BgMagenta(text string) string

func BgRed ¶

func BgRed(text string) string

func BgWhite ¶

func BgWhite(text string) string

func BgYellow ¶

func BgYellow(text string) string

func Black ¶

func Black(text string) string

func Blue ¶

func Blue(text string) string

func Bold ¶

func Bold(text string) string

func Cyan ¶

func Cyan(text string) string

func Dim ¶

func Dim(text string) string

func Gray ¶

func Gray(text string) string

func Green ¶

func Green(text string) string

func Hidden ¶

func Hidden(text string) string

func Inverse ¶

func Inverse(text string) string

func Italic ¶

func Italic(text string) string

func Magenta ¶

func Magenta(text string) string

func Red ¶

func Red(text string) string

func Reset ¶

func Reset(text string) string

func Strikethrough ¶

func Strikethrough(text string) string

func Underline ¶

func Underline(text string) string

func White ¶

func White(text string) string

func Yellow ¶

func Yellow(text string) string

Types ¶

type Formatter ¶ added in v0.9.0

type Formatter func(self *ProgressBar, o output.OutputInterface) string

type ProgressBar ¶ added in v0.9.0

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

type Style ¶

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

func NewStyle ¶

func NewStyle(i input.InputInterface, o output.OutputInterface) *Style

func (*Style) Ask ¶

func (s *Style) Ask(questions string, defaultValue string, validator func(string) bool) string

TODO: implement

func (*Style) AskHidden ¶

func (s *Style) AskHidden(question string, validator func(string) bool) string

TODO: implement

func (*Style) Box ¶

func (s *Style) Box(title string, body string, footer string, color string, info string)

TODO: implement

func (*Style) Caution ¶

func (s *Style) Caution(messages []string)

TODO: implement

func (*Style) Choice ¶

func (s *Style) Choice(question string, choices map[string]string, defaultValue string) string

TODO: implement

func (*Style) Confirm ¶

func (s *Style) Confirm(q string, defaultValue bool) (bool, error)

TODO: implement

func (*Style) Err ¶

func (s *Style) Err(messages []string)

TODO: implement

func (*Style) Formatter ¶

func (s *Style) Formatter() formatter.OutputFormatterInferface

func (*Style) Info ¶

func (s *Style) Info(messages []string)

TODO: implement

func (*Style) IsDebug ¶

func (s *Style) IsDebug() bool

func (*Style) IsDecorated ¶

func (s *Style) IsDecorated() bool

func (*Style) IsQuiet ¶

func (s *Style) IsQuiet() bool

func (*Style) IsVerbose ¶

func (s *Style) IsVerbose() bool

func (*Style) IsVeryVerbose ¶

func (s *Style) IsVeryVerbose() bool

func (*Style) Listing ¶

func (s *Style) Listing(elements []string, prefix string)

TODO: implement

func (*Style) NewLine ¶

func (s *Style) NewLine(count int)

TODO: implement

func (*Style) Note ¶

func (s *Style) Note(messages []string)

TODO: implement

func (*Style) ProgressAdvance ¶

func (s *Style) ProgressAdvance(step uint)

TODO: implement

func (*Style) ProgressFinish ¶

func (s *Style) ProgressFinish()

TODO: implement

func (*Style) ProgressStart ¶

func (s *Style) ProgressStart(max uint)

TODO: implement

func (*Style) Section ¶

func (s *Style) Section(message string)

TODO: implement

func (*Style) SetDecorated ¶

func (s *Style) SetDecorated(decorated bool)

func (*Style) SetFormatter ¶

func (s *Style) SetFormatter(formatter formatter.OutputFormatterInferface)

func (*Style) SetVerbosity ¶

func (s *Style) SetVerbosity(level uint)

func (*Style) Success ¶

func (s *Style) Success(messages []string)

TODO: implement

func (*Style) Table ¶

func (s *Style) Table(headers []string, rows map[string]string)

TODO: implement

func (*Style) Text ¶

func (s *Style) Text(messages []string)

TODO: implement

func (*Style) Title ¶

func (s *Style) Title(message string)

TODO: implement

func (*Style) Verbosity ¶

func (s *Style) Verbosity() uint

func (*Style) Warning ¶

func (s *Style) Warning(messages []string)

TODO: implement

func (*Style) Write ¶

func (s *Style) Write(message string, newLine bool, options uint)

func (*Style) WriteMany ¶

func (s *Style) WriteMany(messages []string, newLine bool, options uint)

func (*Style) Writeln ¶

func (s *Style) Writeln(message string, options uint)

func (*Style) Writelns ¶

func (s *Style) Writelns(messages []string, options uint)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
components

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL