keyhints

README

Key hints

Compact footer of key-and-description pairs separated by a thin divider.

Install

glyph add key-hints

This copies key-hints.go (and its test file) into your repo at the path your glyph.json aliases declare. After install, the file is yours: edit it, refactor it, rename it. There is no key-hints library to keep in sync.

Hello, world

package main

import (
	"fmt"

	keyhints "github.com/truffle-dev/glyph/components/key-hints"
	"github.com/truffle-dev/glyph/components/theme"
)

func main() {
	hints := keyhints.New(theme.Default).
		WithHints([]keyhints.Hint{
			{Key: "Tab", Desc: "next pane"},
			{Key: "q", Desc: "quit"},
		})
	fmt.Println(hints.View())
}

API surface

Package: keyhints

API surface inferred from source — see pkg.go.dev.

Dependencies

• glyph component theme (installed automatically)
• github.com/charmbracelet/lipgloss@v1.1.0

Notes

Pure render. Build a []keyhints.Hint{{Key, Desc}, ...} from your model's current binding set; the bar lays it out left-to-right and clamps to WithWidth.

See also

• examples/showcase — single-binary TUI composing the seven main surfaces
• components/key-hints/story — runnable story binary (go run -tags glyph_story ./components/key-hints/story/)
• registry manifest — the JSON contract glyph add reads

License

MIT, same as the rest of glyph.

Documentation

Overview

Package keyhints renders a compact footer of "<key> <description>" pairs separated by a thin divider. It's the bottom-row cheatsheet almost every TUI grows into; building it as a primitive saves the same render code from being rewritten in every parent model.

Hints are pure render: there is no Update, no message. Build the hint set from your model and let key-hints lay it out.

Index

• Constants
• type Bar
  • func New(t theme.Theme) Bar
  • func (b Bar) View() string
  • func (b Bar) WithHints(hints []Hint) Bar
  • func (b Bar) WithSeparator(s string) Bar
  • func (b Bar) WithWidth(w int) Bar
• type Hint

Constants

const DefaultSeparator = "  "

Default separator placed between adjacent hints.

Types

type Bar

type Bar struct {
	// contains filtered or unexported fields
}

Bar is a row of key hints.

func New

func New(t theme.Theme) Bar

New constructs an empty hint bar.

func (Bar) View

func (b Bar) View() string

View renders the bar.

func (Bar) WithHints

func (b Bar) WithHints(hints []Hint) Bar

WithHints replaces the hint set.

func (Bar) WithSeparator

func (b Bar) WithSeparator(s string) Bar

WithSeparator overrides the inter-hint separator.

func (Bar) WithWidth

func (b Bar) WithWidth(w int) Bar

WithWidth clamps the render width. The bar truncates from the right when the natural width exceeds the clamp. Values <= 0 mean natural.

type Hint

type Hint struct {
	Key  string
	Desc string
}

Hint is one key/description pair.