textinput

README

Textinput with auto-completion

This is a simple wrapper around the github.com/charmbracelet/bubbles/textinput, with support for auto-completion.

The API is almost the same as the github.com/charmbracelet/bubbles/textinput, except users can optionally set the .CandidateWords to indicate the candidate words for auto-completion, which is triggered by tab/shift-tab.

See the example for a demo, and also compare it with the bubbletea textinput example to see the usage difference.

Documentation

Index

• Constants
• func Blink() tea.Msg
• func Paste() tea.Msg
• type CandidateViewMode
• type CursorMode
• type EchoMode
• type Model
  • func NewModel() Model
  • func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)
  • func (m Model) View() string

Constants

const (
	EchoNormal   = textinput.EchoNormal
	EchoPassword = textinput.EchoPassword
	EchoNone     = textinput.EchoNone

	CursorBlink  = textinput.CursorBlink
	CursorStatic = textinput.CursorStatic
	CursorHide   = textinput.CursorHide
)

Functions

func Blink

func Blink() tea.Msg

func Paste

func Paste() tea.Msg

Types

type CandidateViewMode

type CandidateViewMode int

const (
	CandidateViewVertical CandidateViewMode = iota
	CandidateViewHorizental
	CandidateViewNone
)

type CursorMode

type CursorMode = textinput.CursorMode

type EchoMode

type EchoMode = textinput.EchoMode

type Model

type Model struct {
	textinput.Model
	CandidateWords []string

	CandidateViewMode CandidateViewMode
	Width             int

	StyleMatching  lipgloss.Style
	StyleCandidate lipgloss.Style
	// contains filtered or unexported fields
}

func NewModel

func NewModel() Model

func (Model) Update

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

func (Model) View

func (m Model) View() string