TooltipPlus class

A widget that displays a tooltip when triggered.

The messageWidget is the widget that will be displayed as the tooltip message.

The child is the widget that will trigger the tooltip.

The height is the height of the tooltip.

The waitDuration is the duration to wait before showing the tooltip.

The showDuration is the duration to show the tooltip.

The exitDuration is the duration to wait before hiding the tooltip when the mouse exits.

Inheritance

Constructors

TooltipPlus.new({Key? key, required Widget messageWidget, double? height, Duration? waitDuration, Duration? showDuration, Duration? exitDuration, TooltipTriggerMode? triggerMode, bool? enableFeedback, TooltipTriggeredCallback? onTriggered, required Widget child, TooltipAlignment? alignment = TooltipAlignment.rightTopOfParent, BuildTooltipOffset? buildTooltipOffset})
const

Properties

alignment TooltipAlignment?
The alignment of the tooltip relative to its parent.
final
buildTooltipOffset BuildTooltipOffset?
A function that builds the offset of the tooltip.
final
child Widget
The widget that will trigger the tooltip.
final
enableFeedback bool?
Whether to enable feedback when the tooltip is triggered.
final
exitDuration Duration?
The duration to wait before hiding the tooltip when the mouse exits.
final
hashCode int
The hash code for this object.
no setterinherited
height double?
The height of the tooltip.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
messageWidget Widget
The widget that will be displayed as the tooltip message.
final
onTriggered TooltipTriggeredCallback?
A callback that is called when the tooltip is triggered.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
showDuration Duration?
The duration to show the tooltip.
final
triggerMode TooltipTriggerMode?
The mode that will trigger the tooltip.
final
waitDuration Duration?
The duration to wait before showing the tooltip.
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<TooltipPlus>
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

Static Methods

dismissAllToolTips() bool
Dismisses all currently opened tooltips.