helpsheet

package
v0.1.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 24, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Model

type Model struct {
	Pairs   []Pair
	Dismiss string // e.g. "Press any key to dismiss"
	Styles  Styles
	Gutter  int // horizontal space between columns (default 4)
}

Model describes a two-column keybinding help sheet with an optional centered dismiss footer.

func (Model) Render

func (m Model) Render() string

Render produces the help sheet as a styled, box-wrapped string.

type Pair

type Pair struct {
	Key  string
	Desc string
}

Pair is a single key/description entry in a help sheet.

type Styles

type Styles struct {
	Key     lg.Style
	Text    lg.Style
	Dismiss lg.Style
	Box     lg.Style
}

Styles controls the appearance of the help sheet.

Jump to

Keyboard shortcuts

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