HudOverlayContent class

The visual content of a HUD overlay — barrier, optional blur, and indicator card.

Used by both HudOverlay (widget path) and the HudService bridge. You can use this widget directly if you need fine-grained control over the overlay entry lifecycle.

Inheritance

Constructors

HudOverlayContent({Key? key, required Animation<double> animation, required HudState state, required HudTheme theme, required String semanticsLabel, double? progress, String? message, String? detail, bool dismissible = false, VoidCallback? onDismiss, VoidCallback? onCancel, String cancelLabel = 'Cancel'})
Creates a HudOverlayContent.
const

Properties

animation → Animation<double>
Drives the fade-in / fade-out opacity.
final
cancelLabel → String
Label for the cancel button.
final
detail → String?
Optional secondary detail text rendered below message.
final
dismissible → bool
Whether tapping outside dismisses the overlay.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
message → String?
Optional primary message text rendered below the indicator.
final
onCancel → VoidCallback?
When non-null, a cancel button is rendered inside the card.
final
onDismiss → VoidCallback?
Called when the user taps outside (only when dismissible is true).
final
progress → double?
Deterministic progress value (0.0–1.0) or null for indeterminate.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
semanticsLabel → String
Accessibility label.
final
state → HudState
Current HudState — determines which indicator is rendered.
final
theme → HudTheme
Visual configuration.
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

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