SnackBar 继承自：DialogControl, AdaptiveControl, Control, BaseControl

一条轻量级消息，可附带一个可选操作，短暂显示在屏幕底部。

示例：

page.show_dialog(ft.SnackBar(ft.Text("Opened snack bar")))

示例

import flet as ft


def main(page: ft.Page):
    def on_click(e: ft.Event[ft.Button]):
        page.show_dialog(ft.SnackBar(ft.Text("Hello, world!")))

    page.add(ft.SafeArea(content=ft.Button("Open SnackBar", on_click=on_click)))


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

import flet as ft


class Data:
    def __init__(self) -> None:
        self.counter = 0

    def increment(self):
        self.counter += 1

    def decrement(self):
        self.counter -= 1


data = Data()


def main(page: ft.Page):
    page.title = "SnackBar Example"

    snack_bar = ft.SnackBar(
        content=ft.Text("You did it!"),
        action="Undo it!",
        on_action=lambda e: data.decrement(),
    )

    def handle_button_click(e: ft.Event[ft.Button]):
        data.increment()
        snack_bar.content.value = f"You did it x {data.counter}"
        if not snack_bar.open:
            page.show_dialog(snack_bar)
        page.update()

    page.add(
        ft.SafeArea(content=ft.Button("Open SnackBar", on_click=handle_button_click))
    )


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

import flet as ft


def main(page: ft.Page):
    def open_simple_action(e: ft.Event[ft.Button]):
        page.show_dialog(
            ft.SnackBar(
                ft.Text("The file has been deleted."),
                action="Undo",
                on_action=lambda e: print("Simple Undo clicked"),
            )
        )

    def open_custom_action(e: ft.Event[ft.Button]):
        page.show_dialog(
            ft.SnackBar(
                ft.Text("The directory has been deleted."),
                persist=False,
                action=ft.SnackBarAction(
                    label="Undo delete",
                    text_color=ft.Colors.YELLOW,
                    bgcolor=ft.Colors.BLUE,
                    on_click=lambda e: print("Custom Undo clicked"),
                ),
            )
        )

    page.add(
        ft.SafeArea(
            content=ft.Column(
                controls=[
                    ft.Button(
                        "Open SnackBar with a Simple action",
                        on_click=open_simple_action,
                    ),
                    ft.Button(
                        "Open SnackBar with a Custom action",
                        on_click=open_custom_action,
                    ),
                ]
            )
        )
    )


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

属性

