Skip to main content

Dismissible

A control that can be dismissed by dragging in the indicated dismiss_direction. When dragged or flung in the specified dismiss_direction, it's content smoothly slides out of view.

Examples​

Live example

Dismissible ListView Tiles​

import flet as ft

def main(page):
    page.window_height, page.window_width = 500, 400

    def close_yes_dlg(e):
        page.close_dialog()
        dlg.data.confirm_dismiss(True)

    def close_no_dlg(e):
        page.close_dialog()
        dlg.data.confirm_dismiss(False)

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

    def handle_confirm_dismiss(e: ft.DismissibleDismissEvent):
        if e.direction == ft.DismissDirection.END_TO_START: # right-to-left slide
            # save current dismissible to dialog's data
            dlg.data = e.control
            page.show_dialog(dlg)
        else: # left-to-right slide
            e.control.confirm_dismiss(True)

    def handle_dismiss(e):
        lv.controls.remove(e.control)
        page.update()

    def handle_update(e: ft.DismissibleUpdateEvent):
        print(f"Update - direction: {e.direction}, progress: {e.progress}, reached: {e.reached}, previous_reached: {e.previous_reached}")

    page.add(
        lv := ft.ListView(
            controls=[
                ft.Dismissible(
                    content=ft.ListTile(title=ft.Text(f"Item {i}")),
                    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,
                    },
                )
                for i in range(10)
            ],
            expand=True,
        )
    )


ft.app(main)

Properties​

background​

A Control that is stacked behind the content.

If secondary_background is also specified, then this control only appears when the content has been dragged down or to the right.

content​

A child Control contained by the Dismissible.

cross_axis_end_offset​

Specifies the end offset along the main axis once the card has been dismissed.

If non-zero value is given then widget moves in cross direction depending on whether it is positive or negative.

dismiss_direction​

The direction in which the control can be dismissed. Specified using the DismissDirection enum:

  • DismissDirection.NONE
  • DismissDirection.VERTICAL
  • DismissDirection.HORIZONTAL
  • DismissDirection.END_TO_START
  • DismissDirection.START_TO_END
  • DismissDirection.UP
  • DismissDirection.DOWN

dismiss_thresholds​

The offset threshold the item has to be dragged in order to be considered dismissed.

Ex: a threshold of 0.4 (the default) means that the item has to be dragged at least 40% in order for it to be dismissed.

It is specified as a dictionary where the key is of type DismissDirection and the value is the threshold(fractional/decimal value between 0.0 and 1.0).:

ft.Dismissible(
    # ...
    dismiss_thresholds={
        ft.DismissDirection.VERTICAL: 0.1,
        ft.DismissDirection.START_TO_END: 0.7
    }
)

movement_duration​

The duration for card to dismiss or to come back to original position if not dismissed.

resize_duration​

The amount of time the control will spend contracting before on_dismiss is called.

secondary_background​

A control that is stacked behind the content and is exposed when the content has been dragged up or to the left. It may only be specified when background has also been specified.

Events​

on_confirm_dismiss​

Gives the app an opportunity to confirm or veto a pending dismissal. The widget cannot be dragged again until the returned this pending dismissal is resolved.

To resolve the pending dismissal, call the confirm_dismiss(dismiss) method passing it a boolean representing the decision. If True, then the control will be dismissed, otherwise it will be moved back to its original location.

See the example at the top of this page for a possible implementation.

on_dismiss​

Fires when this control has been dismissed, after finishing resizing.

on_resize​

Fires when this control changes size, for example, when contracting before being dismissed.

on_update​

Fires when this control has been dragged.

Methods​

confirm_dismiss(dismiss: bool)​

Resolves the pending dismissal. To be called while handling the on_confirm_dismiss event.