input

Documentation

Index

• type Model
  • func New() Model
  • func (m *Model) Init() tea.Cmd
  • func (m *Model) SetValue(value string)
  • func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m *Model) Value() string
  • func (m *Model) View() string
• type Styles
• type ValidateFunc

Types

type Model

type Model struct {
	PromptPrefix     string
	Prompt           string
	Placeholder      string
	CharLimit        int
	MaxWidth         int
	EchoMode         textinput.EchoMode
	Validate         ValidateFunc
	Styles           Styles
	Suggest          func(input string) []string
	SuggestionPrefix string
	// contains filtered or unexported fields
}

Model represents the bubble tea model for the input

func New

func New() Model

New creates a new model with default settings.

func (*Model) Init

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

func (*Model) SetValue

func (m *Model) SetValue(value string)

func (*Model) Update

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

func (*Model) Value

func (m *Model) Value() string

func (*Model) View

func (m *Model) View() string

type Styles

type Styles struct {
	PromptPrefix lipgloss.Style
	Prompt       lipgloss.Style
	ErrorPrefix  lipgloss.Style
	Text         lipgloss.Style
	Placeholder  lipgloss.Style
	Suggestions  lipgloss.Style
}

Styles holds relevant styles used for rendering For an introduction to styling with Lip Gloss see: https://github.com/charmbracelet/lipgloss

type ValidateFunc

type ValidateFunc validate.Func

ValidateFunc determines if the input string is valid, returning nil if valid or an error if invalid