help

Documentation

Index

• type Model
  • func New(bindings help.KeyMap, opts ...Option) *Model
  • func (m *Model) CanGrow() bool
  • func (m *Model) GetHeight() int
  • 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 WithStyles(styles *foam.Styles) Option

Types

type Model

type Model struct {
	foam.Common
	*help.Model
	// contains filtered or unexported fields
}

func New

func New(bindings help.KeyMap, opts ...Option) *Model

func (*Model) CanGrow

func (m *Model) CanGrow() bool

func (*Model) GetHeight

func (m *Model) GetHeight() int

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 WithStyles

func WithStyles(styles *foam.Styles) Option