help

package

v0.0.4 Latest Latest Go to latest Published: Mar 23, 2026 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/jongio/grut

Links

Open Source Insights

Documentation ¶

Overview ¶

Package help implements the help overlay panel for grut. It displays a scrollable keybinding cheatsheet rendered as a floating overlay on top of the main layout by the root model.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Panel ¶

type Panel struct {
	panels.BasePanel
	// contains filtered or unexported fields
}

Panel is the help overlay. It implements panels.Panel.

func New ¶

func New() *Panel

New creates a new help overlay panel.

func (*Panel) Init ¶

func (p *Panel) Init(_ context.Context) tea.Cmd

--------------------------------------------------------------------------- panels.Panel interface --------------------------------------------------------------------------- Init implements panels.Panel.

func (*Panel) KeyBindings ¶

func (p *Panel) KeyBindings() []panels.KeyBinding

KeyBindings implements panels.Panel.

func (*Panel) Update ¶

func (p *Panel) Update(msg tea.Msg) (panels.Panel, tea.Cmd)

Update implements panels.Panel.

func (*Panel) View ¶

func (p *Panel) View(width, height int) string

View implements panels.Panel. It renders the scrollable help content within the given dimensions.

Source Files ¶

View all Source files

help.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL