help

Documentation

Index

• func UpdateKeymap(keys keymap.KeyMap) tea.Cmd
• type Model
  • func New(opts ...Option) *Model
  • func (m *Model) Init() tea.Cmd
  • func (m *Model) Update(msg tea.Msg) (*Model, tea.Cmd)
  • func (m *Model) View() string
• type Option
  • func WithKeyMap(keyMap *keymap.KeyMap) Option
• type UpdateKeymapMsg

Functions

func UpdateKeymap

func UpdateKeymap(keys keymap.KeyMap) tea.Cmd

Types

type Model

type Model struct {
	KeyMap *keymap.KeyMap
	Help   help.Model
}

func New

func New(opts ...Option) *Model

func (*Model) Init

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

Init is present to satisfy the Model interface. It's a no-op.

func (*Model) Update

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

Update processes messages and returns the updated Model and a command.

func (*Model) View

func (m *Model) View() string

View returns the string representation of the Model to be displayed on the screen.

type Option

type Option func(*Model)

func WithKeyMap

func WithKeyMap(keyMap *keymap.KeyMap) Option

type UpdateKeymapMsg

type UpdateKeymapMsg keymap.KeyMap