write

Documentation

Index

• Variables
• 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) KeyBindings() []key.Binding
  • 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) WithValidateFunc(vf ValidateFunc) *Model
• type Option
  • func WithCharLimit(limit int) Option
  • func WithHelp(show bool) Option
  • func WithKeyMap(keyMap KeyMap) Option
  • func WithLineNumbers(enable bool) 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("ctrl+d"),
		key.WithHelp("ctrl+d", "confirm"),
	),
	Quit: key.NewBinding(
		key.WithKeys("esc", "ctrl+c"),
		key.WithHelp("esc", "quit"),
	),
}

Types

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) KeyBindings

func (m Model) KeyBindings() []key.Binding

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) WithValidateFunc

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

type Option

type Option func(*Model)

func WithCharLimit

func WithCharLimit(limit int) Option

Default is 400. https://github.com/charmbracelet/bubbles/blob/master/textarea/textarea.go#L23

func WithHelp

func WithHelp(show bool) Option

func WithKeyMap

func WithKeyMap(keyMap KeyMap) Option

func WithLineNumbers

func WithLineNumbers(enable bool) 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