terminal

Documentation

Index

• func DefaultView(m *Model) string
• func NewLongAnswerField() *longAnswerField
• func NewShortAnswerField(p string) *shortAnswerField
• func StartInteractiveTerminal(questions []ProjectQuestion)
• type CheckBoxField
  • func NewCheckBoxField(t string, choices []string) *CheckBoxField
  • func (m *CheckBoxField) Blink() tea.Msg
  • func (a *CheckBoxField) Blur() tea.Msg
  • func (a *CheckBoxField) Exited() bool
  • func (m *CheckBoxField) Focus() tea.Cmd
  • func (m *CheckBoxField) Init() tea.Cmd
  • func (a *CheckBoxField) Selected() map[int]any
  • func (a *CheckBoxField) SetExited()
  • func (a *CheckBoxField) SetValue(s string)
  • func (m *CheckBoxField) Update(msg tea.Msg) (Input, tea.Cmd)
  • func (a *CheckBoxField) Value() string
  • func (m *CheckBoxField) View() string
• type Input
• type Model
  • func New(questions []ProjectQuestion) *Model
  • func (m *Model) Init() tea.Cmd
  • func (m *Model) Next()
  • func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m *Model) View() string
• type ProjectQuestion
  • func NewCheckboxQuestion(k, t string, items []string) ProjectQuestion
  • func NewLongQuestion(k, q, p string) ProjectQuestion
  • func NewQuestion(k, q, p string) ProjectQuestion
  • func NewShortQuestion(k, q, p string) ProjectQuestion
• type Styles
  • func DefaultStyles() *Styles

Functions

func DefaultView

func DefaultView(m *Model) string

func NewLongAnswerField

func NewLongAnswerField() *longAnswerField

func NewShortAnswerField

func NewShortAnswerField(p string) *shortAnswerField

func StartInteractiveTerminal

func StartInteractiveTerminal(questions []ProjectQuestion)

Types

type CheckBoxField

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

func NewCheckBoxField

func NewCheckBoxField(t string, choices []string) *CheckBoxField

func (*CheckBoxField) Blink

func (m *CheckBoxField) Blink() tea.Msg

func (*CheckBoxField) Blur

func (a *CheckBoxField) Blur() tea.Msg

func (*CheckBoxField) Exited

func (a *CheckBoxField) Exited() bool

func (*CheckBoxField) Focus

func (m *CheckBoxField) Focus() tea.Cmd

func (*CheckBoxField) Init

func (m *CheckBoxField) Init() tea.Cmd

func (*CheckBoxField) Selected

func (a *CheckBoxField) Selected() map[int]any

func (*CheckBoxField) SetExited

func (a *CheckBoxField) SetExited()

func (*CheckBoxField) SetValue

func (a *CheckBoxField) SetValue(s string)

func (*CheckBoxField) Update

func (m *CheckBoxField) Update(msg tea.Msg) (Input, tea.Cmd)

func (*CheckBoxField) Value

func (a *CheckBoxField) Value() string

func (*CheckBoxField) View

func (m *CheckBoxField) View() string

type Input

type Input interface {
	Blink() tea.Msg
	Blur() tea.Msg
	Focus() tea.Cmd
	SetValue(string)
	Value() string
	Update(tea.Msg) (Input, tea.Cmd)
	View() string
	Selected() map[int]any
	SetExited()
	Exited() bool
}

type Model

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

func New

func New(questions []ProjectQuestion) *Model

func (*Model) Init

func (m *Model) Init() tea.Cmd

func (*Model) Next

func (m *Model) Next()

func (*Model) Update

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

func (*Model) View

func (m *Model) View() string

type ProjectQuestion

type ProjectQuestion struct {
	Input       Input
	Key         string
	PlaceHolder string
	Question    string
	Answer      string
}

func NewCheckboxQuestion

func NewCheckboxQuestion(k, t string, items []string) ProjectQuestion

func NewLongQuestion

func NewLongQuestion(k, q, p string) ProjectQuestion

func NewQuestion

func NewQuestion(k, q, p string) ProjectQuestion

func NewShortQuestion

func NewShortQuestion(k, q, p string) ProjectQuestion

type Styles

type Styles struct {
	BorderColor lipgloss.Color
	InputField  lipgloss.Style
}

func DefaultStyles

func DefaultStyles() *Styles