StatusBar class

A horizontal bar that displays a row of KeyHint items.

Commonly used at the bottom of TUI applications to show available keyboard shortcuts. Fully themeable via StatusBarThemeData.

StatusBar(
  items: [
    KeyHint(keyLabel: 'esc', description: 'interrupt'),
    KeyHint(keyLabel: 'ctrl+p', description: 'commands'),
  ],
)

Inheritance

Constructors

StatusBar({List<Widget> items = const [], Widget? leading, Widget? trailing, Color? background, Color? foreground, EdgeInsets? padding, String? separator, int gap = 2, Key? key})

background → Color?: Background color of the bar. Defaults to StatusBarThemeData.background or Theme.surface.
final
children → List<Widget>: Child widgets that receive forwarded messages.
no setterinherited
debugRenderObjectPassthrough → bool: Whether this widget is intentionally transparent to render-object layouts.
no setterinherited
focusable → bool: Whether this widget can receive keyboard focus.
no setterinherited
foreground → Color?: Default foreground color. Defaults to StatusBarThemeData.foreground or Theme.onSurface.
final
gap → int: Gap between items when no separator is set (default: 2).
final
hashCode → int: The hash code for this object.
no setterinherited
id → String: Unique identifier for this widget.
no setterinherited
items → List<Widget>: Key hint items to display in the bar.
final
key → Key?: Key for preserving widget identity.
finalinherited
leading → Widget?: Optional widget at the start of the bar.
final
padding → EdgeInsets?: Padding inside the bar.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
separator → String?: Separator string between items (e.g., " | "). Defaults to StatusBarThemeData.separator or " " (double space).
final
theme → Theme: Access the current theme.
no setterinherited
trailing → Widget?: Optional widget at the end of the bar.
final

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
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