footer

Documentation

Index

• func ToggleFooterCmd() tea.Msg
• func UpdateKeyMapCmd(keymap help.KeyMap) tea.Msg
• type Footer
  • func New(c common.Common, keymap help.KeyMap) *Footer
  • func (f *Footer) Height() int
  • func (f *Footer) Init() tea.Cmd
  • func (f *Footer) SetKeyMap(keymap help.KeyMap)
  • func (f *Footer) SetShowAll(show bool)
  • func (f *Footer) SetSize(width, height int)
  • func (f *Footer) ShowAll() bool
  • func (f *Footer) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (f *Footer) View() string
• type ToggleFooterMsg
• type UpdateKeyMapMsg

Functions

func ToggleFooterCmd

func ToggleFooterCmd() tea.Msg

ToggleFooterCmd sends a ToggleFooterMsg to show/hide the help footer.

func UpdateKeyMapCmd

func UpdateKeyMapCmd(keymap help.KeyMap) tea.Msg

Types

type Footer

type Footer struct {
	common.Common
	// contains filtered or unexported fields
}

Footer is a Bubble Tea model that displays help and other info.

func New

func New(c common.Common, keymap help.KeyMap) *Footer

New creates a new Footer.

func (*Footer) Height

func (f *Footer) Height() int

Height returns the height of the footer.

func (*Footer) Init

func (f *Footer) Init() tea.Cmd

Init implements tea.Model.

func (*Footer) SetKeyMap

func (f *Footer) SetKeyMap(keymap help.KeyMap)

func (*Footer) SetShowAll

func (f *Footer) SetShowAll(show bool)

SetShowAll sets whether the full help is shown.

func (*Footer) SetSize

func (f *Footer) SetSize(width, height int)

SetSize implements common.Component.

func (*Footer) ShowAll

func (f *Footer) ShowAll() bool

ShowAll returns whether the full help is shown.

func (*Footer) Update

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

Update implements tea.Model.

func (*Footer) View

func (f *Footer) View() string

View implements tea.Model.

type ToggleFooterMsg

type ToggleFooterMsg struct{}

ToggleFooterMsg is a message sent to show/hide the footer.

type UpdateKeyMapMsg

type UpdateKeyMapMsg help.KeyMap