Dismissible 继承自：LayoutControl, AdaptiveControl, Control, BaseControl

一个可以通过沿指定的 dismiss_direction 拖动来关闭的控件。 当沿指定的 dismiss_direction 拖动或轻甩时， 它的 content 会平滑地滑出视野。

滑动动画完成后，如果提供了 resize_duration， 此控件会进一步对其高度（或宽度，取决于与 dismiss_direction 垂直的维度）做动画， 在指定的 resize_duration 内逐渐将其缩减为零。

示例

import flet as ft


def main(page: ft.Page):
    async def handle_dialog_action_click(e: ft.Event[ft.TextButton]):
        page.pop_dialog()
        await dialog.data.confirm_dismiss(e.control.data)

    dialog = ft.AlertDialog(
        modal=True,
        title=ft.Text("Please confirm"),
        content=ft.Text("Do you really want to delete this item?"),
        actions=[
            ft.TextButton("Yes", data=True, on_click=handle_dialog_action_click),
            ft.TextButton("No", data=False, on_click=handle_dialog_action_click),
        ],
        actions_alignment=ft.MainAxisAlignment.CENTER,
    )

    async def handle_confirm_dismiss(e: ft.DismissibleDismissEvent):
        if e.direction == ft.DismissDirection.END_TO_START:
            dialog.data = e.control
            page.show_dialog(dialog)
        else:
            await e.control.confirm_dismiss(True)

    def handle_dismiss(e: ft.Event[ft.Dismissible]):
        e.control.parent.controls.remove(e.control)
        e.control.parent.update()

    def handle_update(e: ft.DismissibleUpdateEvent):
        print(e)

    page.add(
        ft.SafeArea(
            content=ft.ListView(
                expand=True,
                controls=[
                    ft.Dismissible(
                        dismiss_direction=ft.DismissDirection.HORIZONTAL,
                        background=ft.Container(bgcolor=ft.Colors.GREEN),
                        secondary_background=ft.Container(bgcolor=ft.Colors.RED),
                        on_dismiss=handle_dismiss,
                        on_update=handle_update,
                        on_confirm_dismiss=handle_confirm_dismiss,
                        dismiss_thresholds={
                            ft.DismissDirection.END_TO_START: 0.2,
                            ft.DismissDirection.START_TO_END: 0.2,
                        },
                        content=ft.ListTile(title=ft.Text(f"Item {i}")),
                    )
                    for i in range(10)
                ],
            ),
        )
    )


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

在组件内移除 Dismissible 的 on_dismiss

重要

在 Flet 组件内使用 Dismissible 时，请务必为其指定一个 key。

你可能遇到的问题，是 Dismissible 控件在 Flet 组件（声明式 UI）内使用时特有的。

当用户滑动（关闭）某个条目时，该 widget 在 Flutter 侧被标记为「已关闭」，实际上已从 UI 中移除。 然而，当 Flet 在 Python 侧重新计算 UI diff 时，它可能会尝试根据列表中的顺序而非身份来复用 widget。

如果没有提供 key，Flet 的 diff 算法就无法判断某个 Dismissible 对应哪个具体条目 —— 因此它会认为条目只是发生了位移。 这会导致类似这样的更新命令：

「更新条目 0…N-1 中的文本，然后删除最后一个条目（N）。」

但在 Flutter 侧，列表中间那个已被关闭的 Dismissible widget 是无法更新的 —— 它已经不存在了 —— 从而引发运行时错误。

务必为每个 Dismissible 分配一个稳定、唯一的 key，通常基于条目的标识符或索引。

import flet as ft


@ft.component
def App():
    items, set_items = ft.use_state(list(range(5)))

    return ft.SafeArea(
        content=ft.ListView(
            controls=[
                ft.Dismissible(
                    key=i,
                    dismiss_direction=ft.DismissDirection.HORIZONTAL,
                    background=ft.Container(bgcolor=ft.Colors.GREEN),
                    secondary_background=ft.Container(bgcolor=ft.Colors.RED),
                    on_dismiss=lambda _, index=i: set_items(
                        [item for item in items if item != index]
                    ),
                    dismiss_thresholds={
                        ft.DismissDirection.HORIZONTAL: 0.1,
                        ft.DismissDirection.START_TO_END: 0.1,
                    },
                    content=ft.ListTile(title=ft.Text(f"Item {i}")),
                )
                for i in items
            ],
        ),
    )


def main(page: ft.Page):
    page.render(App)


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

属性