名称	类型	默认值	说明
content	Annotated[StrOrControl, V.str_or_visible_control()]	必填	SnackBar 的主要内容。 通常是 Text 控件。 抛出异常： ValueError：如果它既不是字符串，也不是可见的 Control。
behavior	Optional[SnackBarBehavior]	None	定义 SnackBar 的行为和位置。 定义 SnackBar 应出现在页面中的位置，以及当页面还包含 FloatingActionButton 或 NavigationBar 时其位置应如何调整。 如果为 None，则使用 behavior。如果它也为 None，默认为 FIXED。 注意： - 如果 behavior 为 FLOATING，则条的长度由 width 和 margin 定义，并且如果两者都指定了，width 优先于 margin。 - 如果 behavior 不是 FLOATING，则忽略 width 和 margin。
dismiss_direction	Optional[DismissDirection]	None	SnackBar 可以被关闭的方向。 如果为 None，则使用 dismiss_direction。如果它也为 None，默认为 DOWN。
show_close_icon	bool	False	是否包含一个「关闭」图标部件。 点击该图标会关闭 SnackBar。
action	Union[str, SnackBarAction, None]	None	一个可选操作，用户可以基于 SnackBar 执行。 例如，SnackBar 可以让用户撤销触发该提示的操作。SnackBar 最多只能有一个操作。 该操作不应是「dismiss」或「cancel」。
close_icon_color	Optional[ColorValue]	None	关闭图标的颜色（如果 show_close_icon 为 True）。
bgcolor	Optional[ColorValue]	None	SnackBar 的背景色。
duration	DurationValue	Duration(milliseconds=4000()	此 SnackBar 应保持打开的时间。
margin	Optional[MarginValue]	None	环绕 SnackBar 的空白区域。 仅当 behavior=SnackBarBehavior.FLOATING 时生效，并且如果指定了 width 则会被忽略。
padding	Optional[PaddingValue]	None	应用于 SnackBar 内容及可选操作的内边距。
width	Optional[Number]	None	SnackBar 的宽度。 如果指定了宽度，SnackBar 将在可用空间中水平居中。 注意： 仅当 behavior 为 FLOATING 时生效。 如果指定了 margin，则不能使用它。
elevation	Annotated[Optional[Number], V.ge(0)]	None	放置 SnackBar 的 z 坐标。它控制 SnackBar 下方阴影的大小。 抛出异常： ValueError：如果它不大于或等于 0。
shape	Optional[OutlinedBorder]	None	此 SnackBar 的形状。
clip_behavior	ClipBehavior	ClipBehavior.HARD_EDGE	content 将根据此选项被裁剪（或不裁剪）。
action_overflow_threshold	Annotated[Optional[Number], V.between(0.0, 1.0)]	0.25	action 在换行到新行之前其宽度所占的百分比阈值。 如果 SnackBar 的 content 宽度大于 SnackBar 宽度减去其 action 宽度后的这个百分比，则 action 会出现在 content 下方。 值为 0.0 时，action 不会换行到新行。 抛出异常： ValueError：如果它不在 0.0 到 1.0（含）之间。
persist	Optional[bool]	None	SnackBar 是在超时后保持还是自动关闭。 如果为 True，SnackBar 即使超时后仍保持可见，直到用户点击操作按钮或关闭图标。 如果为 False，SnackBar 将在超时后关闭。 如果未提供，但 SnackBar 的 action 不为 null，则 SnackBar 也会保持显示。
open	bool	False	设为 True 以显示此对话框。
adaptive	Optional[bool]	None	启用平台特定渲染，或从父控件继承自适应能力。
expand	Annotated[Optional[Union[bool, int]], V.instance_of((bool, int))]	None	指定此控件是否／如何扩展以填满父布局中的可用空间。 更多信息见此处。 注意： 仅当此控件的直接父级是以下控件或其子类时才生效：Column、Row、View、Page。 抛出异常： ValueError：如果它不是 bool 或 int 类型。
expand_loose	bool	False	允许控件在主轴方向有可用空间时扩展，但不要求它填满所有可用空间。 更多信息见此处。 注意： 如果 expand_loose 为 True，则仅在以下条件满足时才生效： - expand 不为 None，且 - 此控件的直接父级是以下控件或其子类之一：Column、Row、View、Page。
col	ResponsiveNumber	12	如果此控件的父级是 ResponsiveRow，则此属性决定该控件在屏幕上跨越多少虚拟列。 可以是一个数字，也可以是一个按断点配置不同值的字典，例如 col={"sm": 6}。 值为 0 时会在该断点隐藏控件，因此它不会占用父级 ResponsiveRow 中的任何列。 此控件默认跨越 12 个虚拟列。 | 断点 | 尺寸 | |---|---| | xs | <576px | | sm | ≥576px | | md | ≥768px | | lg | ≥992px | | xl | ≥1200px | | xxl | ≥1400px |
opacity	Annotated[Number, V.between(0.0, 1.0)]	1.0	定义控件的透明度。 取值范围从 0.0（完全透明）到 1.0（完全不透明，无任何透明感）。 抛出异常： ValueError：如果它不在 0.0 到 1.0（含）之间。
tooltip	Optional[TooltipValue]	None	鼠标悬停在此控件上时显示的工具提示。
badge	Optional[BadgeValue]	None	显示在此控件顶部的徽章。
visible	bool	True	每个控件都有 visible 属性，默认为 True —— 控件会渲染在页面上。将 visible 设为 False 会彻底阻止控件（及其所有子控件，如果有）渲染到页面画布上。隐藏的控件无法通过键盘或鼠标获得焦点或选中，也不会触发任何事件。
disabled	bool	False	每个控件都有 disabled 属性，默认为 False —— 控件及其所有子控件都处于启用状态。 注意： 此属性的值会递归向下传播到所有子控件。 示例： 例如，如果你有一个包含多个输入控件的表单，可以通过禁用容器来一并禁用它们： python ft.Column( disabled = True, controls=[ ft.TextField(), ft.TextField() ] )
rtl	bool	False	控件的文本方向是否为从右到左（RTL）。
data	Any	skip_	任意类型的自定义数据。
key	Optional['KeyValue']	None	用于在更新之间保持控件标识稳定的键。

只读属性

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

事件

名称	类型	默认值	说明
on_action	Optional[ControlEventHandler['SnackBar']]	None	当操作按钮被点击时调用。
on_visible	Optional[ControlEventHandler['SnackBar']]	None	当 SnackBar 首次在页面中可见时调用。
on_dismiss	Optional[ControlEventHandler['DialogControl']]	None	当对话框被关闭时调用。

方法

名称	类型	默认值	说明
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 始终来自框架触发的事件，所以当此方法运行时，通道在两端都已存在。
update	None	—	为此控件请求一次 UI 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。

SnackBarAction 继承自：Control, BaseControl

一个按钮，可用作 SnackBar 中的操作。

SnackBar 的操作按钮。

注意：

• SnackBar 操作始终处于启用状态。与其禁用某个 SnackBar 操作，不如一开始就不要把它放进 SnackBar。
• SnackBar 操作只会响应第一次点击。 后续的点击／按压会被忽略。

属性

名称	类型	默认值	说明
label	str	必填	按钮的标签。
text_color	Optional[ColorValue]	None	按钮标签的颜色。 如果为 None，则使用 action_text_color。
disabled_text_color	Optional[ColorValue]	None	按钮禁用时的标签颜色。该颜色在操作被关闭后显示。
bgcolor	Optional[ColorValue]	None	按钮的背景填充色。 如果为 None，则使用 action_bgcolor。
disabled_bgcolor	Optional[ColorValue]	None	按钮禁用时的背景色。该颜色在操作被关闭后显示。 如果为 None，则使用 disabled_action_bgcolor。
expand	Annotated[Optional[Union[bool, int]], V.instance_of((bool, int))]	None	指定此控件是否／如何扩展以填满父布局中的可用空间。 更多信息见此处。 注意： 仅当此控件的直接父级是以下控件或其子类时才生效：Column、Row、View、Page。 抛出异常： ValueError：如果它不是 bool 或 int 类型。
expand_loose	bool	False	允许控件在主轴方向有可用空间时扩展，但不要求它填满所有可用空间。 更多信息见此处。 注意： 如果 expand_loose 为 True，则仅在以下条件满足时才生效： - expand 不为 None，且 - 此控件的直接父级是以下控件或其子类之一：Column、Row、View、Page。
col	ResponsiveNumber	12	如果此控件的父级是 ResponsiveRow，则此属性决定该控件在屏幕上跨越多少虚拟列。 可以是一个数字，也可以是一个按断点配置不同值的字典，例如 col={"sm": 6}。 值为 0 时会在该断点隐藏控件，因此它不会占用父级 ResponsiveRow 中的任何列。 此控件默认跨越 12 个虚拟列。 | 断点 | 尺寸 | |---|---| | xs | <576px | | sm | ≥576px | | md | ≥768px | | lg | ≥992px | | xl | ≥1200px | | xxl | ≥1400px |
opacity	Annotated[Number, V.between(0.0, 1.0)]	1.0	定义控件的透明度。 取值范围从 0.0（完全透明）到 1.0（完全不透明，无任何透明感）。 抛出异常： ValueError：如果它不在 0.0 到 1.0（含）之间。
tooltip	Optional[TooltipValue]	None	鼠标悬停在此控件上时显示的工具提示。
badge	Optional[BadgeValue]	None	显示在此控件顶部的徽章。
visible	bool	True	每个控件都有 visible 属性，默认为 True —— 控件会渲染在页面上。将 visible 设为 False 会彻底阻止控件（及其所有子控件，如果有）渲染到页面画布上。隐藏的控件无法通过键盘或鼠标获得焦点或选中，也不会触发任何事件。
disabled	bool	False	每个控件都有 disabled 属性，默认为 False —— 控件及其所有子控件都处于启用状态。 注意： 此属性的值会递归向下传播到所有子控件。 示例： 例如，如果你有一个包含多个输入控件的表单，可以通过禁用容器来一并禁用它们： python ft.Column( disabled = True, controls=[ ft.TextField(), ft.TextField() ] )
rtl	bool	False	控件的文本方向是否为从右到左（RTL）。
data	Any	skip_	任意类型的自定义数据。
key	Optional['KeyValue']	None	用于在更新之间保持控件标识稳定的键。

只读属性

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

事件

名称	类型	默认值	说明
on_click	Optional[ControlEventHandler['SnackBarAction']]	None	当此操作按钮被点击时调用。

方法

名称	类型	默认值	说明
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 始终来自框架触发的事件，所以当此方法运行时，通道在两端都已存在。
update	None	—	为此控件请求一次 UI 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。