confirm

Documentation

Overview

Package confirm provides a simple confirmation dialog component

Index

• Variables
• type ChoiceMsg
• type ConfirmChoice
• type KeyMap
  • func (k KeyMap) FullHelp() [][]key.Binding
  • func (k KeyMap) ShortHelp() []key.Binding
• type Model
  • func New() Model
  • func (m Model) Choice(choice ConfirmChoice) tea.Cmd
  • func (m *Model) HandleKeys(msg tea.KeyMsg) tea.Cmd
  • func (m *Model) HandleWindowResize(msg tea.WindowSizeMsg) tea.Cmd
  • func (m Model) View(prompt string) string

Variables

var (
	InactiveButtonStyle = lipgloss.NewStyle().
		Foreground(colors.InactiveButtonFg).
		Background(colors.InactiveButtonBg).
		Padding(buttonPadding...).
		Margin(buttonMargin...)
)

var Keys = KeyMap{
	Toggle: key.NewBinding(
		key.WithKeys("tab", "h", "l", "left", "right"),
		key.WithHelp("", "toggle"),
	),
	Confirm: key.NewBinding(
		key.WithKeys("y"),
		key.WithHelp("y", "confirm"),
	),
	Cancel: key.NewBinding(
		key.WithKeys("n"),
		key.WithHelp("n", "cancel"),
	),
	Submit: key.NewBinding(
		key.WithKeys("enter"),
		key.WithHelp("enter", "submit"),
	),
	ShortSession: key.NewBinding(
		key.WithKeys("s"),
		key.WithHelp("s", "short session"),
	),
	Quit: key.NewBinding(
		key.WithKeys("ctrl+c", "q"),
		key.WithHelp("q", "quit"),
	),
}

Types

type ChoiceMsg

type ChoiceMsg struct {
	Choice ConfirmChoice
}

type ConfirmChoice

type ConfirmChoice int

const (
	Confirm ConfirmChoice = iota
	Cancel
	ShortSession
)

type KeyMap

type KeyMap struct {
	Toggle       key.Binding
	Confirm      key.Binding
	Cancel       key.Binding
	Submit       key.Binding
	ShortSession key.Binding
	Quit         key.Binding
}

func (KeyMap) FullHelp

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

func (KeyMap) ShortHelp

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

type Model

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

func New

func New() Model

func (Model) Choice

func (m Model) Choice(choice ConfirmChoice) tea.Cmd

func (*Model) HandleKeys

func (m *Model) HandleKeys(msg tea.KeyMsg) tea.Cmd

func (*Model) HandleWindowResize

func (m *Model) HandleWindowResize(msg tea.WindowSizeMsg) tea.Cmd

func (Model) View

func (m Model) View(prompt string) string