confirm

Documentation

Index

• Variables
• type Confirm
  • func New(ops ...Option) *Confirm
  • func (c *Confirm) Apply(ops ...Option) *Confirm
  • func (c *Confirm) Display() error
  • func (c Confirm) Value() bool
• type KeyMap
  • func (k KeyMap) FullHelp() [][]key.Binding
  • func (k KeyMap) ShortHelp() []key.Binding
• type Option
  • func WithDefaultYes() Option
  • func WithDisplayHelp() Option
  • func WithHelp(help help.Model) Option
  • func WithKeyMap(keyMap KeyMap) Option
  • func WithNotice(notice string) Option
  • func WithNoticeStyle(style *style.Style) Option
  • func WithPrompt(prompt string) Option
  • func WithPromptStyle(style *style.Style) Option
  • func WithSymbol(symbol string) Option
  • func WithSymbolStyle(style *style.Style) Option

Variables

var (
	DefaultKeyMap = KeyMap{
		Quit: key.NewBinding(
			key.WithKeys("ctrl+c"),
			key.WithHelp("^c", "quit confirm"),
		),
		Yes: key.NewBinding(
			key.WithKeys("y"),
			key.WithHelp("y", "yes"),
		),
		No: key.NewBinding(
			key.WithKeys("N"),
			key.WithHelp("N", "no"),
		),
	}
)

Types

type Confirm

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

func New

func New(ops ...Option) *Confirm

func (*Confirm) Apply

func (c *Confirm) Apply(ops ...Option) *Confirm

Apply options on Confirm

func (*Confirm) Display

func (c *Confirm) Display() error

Display Confirm component.

func (Confirm) Value

func (c Confirm) Value() bool

Value returns whether the user has chosen to confirm or deny.

type KeyMap

type KeyMap struct {
	Quit key.Binding
	Yes  key.Binding
	No   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(confirm *Confirm)

func WithDefaultYes

func WithDefaultYes() Option

WithDefaultYes the `confirm` default is no, adding this option will turn into yes.

func WithDisplayHelp

func WithDisplayHelp() Option

WithDisplayHelp display help view.

func WithHelp

func WithHelp(help help.Model) Option

WithHelp replace help model.

func WithKeyMap

func WithKeyMap(keyMap KeyMap) Option

WithKeyMap change `confirm` default KeyMap.

func WithNotice

func WithNotice(notice string) Option

WithNotice replace notice, default is " ( y/N ):".

func WithNoticeStyle

func WithNoticeStyle(style *style.Style) Option

WithNoticeStyle replace notice style.

func WithPrompt

func WithPrompt(prompt string) Option

WithPrompt change `confirm` default prompt.

func WithPromptStyle

func WithPromptStyle(style *style.Style) Option

WithPromptStyle change `confirm` default promptStyle.

func WithSymbol

func WithSymbol(symbol string) Option

WithSymbol replace symbol, default is "?".

func WithSymbolStyle

func WithSymbolStyle(style *style.Style) Option

WithSymbolStyle replace symbol style.