HoverBuilder class

A widget that detects mouse hover events and notifies its child. This widget is useful when you want to change the appearance of a widget when the mouse hovers over it.

Example: HoverBuilder( builder: (context, hovering, child) { return AnimatedContainer( duration: const Duration(milliseconds: 200), width: 100, height: 100, color: hovering ? Colors.orange : Colors.red, alignment: Alignment.center, child: child, ); }, child: const Text('Hover Me'), ),

Inheritance

Constructors

HoverBuilder({Key? key, required HoverWidgetBuilder builder, bool opaque = true, bool enabled = true, MouseCursor cursor = SystemMouseCursors.click, HitTestBehavior? hitTestBehavior, PointerEnterEventListener? onEnter, PointerHoverEventListener? onHover, PointerExitEventListener? onExit, Widget? child})
Creates Hoverable widget with given values.
const

Properties

builder → HoverWidgetBuilder
Builder that builds the child. This builder will be called whenever the hover state changes. The hovering parameter indicates whether the widget is currently being hovered or not.
final
child → Widget?
Child of this widget. This child will not be rebuilt when the hover state changes. It is recommended to use this child for static content that does not change when the hover state changes.
final
cursor → MouseCursor
Refers to the MouseRegion.cursor property.
final
enabled → bool
Whether the hover effect is enabled or not. If set to false, the cursor will be MouseCursor.defer and the hover effect will not be applied.
final
hashCode → int
The hash code for this object.
no setterinherited
hitTestBehavior → HitTestBehavior?
Refers to the MouseRegion.onEnter property.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onEnter → PointerEnterEventListener?
Called when a pointer enters the region. Refers to the MouseRegion.onEnter callback.
final
onExit → PointerExitEventListener?
Called when a pointer exits the region. Refers to the MouseRegion.onExit callback.
final
onHover → PointerHoverEventListener?
Called when a pointer hovers within the region. Refers to the MouseRegion.onHover callback.
final
opaque → bool
Refers to the MouseRegion.opaque property.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<HoverBuilder>
Creates the mutable state for this widget at a given location in the tree.
override
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