Skip to main content

Tooltip

A Material Design tooltip.

Tooltips provide text labels which help explain the function of a button or other user interface action. Wrap the button in a Tooltip control and provide a message which will be shown when the control is long pressed.

Properties

bgcolor

Background color of the tooltip.

blend_mode

The blend mode to apply when painting the tooltip.

Value is of type BlendMode.

border

Border around the tooltip.

border_radius

Tooltip's border radius.

enable_feedback

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.

enable_tap_to_dismiss

Whether the tooltip can be dismissed by tapping on it.

Defaults to True.

exclude_from_semantics

Whether the tooltip's message should be excluded from the semantics tree.

Defaults to False.

exit_duration

The length of time, in milliseconds, that the tooltip will be shown after a long press is released or a tap is released or mouse pointer exits the control.

gradient

Background gradient of the tooltip.

Value is of type Gradient.

height

The height of the tooltip's content.

image

The background image of the tooltip.

Value is of type DecorationImage.

margin

The empty space that surrounds the tooltip.

Value is of type Margin or a number.

message

The text to display in the tooltip.

padding

The amount of space by which to inset the tooltip's content.

The value is an instance of Padding class or a number.

On mobile, defaults to 16.0 logical pixels horizontally and 4.0 vertically. On desktop, defaults to 8.0 logical pixels horizontally and 4.0 vertically.

prefer_below

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.

Defaults to True.

shadow

A list of BoxShadow to cast a shadow behind the tooltip.

shape

The shape of the tooltip.

Value is of type BoxShape.

show_duration

The length of time, in milliseconds, that the tooltip will be shown after a long press is released or a tap is released or mouse pointer exits the control.

text_align

How the message of the tooltip is aligned horizontally.

Value is of type TextAlign and defaults to TextAlign.LEFT.

text_style

The TextStyle to use for the message of the tooltip.

trigger_mode

The mode of the tooltip's trigger.

Value is of type TooltipTriggerMode.

vertical_offset

The vertical gap between the control and the displayed tooltip.

wait_duration

The length of time, in milliseconds, that a pointer must hover over a tooltip's control before the tooltip will be shown.

Defaults to 0 milliseconds (tooltips are shown immediately upon hover).

Usage example

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,
border_radius=10,
text_style=ft.TextStyle(size=20, color=ft.Colors.WHITE),
gradient=ft.LinearGradient(
begin=ft.alignment.top_left,
end=ft.alignment.Alignment(0.8, 1),
colors=[
"0xff1f005c",
"0xff5b0060",
"0xff870160",
"0xffac255e",
"0xffca485c",
"0xffe16b5c",
"0xfff39060",
"0xffffb56b",
],
tile_mode=ft.GradientTileMode.MIRROR,
rotation=math.pi / 3,
),
),
),
)


ft.app(main)