Documentation
¶
Index ¶
- type Builder
- func (b *Builder) Build() Model
- func (b *Builder) ShowAll(show bool) *Builder
- func (b *Builder) WithCustomHelp(customHelp [][]key.Binding) *Builder
- func (b *Builder) WithKeys(keys interface{}) *Builder
- func (b *Builder) WithSize(width, height int) *Builder
- func (b *Builder) WithTheme(t *theme.Theme) *Builder
- func (b *Builder) WithTitle(title string) *Builder
- type Model
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Builder ¶
type Builder struct {
// contains filtered or unexported fields
}
Builder provides a fluent interface for creating help models
func (*Builder) WithCustomHelp ¶
WithCustomHelp adds custom help bindings
type Model ¶
type Model struct {
Keys interface{} // Can be keymap.Base or any extended keymap
ShowAll bool
Width int
Height int
Theme *theme.Theme
CustomHelp [][]key.Binding // Additional custom key bindings to display
Title string // Title for the full help view
// contains filtered or unexported fields
}
Model represents an embeddable help component
func (*Model) SetCustomHelp ¶
SetCustomHelp sets additional custom key bindings to display
func (*Model) SetKeys ¶
func (m *Model) SetKeys(keys interface{})
SetKeys updates the keymap for the help view
func (*Model) Toggle ¶
func (m *Model) Toggle()
Toggle toggles between showing all help and short help. When showing, it recalculates content layout and resets the scroll position.
Source Files
Click to show internal directories.
Click to hide internal directories.