Dismissible for swipe actions in Flutter

Introduction

Dismissible lets users swipe to remove items from a list. It makes apps feel interactive and easy to use.

You want users to delete emails by swiping left or right.

You have a to-do list and want users to remove tasks quickly.

You want to confirm actions by swiping on notifications.

You want to add fun swipe gestures to clear items in a shopping cart.

Syntax

Flutter

Dismissible(
  key: Key('unique_key'),
  onDismissed: (direction) {
    // action when dismissed
  },
  child: WidgetToDismiss,
)

The key must be unique to identify the widget.

onDismissed runs when the user finishes the swipe.

Examples

Basic dismissible with a print action on swipe.

Flutter

Dismissible(
  key: Key('item1'),
  onDismissed: (direction) {
    print('Item dismissed');
  },
  child: ListTile(title: Text('Swipe me')),
)

Adds a red background visible while swiping.

Flutter

Dismissible(
  key: Key('item2'),
  background: Container(color: Colors.red),
  onDismissed: (direction) {
    // Remove item from list
  },
  child: ListTile(title: Text('Swipe to delete')),
)

Sample App

This app shows a list of 5 items. Swipe left or right on any item to remove it. A red background with a trash icon appears while swiping. After dismissal, a message appears at the bottom.

Flutter

import 'package:flutter/material.dart';

void main() => runApp(const MyApp());

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: const Text('Dismissible Demo')),
        body: const DismissibleList(),
      ),
    );
  }
}

class DismissibleList extends StatefulWidget {
  const DismissibleList({super.key});

  @override
  State<DismissibleList> createState() => _DismissibleListState();
}

class _DismissibleListState extends State<DismissibleList> {
  final List<String> items = List<String>.generate(5, (i) => 'Item ${i + 1}');

  @override
  Widget build(BuildContext context) {
    return ListView.builder(
      itemCount: items.length,
      itemBuilder: (context, index) {
        final item = items[index];
        return Dismissible(
          key: Key(item),
          background: Container(color: Colors.red, alignment: Alignment.centerLeft, padding: const EdgeInsets.only(left: 20), child: const Icon(Icons.delete, color: Colors.white)),
          secondaryBackground: Container(color: Colors.red, alignment: Alignment.centerRight, padding: const EdgeInsets.only(right: 20), child: const Icon(Icons.delete, color: Colors.white)),
          onDismissed: (direction) {
            setState(() {
              items.removeAt(index);
            });
            ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text('$item dismissed')));
          },
          child: ListTile(title: Text(item)),
        );
      },
    );
  }
}

Important Notes

Always provide a unique key for each Dismissible widget to avoid errors.

You can customize the swipe background using background and secondaryBackground for left and right swipes.

Use onDismissed to update your data source and UI after an item is swiped away.

Summary

Dismissible lets users swipe to remove items easily.

Provide a unique key and handle onDismissed to update your list.

Customize swipe backgrounds to improve user experience.

Practice

1. What is the main purpose of the Dismissible widget in Flutter?

easy

A. To display images in a grid layout

B. To create a button that triggers an alert

C. To allow users to swipe and remove items from a list

D. To animate text color changes

Solution

1. Step 1: Understand the widget's function

   The Dismissible widget is designed to let users swipe list items to remove them.

2. Step 2: Compare options with the widget's purpose

   Only To allow users to swipe and remove items from a list describes swiping to remove items, which matches Dismissible's role.

3. Final Answer:

   To allow users to swipe and remove items from a list -> Option C

4. Quick Check:

   Dismissible = swipe to remove [OK]

Hint: Dismissible = swipe to delete list items [OK]

Common Mistakes:

• Confusing Dismissible with buttons or animations
• Thinking it manages image layouts
• Assuming it changes text colors

2. Which of the following is the correct way to assign a unique key to a Dismissible widget?

easy

A. key: Key('item_1')

B. key: UniqueKey()

C. key: ValueKey(1)

D. All of the above

Solution

1. Step 1: Review key types for Dismissible

   Flutter requires a unique key for each Dismissible. Key, UniqueKey(), and ValueKey() are all valid ways to create unique keys.

2. Step 2: Confirm all options are valid

   Each option shows a valid key assignment method, so all are correct.

3. Final Answer:

   All of the above -> Option D

4. Quick Check:

   Any unique key type works [OK]

Hint: Any unique Key subclass works for Dismissible keys [OK]

Common Mistakes:

• Using non-unique keys like constant strings for all items
• Omitting the key parameter
• Using keys that are not unique per item

3. Given this code snippet, what happens when the user swipes the list item?

Dismissible(
  key: Key('item1'),
  onDismissed: (direction) {
    items.removeAt(0);
  },
  child: ListTile(title: Text('Item 1')),
)

medium

A. The first item is removed from the list

B. Nothing happens because the key is wrong

C. The app crashes due to missing setState

D. The item is duplicated instead of removed

Solution

1. Step 1: Understand onDismissed callback

   The onDismissed callback removes the first item from the items list when swiped.

2. Step 2: Analyze the effect of removing item at index 0

   Removing at index 0 deletes the first item, so the list updates accordingly.

3. Final Answer:

   The first item is removed from the list -> Option A

4. Quick Check:

   onDismissed removes item at index 0 [OK]

Hint: onDismissed callback removes the swiped item [OK]

Common Mistakes:

• Assuming key error prevents removal
• Forgetting to update the list state
• Thinking swipe duplicates items

4. What is wrong with this Dismissible usage?

Dismissible(
  key: Key('item'),
  onDismissed: (direction) {
    items.removeAt(index);
  },
  child: ListTile(title: Text('Item')),
)

medium

A. The key is not unique for each item

B. The onDismissed callback is missing

C. The child widget is not a ListTile

D. The index variable is not defined

Solution

1. Step 1: Check the key uniqueness

   The key is Key('item') which is constant and not unique per item, causing issues in lists.

2. Step 2: Verify other parts

   The onDismissed callback exists, child is a ListTile, and index is assumed defined, so no issues there.

3. Final Answer:

   The key is not unique for each item -> Option A

4. Quick Check:

   Keys must be unique per Dismissible [OK]

Hint: Keys must be unique strings or objects per item [OK]

Common Mistakes:

• Using same key for all items
• Ignoring key importance in lists
• Assuming onDismissed is optional

5. You want to show a red background with a trash icon when swiping a Dismissible item to the left. Which code snippet correctly implements this?

hard

A. background: Container(color: Colors.red)

B. background: Container(color: Colors.red, child: Icon(Icons.delete, color: Colors.white))

C. background: Container(color: Colors.white, child: Icon(Icons.delete, color: Colors.red))

D. background: Icon(Icons.delete, color: Colors.red)

Solution

1. Step 1: Understand background property

   The background expects a widget behind the item during swipe, usually a colored container with an icon.

2. Step 2: Check each option's correctness

   The snippet with Container(color: Colors.red, child: Icon(Icons.delete, color: Colors.white)) provides a red background with a visible white trash icon. Others lack a container, the icon, or use colors that do not produce a red background with a visible trash icon.

3. Final Answer:

   background: Container(color: Colors.red, child: Icon(Icons.delete, color: Colors.white)) -> Option B

4. Quick Check:

   Red container + white icon = correct swipe background [OK]

Hint: Use Container with color and Icon for swipe background [OK]

Common Mistakes:

• Using icon alone without container
• Wrong colors making icon invisible
• Missing icon in background