input

package
v0.6.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 20, 2023 License: MIT Imports: 7 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ErrMsg

type ErrMsg error

type Input

type Input struct {
	Program *tea.Program
	// contains filtered or unexported fields
}

func NewInput

func NewInput(opts ...TOption) (ipt *Input)

func (*Input) Run

func (that *Input) Run()

func (*Input) Value

func (that *Input) Value() string

type InputList added in v0.4.9

type InputList struct {
	// contains filtered or unexported fields
}

func NewInputList added in v0.4.9

func NewInputList() (ipl *InputList)

func (*InputList) Add added in v0.4.9

func (that *InputList) Add(name string, ipt Inputer)

func (*InputList) GetByIndex added in v0.4.9

func (that *InputList) GetByIndex(index int) Inputer

func (*InputList) GetNameByIndex added in v0.4.9

func (that *InputList) GetNameByIndex(index int) string

func (*InputList) Len added in v0.4.9

func (that *InputList) Len() int

type InputModel

type InputModel struct {
	// contains filtered or unexported fields
}

func NewInputModel

func NewInputModel(opts ...TOption) (im *InputModel)

func (*InputModel) Blur added in v0.6.3

func (that *InputModel) Blur()

func (*InputModel) Focus

func (that *InputModel) Focus() tea.Cmd

func (*InputModel) Init

func (that *InputModel) Init() tea.Cmd

func (*InputModel) IsOption added in v0.6.3

func (that *InputModel) IsOption() bool

func (*InputModel) SetCursorMode added in v0.6.3

func (that *InputModel) SetCursorMode(mode cursor.Mode) tea.Cmd

func (*InputModel) SetHelpStr added in v0.6.3

func (that *InputModel) SetHelpStr(help string)

func (*InputModel) SetPromptStyle added in v0.6.3

func (that *InputModel) SetPromptStyle(style lipgloss.Style)

func (*InputModel) SetTextStyle added in v0.6.3

func (that *InputModel) SetTextStyle(style lipgloss.Style)

func (*InputModel) Update

func (that *InputModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*InputModel) Value

func (that *InputModel) Value() string

func (*InputModel) View

func (that *InputModel) View() string

type InputMultiModel added in v0.4.9

type InputMultiModel struct {
	// contains filtered or unexported fields
}

func NewInputMultiModel added in v0.4.9

func NewInputMultiModel() (imm *InputMultiModel)

func (*InputMultiModel) AddOneInput added in v0.4.9

func (that *InputMultiModel) AddOneInput(key string, opts ...MOption)

func (*InputMultiModel) AddOneOption added in v0.6.3

func (that *InputMultiModel) AddOneOption(name string, values []string, opts ...MOption)

func (*InputMultiModel) Init added in v0.4.9

func (that *InputMultiModel) Init() tea.Cmd

func (*InputMultiModel) SetSubmitCmd added in v0.6.0

func (that *InputMultiModel) SetSubmitCmd(scmd tea.Cmd)

func (*InputMultiModel) Update added in v0.4.9

func (that *InputMultiModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*InputMultiModel) Values added in v0.4.9

func (that *InputMultiModel) Values() map[string]string

func (*InputMultiModel) View added in v0.4.9

func (that *InputMultiModel) View() string

type Inputer added in v0.6.3

type Inputer interface {
	Init() tea.Cmd
	View() string
	Update(tea.Msg) (tea.Model, tea.Cmd)
	Focus() tea.Cmd
	Value() string
	SetPromptStyle(style lipgloss.Style)
	SetTextStyle(style lipgloss.Style)
	Blur()
	SetCursorMode(mode cursor.Mode) tea.Cmd
	IsOption() bool
}

type MOption added in v0.4.9

type MOption func(ipt *textinput.Model)

func MWithCharlimit added in v0.4.9

func MWithCharlimit(cLimit int) MOption

func MWithEchoChar added in v0.4.9

func MWithEchoChar(echoChar string) MOption

func MWithEchoMode added in v0.4.9

func MWithEchoMode(echoMode textinput.EchoMode) MOption

func MWithPlaceholder added in v0.4.9

func MWithPlaceholder(pHolder string) MOption

func MWithPrompt added in v0.6.3

func MWithPrompt(prompt string) MOption

func MWithWidth added in v0.4.9

func MWithWidth(width int) MOption

type MultiInput added in v0.4.9

type MultiInput struct {
	Program *tea.Program
	// contains filtered or unexported fields
}

func NewMultiInput added in v0.4.9

func NewMultiInput() (mipt *MultiInput)

func (*MultiInput) AddOneItem added in v0.4.9

func (that *MultiInput) AddOneItem(key string, opts ...MOption)

func (*MultiInput) AddOneOption added in v0.6.3

func (that *MultiInput) AddOneOption(name string, values []string, opts ...MOption)

func (*MultiInput) Run added in v0.4.9

func (that *MultiInput) Run()

func (*MultiInput) Values added in v0.4.9

func (that *MultiInput) Values() map[string]string

type Option added in v0.6.3

type Option struct {
	Program *tea.Program
	// contains filtered or unexported fields
}

func NewOption added in v0.6.3

func NewOption(values []string, opts ...TOption) (option *Option)

func (*Option) Run added in v0.6.3

func (that *Option) Run()

func (*Option) Value added in v0.6.3

func (that *Option) Value() string

type OptionModel added in v0.6.3

type OptionModel struct {
	*InputModel
	ValueList []string
	Idx       int
}

func NewOptionModel added in v0.6.3

func NewOptionModel(values []string, opts ...TOption) (om *OptionModel)

func (*OptionModel) Blur added in v0.6.3

func (that *OptionModel) Blur()

func (*OptionModel) Focus added in v0.6.3

func (that *OptionModel) Focus() tea.Cmd

func (*OptionModel) IsOption added in v0.6.3

func (that *OptionModel) IsOption() bool

func (*OptionModel) SetCursorMode added in v0.6.3

func (that *OptionModel) SetCursorMode(mode cursor.Mode) tea.Cmd

func (*OptionModel) SetPromptStyle added in v0.6.3

func (that *OptionModel) SetPromptStyle(style lipgloss.Style)

func (*OptionModel) SetTextStyle added in v0.6.3

func (that *OptionModel) SetTextStyle(style lipgloss.Style)

func (*OptionModel) Update added in v0.6.3

func (that *OptionModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*OptionModel) Value added in v0.6.3

func (that *OptionModel) Value() string

func (*OptionModel) View added in v0.6.3

func (that *OptionModel) View() string

type TOption

type TOption func(ipm *InputModel)

func WithCharlimit

func WithCharlimit(cLimit int) TOption

func WithEchoChar

func WithEchoChar(echoChar string) TOption

func WithEchoMode

func WithEchoMode(echoMode textinput.EchoMode) TOption

func WithPlaceholder

func WithPlaceholder(pHolder string) TOption

func WithPrompt added in v0.6.3

func WithPrompt(prompt string) TOption

func WithWidth

func WithWidth(width int) TOption

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL