Skip to content

FloatingActionButton 继承自:LayoutControl, ActionControl, Control, BaseControl

浮动操作按钮是一个圆形图标按钮,悬浮在内容之上,用来突出应用中的主要操作。浮动操作按钮通常设置为 page.floating_action_button,但也可以作为普通控件添加到页面上的任意位置。

示例:

python
ft.FloatingActionButton(icon=ft.Icons.ADD)

示例 ​

python
import flet as ft


def main(page: ft.Page):
    page.title = "Floating Action Button"
    page.theme_mode = ft.ThemeMode.LIGHT
    page.horizontal_alignment = ft.CrossAxisAlignment.CENTER
    page.padding = 0
    page.scroll = ft.ScrollMode.HIDDEN

    count = 1

    def handle_fab_click(e: ft.Event[ft.FloatingActionButton]):
        nonlocal count
        page.add(
            ft.ListTile(
                title=ft.Text(f"Tile {count}"),
                bgcolor=ft.Colors.TEAL_300,
                leading=ft.Icon(
                    ft.Icons.CIRCLE_OUTLINED,
                    color=ft.Colors.DEEP_ORANGE_300,
                ),
                on_click=lambda x: print(x.control.title.value + " was clicked!"),
            )
        )
        page.show_dialog(ft.SnackBar(ft.Text("Tile was added successfully!")))
        count += 1

    page.floating_action_button = ft.FloatingActionButton(
        key="handling_clicks_fab",
        icon=ft.Icons.ADD,
        on_click=handle_fab_click,
        bgcolor=ft.Colors.LIME_300,
    )

    page.add(
        ft.SafeArea(
            content=ft.Column(
                controls=[
                    ft.Container(
                        bgcolor=ft.Colors.BLUE,
                        padding=ft.Padding.all(20),
                        content=ft.Row(
                            alignment=ft.MainAxisAlignment.CENTER,
                            controls=[
                                ft.Text(
                                    value="Floating Action Button Example",
                                    style=ft.TextStyle(
                                        size=20,
                                        weight=ft.FontWeight.W_500,
                                    ),
                                )
                            ],
                        ),
                    ),
                    ft.Text("Press the FAB to add a tile!"),
                ],
            ),
        )
    )


if __name__ == "__main__":
    ft.run(main)
handling-clicks

属性 ​

名称类型默认值说明
contentOptional[StrOrControl]None此按钮的内容。 抛出异常: ValueError:如果 icon 和有效的 content(字符串或可见控件)都未提供。
iconOptional[IconDataOrControl]None此按钮中显示的图标。
bgcolorOptional[ColorValue]None按钮的背景色。
shapeOptional[OutlinedBorder]NoneFAB 边框的形状。
autofocusboolFalse如果控件会被选为初始焦点,则为 True。如果页面上有多个设置了 autofocus 的控件,则最先添加到页面的那个会获得焦点。
miniboolFalse控制此按钮的尺寸。 默认情况下,浮动操作按钮为非 mini,高度和宽度为 56.0 逻辑像素。mini 浮动操作按钮的高度和宽度为 40.0 逻辑像素,布局宽度和高度为 48.0 逻辑像素。
foreground_colorOptional[ColorValue]None此按钮内图标和文本的默认前景色。
focus_colorOptional[ColorValue]None此按钮获得输入焦点时用于填充的颜色。
clip_behaviorClipBehaviorClipBehavior.NONE定义 content 的裁剪方式。
elevationAnnotated[Optional[Number], V.ge(0)]None此按钮的高度(阴影)。 默认值为 6。 抛出异常: ValueError:如果它不大于或等于 0。
disabled_elevationAnnotated[Optional[Number], V.ge(0)]None此按钮禁用时的高度(阴影)。 默认为 elevation。 抛出异常: ValueError:如果它不大于或等于 0。
focus_elevationAnnotated[Optional[Number], V.ge(0)]None此按钮获得输入焦点时的高度(阴影)。 默认值为 8。 抛出异常: ValueError:如果它不大于或等于 0。
highlight_elevationAnnotated[Optional[Number], V.ge(0)]None此按钮被高亮时的高度(阴影)。 默认值为 12。 抛出异常: ValueError:如果它不大于或等于 0。
hover_elevationAnnotated[Optional[Number], V.ge(0)]None此按钮处于启用状态且被悬停时的高度(阴影)。 默认值为 8。 抛出异常: ValueError:如果它不大于或等于 0。
hover_colorOptional[ColorValue]None此按钮被悬停时用于填充的颜色。
splash_colorOptional[ColorValue]None用于墨水扩散的颜色。
enable_feedbackOptional[bool]None检测到的手势是否应提供声音和/或触觉反馈。例如在 Android 上,将此属性设为 True 会产生点击声,长按会产生短促振动。
urlOptional[Union[str, Url]]None点击此按钮时要打开的 URL。 此外,如果提供了 on_click 事件回调,它会在其后被触发。
mouse_cursorOptional[MouseCursor]None鼠标指针进入或悬停在此控件上时要显示的光标。
widthOptional[Number]None控件的强制宽度(以虚拟像素为单位)。
heightOptional[Number]None控件的强制高度(以虚拟像素为单位)。
leftOptional[Number]None子控件左边缘相对于 Stack 左侧的内缩距离。 注意: 仅当此控件是以下之一的后代时才生效: Stack 控件、overlay 列表。
topOptional[Number]None子控件上边缘相对于 Stack 顶部的内缩距离。 注意: 仅当此控件是以下之一的后代时才生效: Stack 控件、overlay 列表。
rightOptional[Number]None子控件右边缘相对于 Stack 右侧的内缩距离。 注意: 仅当此控件是以下之一的后代时才生效: Stack 控件、overlay 列表。
bottomOptional[Number]None子控件下边缘相对于 Stack 底部的内缩距离。 注意: 仅当此控件是以下之一的后代时才生效: Stack 控件、overlay 列表。
alignOptional[Alignment]None控件在其父级中的对齐方式。
marginOptional[MarginValue]None设置控件的外边距。
rotateOptional[RotateValue]None围绕控件中心旋转来变换此控件。 rotate 属性的值可以是以下类型之一: * number —— 顺时针旋转的弧度值。整圈 360° 为 math.pi * 2 弧度,90° 为 pi / 2,45° 为 pi / 4,以此类推。 * Rotate —— 允许同时指定旋转 angle 和 alignment,即旋转中心的位置。 示例: python ft.Image( src="https://picsum.photos/100/100", width=100, height=100, border_radius=5, rotate=Rotate(angle=0.25 * pi, alignment=ft.Alignment.CENTER_LEFT) )
scaleOptional[ScaleValue]None沿二维平面缩放此控件。默认缩放因子为 1.0,表示不缩放。 例如,将此属性设为 0.5 会让控件缩小一半,而设为 2.0 则会放大一倍。 通过将 Control.scale 属性设为 Scale 类的实例,可以为 x 和 y 轴指定不同的缩放倍数。可以指定 scale,或者指定 scale_x 和 scale_y,但不能同时指定全部。 示例: python ft.Image( src="https://picsum.photos/100/100", width=100, height=100, border_radius=5, scale=ft.Scale(scale_x=2, scale_y=0.5) )
offsetOptional[OffsetValue]None在绘制控件之前应用平移变换。 平移量表示为按控件尺寸缩放的 Offset。例如,Offset(x=0.25, y=0) 会使控件沿水平方向平移其宽度的四分之一。 示例 下面的示例把容器显示在 Stack 的 0, 0 左上角,因为变换对控件应用了 -1 * 100, -1 * 100(即 offset * control's size)的水平与垂直平移: python import flet as ft def main(page: ft.Page): page.add( ft.Stack( width=1000, height=1000, controls=[ ft.Container( bgcolor=ft.Colors.RED, width=100, height=100, left=100, top=100, offset=ft.Offset(-1, -1), ) ], ) ) ft.run(main)
flipOptional[Flip]None水平方向和/或垂直方向翻转此控件。 设为 Flip 的实例即可沿 x 轴、y 轴或两者镜像翻转。
transformOptional[Transform]None对此控件应用通用矩阵变换。 设为带 Matrix4 记录的 Transform 实例,用以描述任意的变换序列。
aspect_ratioOptional[Number]None控件的宽高比,定义为 width 与 height 的比值。 注意: 在当前实现中,如果设置了 aspect_ratio,同一控件上的 width 和 height 将在最终渲染尺寸中被忽略。
animate_opacityOptional[AnimationValue]None启用 opacity 属性的隐式动画。 更多信息见此处。
animate_sizeOptional[AnimationValue]None启用此控件尺寸的隐式动画。 如果设置了 width 或 height,则这些维度的变化会以动画呈现。如果两者都未设置,则对控件自然尺寸的变化进行动画。 更多信息见此处。
animate_positionOptional[AnimationValue]None启用定位属性(left、right、top 和 bottom)的隐式动画。 更多信息见此处。
animate_alignOptional[AnimationValue]None启用 align 属性的隐式动画。 更多信息见此处。
animate_marginOptional[AnimationValue]None启用 margin 属性的隐式动画。 更多信息见此处。
animate_rotationOptional[AnimationValue]None启用 rotate 属性的隐式动画。 更多信息见此处。
animate_scaleOptional[AnimationValue]None启用 scale 属性的隐式动画。 更多信息见此处。
animate_offsetOptional[AnimationValue]None启用 offset 属性的隐式动画。 更多信息见此处。
size_change_intervalint10on_size_change 事件的采样间隔(毫秒)。 设为 0 时,每次变化都会立即调用 on_size_change。
expandAnnotated[Optional[Union[bool, int]], V.instance_of((bool, int))]None指定此控件是否/如何扩展以填满父布局中的可用空间。 更多信息见此处。 注意: 仅当此控件的直接父级是以下控件或其子类时才生效:Column、Row、View、Page。 抛出异常: ValueError:如果它不是 bool 或 int 类型。
expand_looseboolFalse允许控件在主轴方向有可用空间时扩展,但不要求它填满所有可用空间。 更多信息见此处。 注意: 如果 expand_loose 为 True,则仅在以下条件满足时才生效: - expand 不为 None,且 - 此控件的直接父级是以下控件或其子类之一:Column、Row、View、Page。
colResponsiveNumber12如果此控件的父级是 ResponsiveRow,则此属性决定该控件在屏幕上跨越多少虚拟列。 可以是一个数字,也可以是一个按断点配置不同值的字典,例如 col={"sm": 6}。 值为 0 时会在该断点隐藏控件,因此它不会占用父级 ResponsiveRow 中的任何列。 此控件默认跨越 12 个虚拟列。 | 断点 | 尺寸 | |---|---| | xs | <576px | | sm | ≥576px | | md | ≥768px | | lg | ≥992px | | xl | ≥1200px | | xxl | ≥1400px |
opacityAnnotated[Number, V.between(0.0, 1.0)]1.0定义控件的透明度。 取值范围从 0.0(完全透明)到 1.0(完全不透明,无任何透明感)。 抛出异常: ValueError:如果它不在 0.0 到 1.0(含)之间。
tooltipOptional[TooltipValue]None鼠标悬停在此控件上时显示的工具提示。
badgeOptional[BadgeValue]None显示在此控件顶部的徽章。
visibleboolTrue每个控件都有 visible 属性,默认为 True —— 控件会渲染在页面上。将 visible 设为 False 会彻底阻止控件(及其所有子控件,如果有)渲染到页面画布上。隐藏的控件无法通过键盘或鼠标获得焦点或选中,也不会触发任何事件。
disabledboolFalse每个控件都有 disabled 属性,默认为 False —— 控件及其所有子控件都处于启用状态。 注意: 此属性的值会递归向下传播到所有子控件。 示例: 例如,如果你有一个包含多个输入控件的表单,可以通过禁用容器来一并禁用它们: python ft.Column( disabled = True, controls=[ ft.TextField(), ft.TextField() ] )
rtlboolFalse控件的文本方向是否为从右到左(RTL)。
dataAnyskip_任意类型的自定义数据。
keyOptional['KeyValue']None用于在更新之间保持控件标识稳定的键。
actionOptional[Union[ClientAction, list[ClientAction]]]None当此控件被激活时由客户端执行的动作,无需往返到你的 Python 代码。 用于浏览器仅在处理用户点击时才允许的操作,例如打开文件选择器、写入剪贴板、显示分享面板或打开新标签页。见 ClientAction。

只读属性 ​

名称类型默认值说明
parentOptional['BaseControl']—此控件的直接祖先(父级)。 默认为 None,只有在此控件被挂载(加入页面树)后才有值。 Page 控件(页面树的根)是个例外 —— 它的 parent 始终为 None。
page'Page'—此控件所属的页面。

事件 ​

名称类型默认值说明
on_clickOptional[ControlEventHandler['FloatingActionButton']]None用户点击此按钮时调用。
on_size_changeOptional[EventHandler[LayoutSizeChangeEvent['LayoutControl']]]None当此控件的尺寸发生变化时调用。 size_change_interval 定义此事件的调用频率。
on_animation_endOptional[ControlEventHandler['LayoutControl']]None动画完成时调用。 可用于串联多个动画。 事件处理器参数的 data 属性包含动画名称。 更多信息见此处。

方法 ​

名称类型默认值说明
is_isolated——返回此控件是否被标记为隔离。 隔离控件会被排除在父级驱动的更新遍历之外,并需要自行管理更新边界。
init——在控件实例初始化之后、首次 build / update 周期之前调用。 重写此钩子以执行依赖已初始化字段的轻量级设置。不要在此处调用 update()。
build——在控件初始化期间调用一次,用于定义其子控件。在此方法中 page 属性可用。
before_update——每当此控件被更新时都会调用此方法。 注意: 务必不要在此处调用或请求 update()。
before_event——在事件处理器执行之前拦截事件。 返回 False 可取消分发。返回 True 或 None 则继续正常的事件处理。
did_mount——在控件挂载到页面树之后调用。 重写此方法以启动需要已挂载页面的资源,例如订阅、定时器或服务监听器。
will_unmount——在控件从页面树移除之前调用。 重写此方法以释放 did_mount() 中创建的资源,例如订阅、定时器或外部句柄。
get_data_channel——解析为此 widget 在 Dart 侧分配的 [DataChannel]。模式: on_data_channel_open: Optional[ft.EventHandler[DataChannelOpenEvent]] = None def init(self): self.on_data_channel_open = self._on_open def _on_open(self, e): self._channel = self.get_data_channel(e.channel_id) 幂等 —— 底层的 Connection 会按 id 缓存 DataChannel,因此重复调用会返回同一实例。没有错误路径:该 id 始终来自框架触发的事件,所以当此方法运行时,通道在两端都已存在。
updateNone—为此控件请求一次 UI 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。

关注我,学习大模型、大数据、Python等热门技术。