Documentation
¶
Overview ¶
Package help renders the keybinding overlay. The bindings are written out here by hand, so adding a key to the model means adding its row here too.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Model ¶
type Model struct {
// contains filtered or unexported fields
}
Model is the overlay's state. The mode selects which mode-specific bindings are listed and must match the mode strings the parent passes to Show.
func (*Model) IsVisible ¶
IsVisible reports whether the overlay is open, which is how the parent decides to route keys here.
func (*Model) ScrollBy ¶ added in v0.2.4
ScrollBy moves the overlay's viewport by delta rows. View clamps the result against the content it actually has, so callers may pass any delta.
func (*Model) ScrollToEnd ¶ added in v0.2.4
func (m *Model) ScrollToEnd()
ScrollToEnd jumps to the last row of the overlay.
func (*Model) ScrollToStart ¶ added in v0.2.4
func (m *Model) ScrollToStart()
ScrollToStart jumps to the first row of the overlay.
func (*Model) Show ¶
Show opens the overlay for a mode, where "Diff-Editor" and "Interactive" each add their own bindings and any other value lists only the shared ones.
Source Files