Tooltip class

A material design tooltip.

Tooltips provide text labels that help explain the function of a button or other user interface action. Wrap the button in a Tooltip widget to show a label when the widget long pressed (or when the user takes some other appropriate action).

Many widgets, such as IconButton, FloatingActionButton, and PopupMenuButton have a tooltip property that, when non-null, causes the widget to include a Tooltip in its build.

Tooltips improve the accessibility of visual widgets by proving a textual representation of the widget, which, for example, can be vocalized by a screen reader.

See also:

Inheritance

Constructors

Tooltip({Key key, @required String message, double height: 32.0, EdgeInsetsGeometry padding: const EdgeInsets.symmetric(horizontal: 16.0), double verticalOffset: 24.0, bool preferBelow: true, bool excludeFromSemantics: false, Widget child })
Creates a tooltip. [...]
const

Properties

child Widget
The widget below this widget in the tree. [...]
final
excludeFromSemantics → bool
Whether the tooltip's message should be excluded from the semantics tree.
final
height → double
The amount of vertical space the tooltip should occupy (inside its padding).
final
message → String
The text to display in the tooltip.
final
padding EdgeInsetsGeometry
The amount of space by which to inset the child. [...]
final
preferBelow → bool
Whether the tooltip defaults to being displayed below the widget. [...]
final
verticalOffset → double
The amount of vertical distance between the widget and the displayed tooltip.
final
hashCode → int
The hash code for this object. [...]
read-only, inherited
key Key
Controls how one widget replaces another widget in the tree. [...]
final, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

createState() → _TooltipState
Creates the mutable state for this widget at a given location in the tree. [...]
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree. [...]
inherited
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children. [...]
@protected, inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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 toStringDeep. [...]
inherited
toString({DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String
Returns a string representation of this object.
inherited
toStringDeep({String prefixLineOne: '', String prefixOtherLines, DiagnosticLevel minLevel: DiagnosticLevel.debug }) → 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 ==(dynamic other) → bool
The equality operator. [...]
inherited