textinput

Documentation

Index

• func Blink(model Model) tea.Cmd
• func View(m Model) string
• type BlinkMsg
• type EchoMode
• type Model
  • func NewModel() Model
  • func Update(msg tea.Msg, m Model) (Model, tea.Cmd)
  • func (m *Model) Blur()
  • func (m *Model) CursorEnd()
  • func (m *Model) CursorStart()
  • func (m *Model) Focus()
  • func (m Model) Focused() bool
  • func (m *Model) Paste()
  • func (m *Model) Reset()
  • func (m *Model) SetCursor(pos int)
  • func (m *Model) SetValue(s string)
  • func (m Model) Value() string

Functions

func Blink

func Blink(model Model) tea.Cmd

Blink is a command used to time the cursor blinking.

func View

func View(m Model) string

View renders the textinput in its current state.

Types

type BlinkMsg

type BlinkMsg struct{}

BlinkMsg is sent when the cursor should alternate it's blinking state.

type EchoMode

type EchoMode int

EchoMode sets the input behavior of the text input field.

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

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

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

type Model

type Model struct {
	Err error

	Prompt      string
	Placeholder string

	Cursor     string
	BlinkSpeed time.Duration

	TextColor        string
	BackgroundColor  string
	PlaceholderColor string
	CursorColor      string

	EchoMode      EchoMode
	EchoCharacter rune

	// CharLimit is the maximum amount of characters this input element will
	// accept. If 0 or less, there's no limit.
	CharLimit int

	// Width is the maximum number of characters that can be displayed at once.
	// It essentially treats the text field like a horizontally scrolling
	// viewport. If 0 or less this setting is ignored.
	Width int
	// contains filtered or unexported fields
}

Model is the Bubble Tea model for this text input element.

func NewModel

func NewModel() Model

NewModel creates a new model with default settings.

func Update

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

Update is the Tea update loop.

func (*Model) Blur

func (m *Model) Blur()

Blur removes the focus state on the model.

func (*Model) CursorEnd

func (m *Model) CursorEnd()

CursorEnd moves the cursor to the end of the field.

func (*Model) CursorStart

func (m *Model) CursorStart()

CursorStart moves the cursor to the start of the field.

func (*Model) Focus

func (m *Model) Focus()

Focus sets the focus state on the model.

func (Model) Focused

func (m Model) Focused() bool

Focused returns the focus state on the model.

func (*Model) Paste

func (m *Model) Paste()

Paste pastes the contents of the clipboard into the text area (if supported).

func (*Model) Reset

func (m *Model) Reset()

Reset sets the input to its default state with no input.

func (*Model) SetCursor

func (m *Model) SetCursor(pos int)

SetCursor start moves the cursor to the given position. If the position is out of bounds the cursor will be moved to the start or end accordingly.

func (*Model) SetValue

func (m *Model) SetValue(s string)

SetValue sets the value of the text input.

func (Model) Value

func (m Model) Value() string

Value returns the value of the text input.