KeyHint class

A small widget that displays a keyboard shortcut key and its label.

Commonly used in status bars and help text to show available actions.

KeyHint(keyLabel: 'esc', description: 'interrupt')
KeyHint(keyLabel: 'ctrl+p', description: 'commands')
Inheritance

Constructors

KeyHint({required String keyLabel, required String description, Color? keyBackground, Color? keyForeground, Color? descriptionForeground, Style? keyStyle, Style? descriptionStyle, int gap = 1, Key? key})

Properties

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
description → String
Description of the action (e.g., "interrupt", "commands").
final
descriptionForeground → Color?
Foreground color for the description text. Defaults to Theme.muted.
final
descriptionStyle → Style?
Style override for the description text.
final
focusable → bool
Whether this widget can receive keyboard focus.
no setterinherited
gap → int
Gap between the key badge and description (default: 1).
final
hashCode → int
The hash code for this object.
no setterinherited
id → String
Unique identifier for this widget.
no setterinherited
key → Key?
Key for preserving widget identity.
finalinherited
keyBackground → Color?
Background color for the key badge. Defaults to StatusBarThemeData.keyBackground or Theme.muted.
final
keyForeground → Color?
Foreground color for the key badge text. Defaults to StatusBarThemeData.keyForeground or Theme.onSurface.
final
keyLabel → String
The key combination text (e.g., "esc", "ctrl+p", "tab").
final
keyStyle → Style?
Style override for the key badge text.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
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
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