prompt

Documentation

Index

• type ConfirmOptions
• type PrintOptions
• type Prompt
  • func New() Prompt
• type StyleOptions

Types

type ConfirmOptions

type ConfirmOptions struct {
	DefaultYes bool `default:"true"`
	StyleOptions
}

type PrintOptions

type PrintOptions struct {
	LeftIndent int
	StyleOptions
}

type Prompt

type Prompt interface {
	// Confirm prompts a user for confirmation, returning true if they answer "y" or "yes"
	// and false otherwise.
	//
	// The default answer (controlled by the DefaultYes option) will be returned if
	// they hit enter without answering yes or no.
	//
	// Loops until a valid value is supplied.
	Confirm(message string, options ...func(*ConfirmOptions)) (bool, error)
	// Print is for printing a large block of text to the terminal
	Print(text string, options ...func(*PrintOptions)) error
	// Newline prints newlines to the console. If count not specified, one newline is printed
	Newline(count ...int) error
}

func New

func New() Prompt

New return a new Prompt instance.

type StyleOptions

type StyleOptions struct {
	Bold bool `default:"false"`
	Wrap bool `default:"true"`
}