tui

Documentation

Index

• Constants
• Variables
• func Cmd(msg tea.Msg) tea.Cmd
• func Width(width int) int
• type ErrorMsg
• type KeyMap
  • func NewKeyMap() *KeyMap
  • func (m *KeyMap) Add(name string, binding key.Binding)
  • func (m KeyMap) Copy() *KeyMap
  • func (m KeyMap) FullHelp() [][]key.Binding
  • func (m KeyMap) Matches(msg tea.KeyMsg, keyStr string) bool
  • func (m *KeyMap) Merge(kmap *KeyMap)
  • func (m KeyMap) ShortHelp() []key.Binding
• type KeyMapProvider
• type Model
  • func NewModel(child tea.Model, keyMap *KeyMap, styles *Styles, opts ...Option) Model
  • func (m Model) Init() tea.Cmd
  • func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Model) View() string
• type Option
  • func WithoutHelp() Option
• type StandaloneInputModel
  • func NewStandaloneInputModel(inputParams prompt.InputParams, keyMap *KeyMap, styles *Styles, opts ...Option) StandaloneInputModel
  • func (m StandaloneInputModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m StandaloneInputModel) Value() (string, bool)
• type StandaloneQuestionModel
  • func NewStandaloneQuestionModel(text string, keyMap *KeyMap, styles *Styles, opts ...Option) StandaloneQuestionModel
  • func (m StandaloneQuestionModel) Confirmed() bool
  • func (m StandaloneQuestionModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)
• type Styles

Constants

const (
	MaxWidth = 120
)

Variables

var (
	ColorError   = lipgloss.NewStyle().Foreground(lipgloss.AdaptiveColor{Light: "#FF0000", Dark: "#FF0000"})
	ColorSuccess = lipgloss.NewStyle().Foreground(lipgloss.AdaptiveColor{Light: "32", Dark: "42"})
	ColorHelp    = lipgloss.NewStyle().Foreground(lipgloss.AdaptiveColor{Light: "#B2B2B2", Dark: "#4A4A4A"})
)

var DefaultStyles = &Styles{
	Child:   lipgloss.NewStyle().Padding(1, 0, 0, 0),
	Error:   lipgloss.NewStyle().Inherit(ColorError).Padding(1, 0),
	Help:    lipgloss.NewStyle().Padding(1, 0, 1, 2),
	Success: lipgloss.NewStyle().Inherit(ColorSuccess).Padding(1, 0),
}

var MinimalKeyMap = func() *KeyMap {
	m := orderedmap.NewOrderedMap()
	m.Set("quit", key.NewBinding(
		key.WithKeys("ctrl+c"),
		key.WithHelp("ctrl+c", "quit"),
	))
	return &KeyMap{OrderedMap: m}
}()

Functions

func Cmd

func Cmd(msg tea.Msg) tea.Cmd

func Width

func Width(width int) int

Types

type ErrorMsg

type ErrorMsg struct {
	Err  error
	Exit bool
}

type KeyMap

type KeyMap struct {
	*orderedmap.OrderedMap
}

func NewKeyMap

func NewKeyMap() *KeyMap

func (*KeyMap) Add

func (m *KeyMap) Add(name string, binding key.Binding)

func (KeyMap) Copy

func (m KeyMap) Copy() *KeyMap

func (KeyMap) FullHelp

func (m KeyMap) FullHelp() [][]key.Binding

func (KeyMap) Matches

func (m KeyMap) Matches(msg tea.KeyMsg, keyStr string) bool

func (*KeyMap) Merge

func (m *KeyMap) Merge(kmap *KeyMap)

func (KeyMap) ShortHelp

func (m KeyMap) ShortHelp() []key.Binding

type KeyMapProvider

type KeyMapProvider interface {
	KeyMap() *KeyMap
}

type Model

type Model struct {
	Child  tea.Model
	KeyMap *KeyMap
	Styles *Styles
	// contains filtered or unexported fields
}

func NewModel

func NewModel(
	child tea.Model,
	keyMap *KeyMap,
	styles *Styles,
	opts ...Option,
) Model

func (Model) Init

func (m Model) Init() tea.Cmd

func (Model) Update

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

func (Model) View

func (m Model) View() string

type Option

type Option func(*Model)

func WithoutHelp

func WithoutHelp() Option

type StandaloneInputModel

type StandaloneInputModel struct {
	tea.Model
	// contains filtered or unexported fields
}

func NewStandaloneInputModel

func NewStandaloneInputModel(
	inputParams prompt.InputParams,
	keyMap *KeyMap,
	styles *Styles,
	opts ...Option,
) StandaloneInputModel

func (StandaloneInputModel) Update

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

func (StandaloneInputModel) Value

func (m StandaloneInputModel) Value() (string, bool)

type StandaloneQuestionModel

type StandaloneQuestionModel struct {
	tea.Model
	// contains filtered or unexported fields
}

func NewStandaloneQuestionModel

func NewStandaloneQuestionModel(
	text string,
	keyMap *KeyMap,
	styles *Styles,
	opts ...Option,
) StandaloneQuestionModel

func (StandaloneQuestionModel) Confirmed

func (m StandaloneQuestionModel) Confirmed() bool

func (StandaloneQuestionModel) Update

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

type Styles

type Styles struct {
	Child   lipgloss.Style
	Error   lipgloss.Style
	Help    lipgloss.Style
	Success lipgloss.Style
}