Tooltip class

A hover-triggered message bubble for a child widget.

When show is omitted, the tooltip appears on mouse enter and hides on mouse exit. When an Overlay ancestor is available, the tooltip floats above the surrounding layout instead of pushing sibling widgets down. Passive hover requires MouseMode.allMotion when widgets are launched through the low-level runtime directly. The higher-level widget runners already opt into that mode by default.

Inheritance

Constructors

Tooltip({required String message, required Widget child, TooltipPosition position = TooltipPosition.above, bool? show, EdgeInsets? padding, Color? background, Color? foreground, Style? textStyle, bool enabled = true, Key? key})

Properties

accessibilityLabel → String?
Optional accessibility label.
no setterinherited
accessibilityRole → String
Optional accessibility role.
no setterinherited
background → Color?
final
child → Widget
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
degradationSignal → WidgetDegradationSignal
Signal that controls this widget's render budget behavior.
no setterinherited
enabled → bool
final
focusable → bool
Whether this widget can receive keyboard focus.
no setterinherited
foreground → Color?
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
message → String
final
padding → EdgeInsets?
final
position → TooltipPosition
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
show → bool?
final
textStyle → Style?
final
theme → Theme
Access the current theme.
no setterinherited

Methods

buildCachedView<T>(T builder(), Object? cacheKey) → T
Returns a cached view if the cache key matches.
inherited
createState() → State<StatefulWidget>
Creates the mutable State associated with this widget.
override
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