Skip to content

AlertDialog 继承自:DialogControl, AdaptiveControl, Control, BaseControl

用于向用户提示需要确认的情况。

它有一个可选的 title 和一个可选的 actions 列表。title 显示在 content 上方,actions 显示在 content 下方。

示例:

python
ft.AlertDialog(
    title=ft.Text("Session expired"),
    content=ft.Text("Please sign in again to continue."),
    actions=[ft.TextButton("Dismiss")],
    open=True,
)

示例 ​

python
import flet as ft


def main(page: ft.Page):
    page.title = "AlertDialog examples"

    dialog = ft.AlertDialog(
        title=ft.Text("Hello"),
        content=ft.Text("You are notified!"),
        alignment=ft.Alignment.CENTER,
        on_dismiss=lambda e: print("Dialog dismissed!"),
        title_padding=ft.Padding.all(25),
    )

    modal_dialog = ft.AlertDialog(
        modal=True,
        title=ft.Text("Please confirm"),
        content=ft.Text("Do you really want to delete all those files?"),
        actions=[
            ft.TextButton("Yes", on_click=lambda e: page.pop_dialog()),
            ft.TextButton("No", on_click=lambda e: page.pop_dialog()),
        ],
        actions_alignment=ft.MainAxisAlignment.END,
        on_dismiss=lambda e: print("Modal dialog dismissed!"),
    )

    page.add(
        ft.SafeArea(
            content=ft.Column(
                controls=[
                    ft.Button(
                        content="Open dialog",
                        on_click=lambda e: page.show_dialog(dialog),
                    ),
                    ft.Button(
                        content="Open modal dialog",
                        on_click=lambda e: page.show_dialog(modal_dialog),
                    ),
                ]
            )
        )
    )


if __name__ == "__main__":
    ft.run(main)
模态与非模态对话框

属性 ​

名称类型默认值说明
contentOptional[Control]None此对话框的内容,以较细的字体显示在对话框中央。 通常是一个 Column,其中包含此对话框的 Text 消息。
modalboolFalse是否可以通过点击对话框外部的区域来关闭它。
titleOptional[StrOrControl]None此对话框的标题,以较大字体显示在顶部。 通常是 Text 控件。
actionslist[Control][]显示在对话框底部的一组操作。 通常是 TextButton 控件列表。 抛出异常: ValueError:如果 title、content 和 actions 都未提供,因为对话框将没有任何内容可显示。
bgcolorOptional[ColorValue]None此对话框表面的背景色。
elevationOptional[Number]None定义此对话框出现时所处的高度(z 坐标)。
iconOptional[Control]None显示在此对话框顶部的控件。 通常是 Icon 控件。
title_paddingOptional[PaddingValue]Nonetitle 周围的内边距。 如果没有标题,则不提供内边距。否则使用此内边距。 默认在 title 的顶部、左侧和右侧使用 24 像素。如果 content 不为 None,则底部不提供内边距(见 content_padding)。如果未设置,则额外增加 20 像素的底部内边距,以将 title 与 actions 分隔开。
content_paddingOptional[PaddingValue]Nonecontent 周围的内边距。 如果没有 content,则不提供内边距。否则,在内容上方提供 20 像素的内边距,以将 content 与 title 分隔开;并在左侧、右侧和底部提供 24 像素的内边距,以将 content 与此对话框的其他边缘分隔开。
actions_paddingOptional[PaddingValue]None此对话框底部 actions 组周围的内边距。 通常用于为按钮栏提供其与对话框边缘之间的内边距。 如果没有操作,则不包含内边距。按钮栏周围的内边距默认为零。
actions_alignmentOptional[MainAxisAlignment]None定义操作的水平布局。 内部默认为 END。
shapeOptional[OutlinedBorder]None此对话框的形状。 如果为 None,则默认为 shape。如果它也为 None,则默认为 RoundedRectangleBorder(radius=4.0)。
inset_paddingOptional[PaddingValue]None此对话框自身周围的内边距。 默认为 Padding.symmetric(vertical=40, horizontal=24) —— 对话框外部水平方向 40 像素、垂直方向 24 像素。
icon_paddingOptional[PaddingValue]Noneicon 周围的内边距。
action_button_paddingOptional[PaddingValue]Noneactions 中每个按钮周围的内边距。
shadow_colorOptional[ColorValue]None用于在此对话框下方绘制投影的颜色,它反映此对话框的 elevation。
icon_colorOptional[ColorValue]None此对话框 icon 中图标的颜色。 如果为 None,则使用 icon_color。如果它也为 null,则在 use_material3 为 True 时默认为配色方案中的 secondary,否则为 Colors.BLACK。
scrollableboolFalse决定 title 和 content 控件是否包裹在可滚动区域中。 当预计 title 和 content 会溢出时使用此配置。title 和 content 都会被包裹在滚动视图中,让所有溢出的内容都能显示,同时仍然显示按钮栏。
actions_overflow_button_spacingOptional[Number]None当 actions 因水平方向放不下而使 OverflowBar 切换为列布局时,各 actions 之间的间距。 如果 actions 中的控件无法排成一行,它们会被排列成一列。当确实发生溢出时,此参数在按钮之间提供额外的垂直间距。
alignmentOptional[Alignment]None如何对齐此对话框。 如果为 None,则使用 alignment。如果它也为 None,默认为 CENTER。
content_text_styleOptional[TextStyle]None此对话框 content 中文本的样式。 如果为 None,则使用 content_text_style。如果它也为 None,则默认为 text_theme 中的 body_medium(如果 use_material3 为 True;否则为 title_medium)。
title_text_styleOptional[TextStyle]None此对话框 title 的文本样式。 如果为 None,则使用 title_text_style。如果它也为 None,默认值来自当前生效的对话框主题。
clip_behaviorClipBehaviorClipBehavior.NONE定义此对话框的内容如何根据给定的 shape 进行裁剪(或不裁剪)。
semantics_labelOptional[str]None此对话框的语义标签,供无障碍框架在此对话框打开和关闭时播报屏幕切换。 在 iOS 上,如果未提供此标签,则会从 title(如果不为 None)推断出语义标签。
barrier_colorOptional[ColorValue]None此对话框下方模态遮罩的颜色。 如果为 None,则使用 barrier_color。如果它也为 None,默认为 Colors.BLACK_54。
openboolFalse设为 True 以显示此对话框。
adaptiveOptional[bool]None启用平台特定渲染,或从父控件继承自适应能力。
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用于在更新之间保持控件标识稳定的键。

只读属性 ​

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

事件 ​

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

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