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

横幅会显示一条重要而简洁的消息，并提供供用户处理（或关闭横幅）的操作。必须由用户执行操作才能将其关闭。

横幅显示在屏幕顶部、顶部应用栏下方。它们是持久且非模态的，允许用户随时忽略它们或与它们交互。

示例：

banner = ft.Banner(
    leading=ft.Icon(ft.Icons.INFO_OUTLINED, color=ft.Colors.PRIMARY),
    content=ft.Text("Backup completed successfully."),
    actions=[ft.TextButton("Dismiss")],
    bgcolor=ft.Colors.SURFACE_CONTAINER_LOW,
    open=True,
)
page.show_dialog(banner)

示例

import flet as ft


def main(page: ft.Page):
    page.horizontal_alignment = ft.CrossAxisAlignment.CENTER

    def handle_banner_close(e: ft.Event[ft.TextButton]):
        page.pop_dialog()
        page.add(ft.Text("Action clicked: " + e.control.data))

    action_button_style = ft.ButtonStyle(color=ft.Colors.BLUE)
    banner = ft.Banner(
        bgcolor=ft.Colors.AMBER_100,
        leading=ft.Icon(ft.Icons.WARNING_AMBER_ROUNDED, color=ft.Colors.AMBER, size=40),
        content=ft.Text(
            value="Oops, there were some errors while trying to delete the file. "
            "What would you like to do?",
            color=ft.Colors.BLACK,
        ),
        actions=[
            ft.TextButton(
                content="Retry",
                style=action_button_style,
                on_click=handle_banner_close,
                data="retry",
            ),
            ft.TextButton(
                content="Ignore",
                style=action_button_style,
                on_click=handle_banner_close,
                data="ignore",
            ),
            ft.TextButton(
                content="Cancel",
                style=action_button_style,
                on_click=handle_banner_close,
                data="cancel",
            ),
        ],
    )

    page.add(
        ft.SafeArea(
            content=ft.Column(
                controls=[
                    ft.Button(
                        "Show Banner", on_click=lambda e: page.show_dialog(banner)
                    )
                ]
            )
        )
    )


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

属性

名称	类型	默认值	说明
content	Annotated[StrOrControl, V.str_or_visible_control()]	必填	此横幅的内容。 通常是 Text 控件。 抛出异常： ValueError：如果 content 不可见。
actions	Annotated[list[Control], V.visible_controls(min_count=1)]	必填	显示在此横幅底部或尾部的一组操作。 通常是 TextButton 控件列表。 抛出异常： ValueError：如果它不包含至少一个可见的 Control。
leading	Optional[IconDataOrControl]	None	此横幅的前置控件。 通常是 Icon 控件。
leading_padding	Optional[PaddingValue]	None	leading 控件的内缩距离。 默认为 leading_padding，如果它为 None，则回退到 Padding.only(end=16)。
content_padding	Optional[PaddingValue]	None	content 的内缩距离。 如果操作在内容下方，默认为 Padding.only(left=16.0, top=24.0, right=16.0, bottom=4.0)。 如果操作位于 content 尾部，默认为 Padding.only(left=16.0, top=2.0)。
force_actions_below	bool	False	一种覆盖设置，用于强制 actions 位于 content 下方，无论其数量多少。 如果为 True，actions 将放置在内容下方。如果为 False，当 actions 长度为 1 时，actions 将放置在 content 的尾部；当大于 1 时，放置在 content 下方。
bgcolor	Optional[ColorValue]	None	此横幅表面的颜色。
shadow_color	Optional[ColorValue]	None	此横幅下方阴影的颜色。
divider_color	Optional[ColorValue]	None	分隔线的颜色。
elevation	Annotated[Optional[Number], V.ge(0)]	None	此横幅的高度。 抛出异常： ValueError：如果它不大于或等于 0。
margin	Optional[MarginValue]	None	环绕此横幅的空间。
content_text_style	Optional[TextStyle]	None	用于 content 中 Text 控件的样式。
min_action_bar_height	Number	52.0	操作栏的最小高度。
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_visible	Optional[ControlEventHandler['Banner']]	None	当此横幅首次显示或变为可见时调用。
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 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。