confirm

Documentation

Index

• Variables
• type Confirm
  • func WithSelection(ops ...Option) *Confirm
  • func (c *Confirm) Display() (bool, error)
• type KeyMap
  • func DefaultKeyBinding() KeyMap
  • func (k KeyMap) FullHelp() [][]key.Binding
  • func (k KeyMap) ShortHelp() []key.Binding
• type Option
  • func WithChoiceStyle(s *style.Style) Option
  • func WithDefaultYes() Option
  • func WithDisableOutputResult() Option
  • func WithDisableShowHelp() Option
  • func WithFocusInterval(no string) Option
  • func WithFocusIntervalStyle(s *style.Style) Option
  • func WithFocusSymbol(s string) Option
  • func WithFocusSymbolStyle(s *style.Style) Option
  • func WithKeyMap(keymap KeyMap) Option
  • func WithNo(no string) Option
  • func WithPrompt(prompt string) Option
  • func WithPromptStyle(s *style.Style) Option
  • func WithUnFocusInterval(no string) Option
  • func WithUnFocusIntervalStyle(s *style.Style) Option
  • func WithUnFocusSymbol(s string) Option
  • func WithUnFocusSymbolStyle(s *style.Style) Option
  • func WithYes(yes string) Option

Variables

var (
	Yes      = "Yes"
	No       = "No"
	ShowHelp = true

	FocusSymbol     = theme.DefaultTheme.FocusSymbol
	UnFocusSymbol   = theme.DefaultTheme.UnFocusSymbol
	FocusInterval   = theme.DefaultTheme.FocusInterval
	UnFocusInterval = theme.DefaultTheme.UnFocusInterval
	Prompt          = "Are you handsome?"

	FocusSymbolStyle     = theme.DefaultTheme.FocusSymbolStyle
	UnFocusSymbolStyle   = theme.DefaultTheme.UnFocusSymbolStyle
	FocusIntervalStyle   = theme.DefaultTheme.FocusIntervalStyle
	UnFocusIntervalStyle = theme.DefaultTheme.UnFocusIntervalStyle
	PromptStyle          = style.New().Bold().Fg(color.White)
	ChoiceStyle          = theme.DefaultTheme.ChoiceTextStyle.Underline()
)

Types

type Confirm

type Confirm struct {
	KeyMap       KeyMap
	Yes          string
	No           string
	OutputResult bool
	DefaultVal   bool
	ShowHelp     bool

	FocusSymbol     string
	UnFocusSymbol   string
	FocusInterval   string
	UnFocusInterval string
	Prompt          string

	FocusSymbolStyle     *style.Style
	UnFocusSymbolStyle   *style.Style
	FocusIntervalStyle   *style.Style
	UnFocusIntervalStyle *style.Style
	PromptStyle          *style.Style
	ChoiceStyle          *style.Style
	// contains filtered or unexported fields
}

Confirm with components.Selection

func WithSelection

func WithSelection(ops ...Option) *Confirm

WithSelection new Confirm with components.Selection

func (*Confirm) Display

func (c *Confirm) Display() (bool, error)

Display Confirm

type KeyMap

type KeyMap struct {
	Switch key.Binding
	Choice key.Binding
	Quit   key.Binding
}

func DefaultKeyBinding

func DefaultKeyBinding() KeyMap

DefaultKeyBinding the Confirm default key binding.

func (KeyMap) FullHelp

func (k KeyMap) FullHelp() [][]key.Binding

func (KeyMap) ShortHelp

func (k KeyMap) ShortHelp() []key.Binding

type Option

type Option func(c *Confirm)

func WithChoiceStyle

func WithChoiceStyle(s *style.Style) Option

WithChoiceStyle replace ChoiceStyle, default is ChoiceStyle

func WithDefaultYes

func WithDefaultYes() Option

WithDefaultYes set Confirm default val is `true`

func WithDisableOutputResult

func WithDisableOutputResult() Option

WithDisableOutputResult on finish confirm, output result.

func WithDisableShowHelp

func WithDisableShowHelp() Option

WithDisableShowHelp disable show help info.

func WithFocusInterval

func WithFocusInterval(no string) Option

WithFocusInterval replace FocusInterval, default is FocusInterval

func WithFocusIntervalStyle

func WithFocusIntervalStyle(s *style.Style) Option

WithFocusIntervalStyle replace FocusIntervalStyle, default is FocusIntervalStyle

func WithFocusSymbol

func WithFocusSymbol(s string) Option

WithFocusSymbol replace FocusSymbol, default is FocusSymbol

func WithFocusSymbolStyle

func WithFocusSymbolStyle(s *style.Style) Option

WithFocusSymbolStyle replace FocusSymbolStyle, default is FocusSymbolStyle

func WithKeyMap

func WithKeyMap(keymap KeyMap) Option

WithKeyMap replace keymap. default is DefaultKeyBinding

func WithNo

func WithNo(no string) Option

WithNo default is No

func WithPrompt

func WithPrompt(prompt string) Option

WithPrompt replace Prompt, default is Prompt

func WithPromptStyle

func WithPromptStyle(s *style.Style) Option

WithPromptStyle replace PromptStyle, default is PromptStyle

func WithUnFocusInterval

func WithUnFocusInterval(no string) Option

WithUnFocusInterval replace UnFocusInterval, default is UnFocusInterval

func WithUnFocusIntervalStyle

func WithUnFocusIntervalStyle(s *style.Style) Option

WithUnFocusIntervalStyle replace UnFocusIntervalStyle, default is UnFocusIntervalStyle

func WithUnFocusSymbol

func WithUnFocusSymbol(s string) Option

WithUnFocusSymbol replace UnFocusSymbol, default is UnFocusSymbol

func WithUnFocusSymbolStyle

func WithUnFocusSymbolStyle(s *style.Style) Option

WithUnFocusSymbolStyle replace UnFocusSymbolStyle, default is UnFocusSymbolStyle

func WithYes

func WithYes(yes string) Option

WithYes default is Yes