textinput

Documentation

Index

• Variables
• func Blink() tea.Msg
• func Paste() tea.Msg
• type CursorMode
  • func (c CursorMode) String() string
• type EchoMode
• type Model
  • func New() Model
  • func (m Model) Blink() bool
  • func (m *Model) Blur()
  • func (m Model) Cursor() int
  • func (m *Model) CursorEnd()
  • func (m Model) CursorMode() CursorMode
  • func (m *Model) CursorStart()
  • func (m *Model) Focus() tea.Cmd
  • func (m Model) Focused() bool
  • func (m *Model) Reset() bool
  • func (m *Model) SetCursor(pos int)
  • func (m *Model) SetCursorMode(mode CursorMode) tea.Cmd
  • func (m *Model) SetValue(s string)
  • func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)
  • func (m Model) Value() string
  • func (m Model) View() string
• type ValidateFunc

Variables

var NewModel = New

NewModel creates a new model with default settings.

Deprecated. Use New instead.

Functions

func Blink

func Blink() tea.Msg

Blink is a command used to initialize cursor blinking.

func Paste

func Paste() tea.Msg

Paste is a command for pasting from the clipboard into the text input.

Types

type CursorMode

type CursorMode int

CursorMode describes the behavior of the cursor.

const (
	CursorBlink CursorMode = iota
	CursorStatic
	CursorHide
)

Available cursor modes.

func (CursorMode) String

func (c CursorMode) String() string

String returns a the cursor mode in a human-readable format. This method is provisional and for informational purposes only.

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

	// General settings.
	Prompt        string
	Placeholder   string
	BlinkSpeed    time.Duration
	EchoMode      EchoMode
	EchoCharacter rune

	// Styles. These will be applied as inline styles.
	//
	// For an introduction to styling with Lip Gloss see:
	// https://github.com/charmbracelet/lipgloss
	PromptStyle      lipgloss.Style
	TextStyle        lipgloss.Style
	BackgroundStyle  lipgloss.Style
	PlaceholderStyle lipgloss.Style
	CursorStyle      lipgloss.Style

	// 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

	// Validate is a function that checks whether or not the text within the
	// input is valid. If it is not valid, the `Err` field will be set to the
	// error returned by the function. If the function is not defined, all
	// input is considered valid.
	Validate ValidateFunc
	// contains filtered or unexported fields
}

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

func New

func New() Model

New creates a new model with default settings.

func (Model) Blink

func (m Model) Blink() bool

Blink returns whether or not to draw the cursor.

func (*Model) Blur

func (m *Model) Blur()

Blur removes the focus state on the model. When the model is blurred it can not receive keyboard input and the cursor will be hidden.

func (Model) Cursor

func (m Model) Cursor() int

Cursor returns the cursor position.

func (*Model) CursorEnd

func (m *Model) CursorEnd()

CursorEnd moves the cursor to the end of the input field.

func (Model) CursorMode

func (m Model) CursorMode() CursorMode

CursorMode returns the model's cursor mode. For available cursor modes, see type CursorMode.

func (*Model) CursorStart

func (m *Model) CursorStart()

CursorStart moves the cursor to the start of the input field.

func (*Model) Focus

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

Focus sets the focus state on the model. When the model is in focus it can receive keyboard input and the cursor will be hidden.

func (Model) Focused

func (m Model) Focused() bool

Focused returns the focus state on the model.

func (*Model) Reset

func (m *Model) Reset() bool

Reset sets the input to its default state with no input. Returns whether or not the cursor blink should reset.

func (*Model) SetCursor

func (m *Model) SetCursor(pos int)

SetCursor 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) SetCursorMode

func (m *Model) SetCursorMode(mode CursorMode) tea.Cmd

SetCursorMode sets the model's cursor mode. This method returns a command.

For available cursor modes, see type CursorMode.

func (*Model) SetValue

func (m *Model) SetValue(s string)

SetValue sets the value of the text input.

func (Model) Update

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

Update is the Bubble Tea update loop.

func (Model) Value

func (m Model) Value() string

Value returns the value of the text input.

func (Model) View

func (m Model) View() string

View renders the textinput in its current state.

type ValidateFunc

type ValidateFunc func(string) error

ValidateFunc is a function that returns an error if the input is invalid.