dialog

type Button ¶ added in v0.0.12

type Button struct {
	Label       string
	Accel       string
	Value       string
	Affirmative bool
}

Button is one answer a dialog offers.

Accel is the single key that chooses it outright, drawn inside the label so it is discoverable before it is needed (decision I-7). It is not a held key — that is why y/n are safe here and j/k are not. The reason j/k were kept off the button row is that they are what a reader's fingers are already on when a confirm appears mid-scroll; an accelerator letter nobody is holding cannot be pressed by reflex.

Affirmative is what Confirmed reports for this button. Every button that does the thing is affirmative; the one that backs out is not.

type DialogResultMsg ¶

type DialogResultMsg struct {
	ID        string
	Confirmed bool
	Value     string
}

DialogResultMsg is emitted when a dialog is closed.

Value names the button that was chosen, so a dialog with more than two answers can be told apart by the host: the delete confirm asks "for me" or "for everyone", and the caller has to know which. Confirmed remains the yes/no reading of the same answer — true for any button that acts, false for the one that backs out and for Escape — so the callers that only ever asked one question did not have to learn a second vocabulary.

type Model ¶

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

Model is a modal dialog component.

func NewAlert(r theme.Roles, id, title, message string) Model

func NewChoice(r theme.Roles, id, title, message string, buttons []Button) Model

func NewConfirm(r theme.Roles, id, title, message string) Model

func (m Model) IsVisible() bool

func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)

func (m Model) View() string