wizard

Documentation

Index

• func New() (Model, Handler, chan<- bool)
• type Handler
• type InputCompleted
• type Model
  • func (m Model) InfoLog(message string) string
  • func (m Model) Init() tea.Cmd
  • func (m Model) ReceiveUpdateMessages() tea.Msg
  • func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Model) View() string
  • func (m Model) WarnLog(message string) string
• type Styles
  • func DefaultStyles() Styles
• type TaskStatus
• type TaskStatusStyle
  • func DefaultMarks() TaskStatusStyle
  • func (s TaskStatusStyle) Render(status TaskStatus) string

Functions

func New

func New() (Model, Handler, chan<- bool)

Types

type Handler

type Handler interface {
	Done()
	Abort(string)
	Info(string)
	SetCurrentTaskCompletedTitle(string)
	SetCurrentTaskCompletedTitleWithStatus(string, TaskStatus)
	SetInputModel(tea.Model) tea.Model
	SetTask(string, string)
	Warn(string)
	OnQuit(tea.Model, tea.Msg) tea.Msg
}

type InputCompleted

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

type Model

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

func (Model) InfoLog

func (m Model) InfoLog(message string) string

func (Model) Init

func (m Model) Init() tea.Cmd

func (Model) ReceiveUpdateMessages

func (m Model) ReceiveUpdateMessages() tea.Msg

func (Model) Update

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

func (Model) View

func (m Model) View() string

func (Model) WarnLog

func (m Model) WarnLog(message string) string

type Styles

type Styles struct {
	Bold           lipgloss.Style
	Spinner        lipgloss.Style
	InfoLogHeading lipgloss.Style
	WarnLogHeading lipgloss.Style
	InfoLogBody    lipgloss.Style
	WarnLogBody    lipgloss.Style
	Marks          TaskStatusStyle
}

func DefaultStyles

func DefaultStyles() Styles

type TaskStatus

type TaskStatus string

const (
	TaskStatusSuccess TaskStatus = "success"
	TaskStatusError   TaskStatus = "error"
	TaskStatusSkipped TaskStatus = "skipped"
)

type TaskStatusStyle

type TaskStatusStyle struct {
	Success lipgloss.Style
	Error   lipgloss.Style
	Skipped lipgloss.Style
}

func DefaultMarks

func DefaultMarks() TaskStatusStyle

func (TaskStatusStyle) Render

func (s TaskStatusStyle) Render(status TaskStatus) string