HelpView class

A widget-side help view for rendering KeyMap bindings.

HelpView mirrors the two common Bubble Tea help states: a compact inline summary and a full grouped view.

class DemoKeyMap implements KeyMap {
  final quit = KeyBinding.withHelp(['q'], 'q', 'quit');
  final help = KeyBinding.withHelp(['?'], '?', 'toggle help');

  @override
  List<KeyBinding> shortHelp() => [help, quit];

  @override
  List<List<KeyBinding>> fullHelp() => [
    [help],
    [quit],
  ];
}

HelpView(keyMap: DemoKeyMap())
HelpView(keyMap: DemoKeyMap(), showAll: true)
Inheritance

Constructors

HelpView({required KeyMap keyMap, bool showAll = false, int itemSpacing = 3, int runSpacing = 1, int columnGap = 4, int rowGap = 0, Style? keyStyle, Style? descriptionStyle, Key? key})

Properties

accessibilityLabel → String?
Optional accessibility label.
no setterinherited
accessibilityRole → String
Optional accessibility role.
no setterinherited
children → List<Widget>
Child widgets that receive forwarded messages.
no setterinherited
columnGap → int
Gap between columns in the full grouped help view.
final
debugRenderObjectPassthrough → bool
Whether this widget is intentionally transparent to render-object layouts.
no setterinherited
degradationSignal → WidgetDegradationSignal
Signal that controls this widget's render budget behavior.
no setterinherited
descriptionStyle → Style?
Style override for rendered descriptions.
final
focusable → bool
Whether this widget can receive keyboard focus.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
id → String
Unique identifier for this widget.
no setterinherited
itemSpacing → int
Spacing between compact help items.
final
key → Key?
Key for preserving widget identity.
finalinherited
keyMap → KeyMap
Source of the help bindings to render.
final
keyStyle → Style?
Style override for rendered key labels.
final
rowGap → int
Gap between rows inside a full grouped help column.
final
runSpacing → int
Vertical spacing between wrapped compact help rows.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showAll → bool
Whether to render the full grouped help instead of the compact summary.
final
theme → Theme
Access the current theme.
no setterinherited

Methods

build(BuildContext context) → Widget
Describes the part of the UI represented by this widget.
override
buildCachedView<T>(T builder(), Object? cacheKey) → T
Returns a cached view if the cache key matches.
inherited
handleInit() → Cmd?
Override this instead of init for widget-specific initialization.
inherited
handleIntercept(Msg msg) → (Widget, Cmd?)
Override this to handle messages before they reach children.
inherited
handleUpdate(Msg msg) → (Widget, Cmd?)
Override this to handle messages specific to this widget.
inherited
init() → Cmd?
Called once when the widget is first mounted.
inherited
invalidateCachedView() → void
Clears any cached view for this widget.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
shouldRenderAt(DegradationLevel degradationLevel, {required bool subtreeHasFocusedWidget}) → bool
Whether this widget should participate in the current render when degradationLevel is active.
inherited
toString() → String
A string representation of this object.
inherited
update(Msg msg) → (Model, Cmd?)
Handles messages by forwarding to children then calling handleUpdate.
inherited
view() → Object
Renders the widget to a string or View.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited