help

Documentation

Index

• func Lines(sections []Section) []string
• func Render(sections []Section, palette Palette, search *regexp.Regexp) string
• type Item
• type Palette
• type Section

Functions

func Lines

func Lines(sections []Section) []string

Lines returns plain text lines for searchable help content.

func Render

func Render(sections []Section, palette Palette, search *regexp.Regexp) string

Render converts help sections into styled terminal content.

Types

type Item

type Item struct {
	Key  string
	Desc string
}

Item is a single key binding and description in a help section.

type Palette

type Palette struct {
	HeaderFG string
	HeaderBG string
	KeyFG    string
	DescFG   string
	SearchFG string
	SearchBG string
}

Palette contains the colors needed to render help content.

type Section

type Section struct {
	Title string
	Items []Item
}

Section groups related help items under a title.