名称	类型	默认值	说明
content	Annotated[Control, V.visible_control()]	必填	正在被关闭的控件。 抛出异常： ValueError：如果它不可见。
background	Optional[Control]	None	堆叠在 content 后面的控件。 如果还指定了 secondary_background，则此控件仅在内容被向下或向右拖动时出现。
secondary_background	Optional[Control]	None	堆叠在 content 后面、并在其被向上或向左拖动时显露出来的控件。 抛出异常： ValueError：如果它被提供且可见，但 background 未被提供且不可见。
dismiss_direction	DismissDirection	DismissDirection.HORIZONTAL	可以关闭该控件的方向。
dismiss_thresholds	dict[DismissDirection, Optional[Number]]	{}	条目需要被拖动多少才被视为已关闭的偏移阈值。它以字典形式指定，其中键为 DismissDirection 类型，值为阈值（一个介于 0.0 和 1.0（含）之间的小数值）。 示例： python ft.Dismissible( # ... dismiss_thresholds={ ft.DismissDirection.VERTICAL: 0.1, ft.DismissDirection.START_TO_END: 0.7 } )
movement_duration	DurationValue	Duration(milliseconds=200()	content 关闭，或在未被关闭时回到原始位置的时长。
resize_duration	DurationValue	Duration(milliseconds=300()	在调用 on_dismiss 之前控件收缩所花费的时间。
cross_axis_end_offset	Number	0.0	指定 content 被关闭后沿主轴的结束偏移。 如果设为非零值，则此 dismissible 会根据其正负沿交叉方向移动。
width	Optional[Number]	None	控件的强制宽度（以虚拟像素为单位）。
height	Optional[Number]	None	控件的强制高度（以虚拟像素为单位）。
left	Optional[Number]	None	子控件左边缘相对于 Stack 左侧的内缩距离。 注意： 仅当此控件是以下之一的后代时才生效： Stack 控件、overlay 列表。
top	Optional[Number]	None	子控件上边缘相对于 Stack 顶部的内缩距离。 注意： 仅当此控件是以下之一的后代时才生效： Stack 控件、overlay 列表。
right	Optional[Number]	None	子控件右边缘相对于 Stack 右侧的内缩距离。 注意： 仅当此控件是以下之一的后代时才生效： Stack 控件、overlay 列表。
bottom	Optional[Number]	None	子控件下边缘相对于 Stack 底部的内缩距离。 注意： 仅当此控件是以下之一的后代时才生效： Stack 控件、overlay 列表。
align	Optional[Alignment]	None	控件在其父级中的对齐方式。
margin	Optional[MarginValue]	None	设置控件的外边距。
rotate	Optional[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) )
scale	Optional[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) )
offset	Optional[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)
flip	Optional[Flip]	None	水平方向和/或垂直方向翻转此控件。 设为 Flip 的实例即可沿 x 轴、y 轴或两者镜像翻转。
transform	Optional[Transform]	None	对此控件应用通用矩阵变换。 设为带 Matrix4 记录的 Transform 实例，用以描述任意的变换序列。
aspect_ratio	Optional[Number]	None	控件的宽高比，定义为 width 与 height 的比值。 注意： 在当前实现中，如果设置了 aspect_ratio，同一控件上的 width 和 height 将在最终渲染尺寸中被忽略。
animate_opacity	Optional[AnimationValue]	None	启用 opacity 属性的隐式动画。 更多信息见此处。
animate_size	Optional[AnimationValue]	None	启用此控件尺寸的隐式动画。 如果设置了 width 或 height，则这些维度的变化会以动画呈现。如果两者都未设置，则对控件自然尺寸的变化进行动画。 更多信息见此处。
animate_position	Optional[AnimationValue]	None	启用定位属性（left、right、top 和 bottom）的隐式动画。 更多信息见此处。
animate_align	Optional[AnimationValue]	None	启用 align 属性的隐式动画。 更多信息见此处。
animate_margin	Optional[AnimationValue]	None	启用 margin 属性的隐式动画。 更多信息见此处。
animate_rotation	Optional[AnimationValue]	None	启用 rotate 属性的隐式动画。 更多信息见此处。
animate_scale	Optional[AnimationValue]	None	启用 scale 属性的隐式动画。 更多信息见此处。
animate_offset	Optional[AnimationValue]	None	启用 offset 属性的隐式动画。 更多信息见此处。
size_change_interval	int	10	on_size_change 事件的采样间隔（毫秒）。 设为 0 时，每次变化都会立即调用 on_size_change。
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	用于在更新之间保持控件标识稳定的键。
adaptive	Optional[bool]	None	启用平台特定渲染，或从父控件继承自适应能力。

只读属性

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

事件

名称	类型	默认值	说明
on_update	Optional[EventHandler[DismissibleUpdateEvent]]	None	当此控件被拖动时调用。
on_dismiss	Optional[EventHandler[DismissibleDismissEvent]]	None	当此控件已被关闭（在完成尺寸调整后）时调用。
on_confirm_dismiss	Optional[EventHandler[DismissibleDismissEvent]]	None	给应用一个确认或否决待处理关闭的机会。在此待处理关闭得到解决之前，此 dismissible 无法再次被拖动。 要解决待处理的关闭，请调用 confirm_dismiss 方法并传入一个表示决定的布尔值。如果为 True，则控件将被关闭，否则它将移回原始位置。
on_resize	Optional[ControlEventHandler['Dismissible']]	None	当此 dismissible 改变尺寸时调用，例如在被关闭前收缩时。
on_size_change	Optional[EventHandler[LayoutSizeChangeEvent['LayoutControl']]]	None	当此控件的尺寸发生变化时调用。 size_change_interval 定义此事件的调用频率。
on_animation_end	Optional[ControlEventHandler['LayoutControl']]	None	动画完成时调用。 可用于串联多个动画。 事件处理器参数的 data 属性包含动画名称。 更多信息见此处。

方法

名称	类型	默认值	说明
before_update	—	—	—
confirm_dismiss	—	—	解决由 on_confirm_dismiss 触发的待处理关闭决定。 在处理 on_confirm_dismiss 后，从你的确认流程中调用此方法。 参数： dismiss：True 表示继续关闭控件，False 表示取消并让它返回原始位置。
is_isolated	—	—	返回此控件是否被标记为隔离。 隔离控件会被排除在父级驱动的更新遍历之外，并需要自行管理更新边界。
init	—	—	在控件实例初始化之后、首次构建／更新周期之前调用。 重写此钩子以执行依赖已初始化字段的轻量级设置。不要在此处调用 update()。
build	—	—	在控件初始化期间调用一次，用于定义其子控件。在此方法中 page 属性可用。
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 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。