1. Flyology TUI
  2. Components
  3. Help

Feedback

Help

Render compact key and command hints horizontally or vertically.

Generated previewCharm
Dedicated Help example rendered in the Charm skin

The site build compiles the dedicated Ada component example, constructs Help through its public API, and exports that exact styled surface. Read the capture source.

When to use it

Use help text for persistent shortcuts near the surface they affect. Keep long explanations in guide text.

State and ownership

The Flyology_TUI.Components.Help package defines this component.

Help is stateless. The caller supplies bounded bindings and explicit key and detail styles.

  • Help retains no model state.
  • The caller supplies bindings, width, orientation, and appearance for each render.

Behavior

Help renders labels only and never consumes input.

Integration sequence

  1. Create or update the caller-owned values that the renderer reads.
  2. Borrow the values and appearance required by the selected render function.
  3. Place the returned surface in the current layout. Do not route input to this component.

See the linked package reference for its exact declarations and contracts.

Responsive and accessible behavior

  • Use dimensions and regions from the current layout or presentation value.
  • Retain a glyph, label, border, or text-attribute cue when the terminal reduces color.