Tooltip
Overview
Show explanatory text on a long press or on hover. Hover over an icon button, for example, and it explains what the button does.
Properties
| Property | Description | Value | Default |
|---|---|---|---|
message | Explanatory text shown in the tooltip. Ignored when richMessage is set. | String | Not set |
richMessage | Parses rich text and shows it as the tooltip content. When set, it takes precedence over message. | String | Not set |
textStyle | Sets the text style applied to the tooltip text. | Text style | Not set |
decoration | Sets the decoration of the tooltip background box, such as its background color and border. | Background, border, and more | Not set |
constraints | Sets the minimum and maximum size constraints of the tooltip box. | Minimum and maximum size | Not set |
padding | Sets the padding around the tooltip content. | Inset value | Not set |
margin | Sets the margin between the tooltip and the edges of the screen. | Inset value | Not set |
verticalOffset | Sets the vertical gap between the target widget and the tooltip. | Number | Not set |
preferBelow | Sets whether to show the tooltip below the target first. | On / off | Not set |
excludeFromSemantics | Sets whether to exclude the tooltip message from accessibility information. | On / off | Off |
waitDuration | Sets how long to wait after the pointer hovers before the tooltip appears. | Duration | Not set |
showDuration | Sets how long the tooltip stays visible after it appears. | Duration | Not set |