input

Documentation

Index

• Variables
• type EchoMode
• type InputMode
• type KeyMap
  • func (k KeyMap) FullHelp() [][]key.Binding
  • func (k KeyMap) ShortHelp() []key.Binding
• type Model
  • func New(defaultValue string, opts ...Option) *Model
  • func (m Model) Data() string
  • func (m Model) DataString() string
  • func (m Model) Error() error
  • func (m Model) Init() tea.Cmd
  • func (m Model) Quitting() bool
  • func (m Model) TeaProgramOpts() []tea.ProgramOption
  • func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Model) View() string
  • func (m *Model) WithEchoMode(mode EchoMode) *Model
  • func (m *Model) WithInputMode(mode InputMode) *Model
  • func (m *Model) WithValidateFunc(vf ValidateFunc) *Model
• type Option
  • func WithEchoMode(mode EchoMode) Option
  • func WithHelp(show bool) Option
  • func WithInputMode(mode InputMode) Option
  • func WithKeyMap(keyMap KeyMap) Option
  • func WithTeaProgramOpts(opts ...tea.ProgramOption) Option
  • func WithValidateFunc(vf ValidateFunc) Option
  • func WithWidth(width int) Option
• type ValidateFunc

Variables

var DefaultKeyMap = KeyMap{
	Confirm: key.NewBinding(
		key.WithKeys("enter"),
		key.WithHelp("enter", "confirm"),
	),
	Quit: key.NewBinding(
		key.WithKeys("esc", "ctrl+c"),
		key.WithHelp("esc", "quit"),
	),
}

Types

type EchoMode

type EchoMode = textinput.EchoMode

const (
	// EchoNormal displays text as is. This is the default behavior.
	EchoNormal EchoMode = textinput.EchoNormal

	// EchoPassword displays the EchoCharacter mask instead of actual
	// characters.  This is commonly used for password fields.
	EchoPassword EchoMode = textinput.EchoPassword

	// EchoNone displays nothing as characters are entered. This is commonly
	// seen for password fields on the command line.
	EchoNone EchoMode = textinput.EchoNone
)

type InputMode

type InputMode int

const (
	InputAll     InputMode = iota // allow any input.
	InputInteger                  // only integers can be entered.
	InputNumber                   // only integers and decimals can be entered.
)

type KeyMap

type KeyMap struct {
	Confirm 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(defaultValue string, opts ...Option) *Model

func (Model) Data

func (m Model) Data() string

func (Model) DataString

func (m Model) DataString() string

func (Model) Error

func (m Model) Error() error

func (Model) Init

func (m Model) Init() tea.Cmd

func (Model) Quitting

func (m Model) Quitting() bool

func (Model) TeaProgramOpts

func (m Model) TeaProgramOpts() []tea.ProgramOption

func (Model) Update

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

func (Model) View

func (m Model) View() string

func (*Model) WithEchoMode

func (m *Model) WithEchoMode(mode EchoMode) *Model

func (*Model) WithInputMode

func (m *Model) WithInputMode(mode InputMode) *Model

func (*Model) WithValidateFunc

func (m *Model) WithValidateFunc(vf ValidateFunc) *Model

type Option

type Option func(*Model)

func WithEchoMode

func WithEchoMode(mode EchoMode) Option

func WithHelp

func WithHelp(show bool) Option

func WithInputMode

func WithInputMode(mode InputMode) Option

func WithKeyMap

func WithKeyMap(keyMap KeyMap) Option

func WithTeaProgramOpts

func WithTeaProgramOpts(opts ...tea.ProgramOption) Option

func WithValidateFunc

func WithValidateFunc(vf ValidateFunc) Option

func WithWidth

func WithWidth(width int) Option

type ValidateFunc

type ValidateFunc func(string) error