Skip to main content

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

PropertyDescriptionValueDefault
messageExplanatory text shown in the tooltip. Ignored when richMessage is set.StringNot set
richMessageParses rich text and shows it as the tooltip content. When set, it takes precedence over message.StringNot set
textStyleSets the text style applied to the tooltip text.Text styleNot set
decorationSets the decoration of the tooltip background box, such as its background color and border.Background, border, and moreNot set
constraintsSets the minimum and maximum size constraints of the tooltip box.Minimum and maximum sizeNot set
paddingSets the padding around the tooltip content.Inset valueNot set
marginSets the margin between the tooltip and the edges of the screen.Inset valueNot set
verticalOffsetSets the vertical gap between the target widget and the tooltip.NumberNot set
preferBelowSets whether to show the tooltip below the target first.On / offNot set
excludeFromSemanticsSets whether to exclude the tooltip message from accessibility information.On / offOff
waitDurationSets how long to wait after the pointer hovers before the tooltip appears.DurationNot set
showDurationSets how long the tooltip stays visible after it appears.DurationNot set