Tooltip
Provide text labels which help explain the function of a button or other user interface action.
decoration: BoxDecoration | None = field(
default_factory=lambda: BoxDecoration(
border_radius=all(4.0)
)
)
The tooltip's background decoration.
enable_feedback: bool | None = None
When True (default) the tooltip should provide acoustic and/or haptic
feedback.
For example, on Android a tap will produce a clicking sound and a long-press will produce a short vibration, when feedback is enabled.
exclude_from_semantics: bool | None = False
Whether the tooltip's message should be excluded from the semantics tree.
exit_duration: DurationValue | None = None
The length of time that the tooltip will be shown after a long press is released or a tap is released or mouse pointer exits the control.
If None, TooltipTheme.exit_duration is used.
If that's is also None, defaults to 0 milliseconds - no delay.
margin: MarginValue | None = None
The empty space that surrounds the tooltip.
If None, TooltipTheme.margin is used.
If that's is also None, defaults to Margin.all(0.0).
mouse_cursor: MouseCursor | None = None
The cursor for a mouse pointer when it enters or is hovering over the content.
padding: PaddingValue | None = None
The amount of space by which to inset the tooltip's content.
It has the following default values based on the current platform:
- On mobile platforms:
Padding.symmetric(horizontal=16.0, vertical=4.0) - On desktop platforms:
Padding.symmetric(horizontal=8.0, vertical=4.0)
prefer_below: bool | None = None
Whether the tooltip defaults to being displayed below the control.
If there is insufficient space to display the tooltip in the preferred direction, the tooltip will be displayed in the opposite direction.
If None, TooltipTheme.prefer_below is used.
If that's is also None, defaults to True.
show_duration: DurationValue | None = None
The length of time that the tooltip will be shown after a long press is released
(if triggerMode is TooltipTriggerMode.LONG_PRESS) or a tap is released
(if triggerMode is TooltipTriggerMode.TAP).
This property does not affect mouse pointer devices.
If None, TooltipTheme.show_duration is used.
If that's is also None, defaults to 1.5 seconds for long press and tap released
size_constraints: BoxConstraints | None = None
Defines the constraints on the size of this tooltip.
If None, TooltipTheme.size_constraints is used.
If that's is also None, then a default value will be picked based on the current platform:
- on desktop platforms:
BoxConstraints(min_height=24.0) - on mobile platforms:
BoxConstraints(min_height=32.0)
text_align: TextAlign | None = None
How the message of the tooltip is aligned horizontally.
If None, TooltipTheme.text_align is used.
If that's is also None, defaults to TextAlign.START.
text_style: TextStyle | None = None
The TextStyle to use for the
message of the tooltip.
trigger_mode: TooltipTriggerMode | None = None
The mode of the tooltip's trigger.
If None, TooltipTheme.trigger_mode is used.
If that's is also None, defaults to
TooltipTriggerMode.LONG_PRESS.
vertical_offset: Number | None = None
The vertical gap between the control and the displayed tooltip.
When prefer_below is set to True
and tooltips have sufficient space to
display themselves, this property defines how much vertical space
tooltips will position themselves under their corresponding controls.
Otherwise, tooltips will position themselves above their corresponding
controls with the given offset.
wait_duration: DurationValue | None = None
The length of time, in milliseconds, that a pointer must hover over a tooltip's control before the tooltip will be shown.
If None, TooltipTheme.wait_duration is used.
If that's is also None, defaults to 100 milliseconds.
Examples#
Tooltip with decoration#
import math
import flet as ft
def main(page: ft.Page):
page.add(
ft.Text("Hover to see the simple tooltip", tooltip="This is a simple tooltip"),
ft.Text(
value="Hover to see the complex tooltip",
tooltip=ft.Tooltip(
message="This is a complex tooltip",
padding=20,
text_style=ft.TextStyle(size=20, color=ft.Colors.WHITE),
decoration=ft.BoxDecoration(
border_radius=10,
gradient=ft.LinearGradient(
begin=ft.Alignment.TOP_LEFT,
end=ft.Alignment(0.8, 1),
tile_mode=ft.GradientTileMode.MIRROR,
rotation=math.pi / 3,
colors=[
"0xff1f005c",
"0xff5b0060",
"0xff870160",
"0xffac255e",
"0xffca485c",
"0xffe16b5c",
"0xfff39060",
"0xffffb56b",
],
),
),
),
),
)
ft.run(main)
