Complete Code Walkthrough: Building a Flutter ToDo App with State Management

Every day, we juggle a myriad of tasks, deadlines, and priorities. Having a handy tool to manage them effectively can significantly boost our productivity and peace of mind. This is precisely where a Flutter ToDo App comes into play, providing a structured framework to organize our daily activities.

In this blog, we will delve into creating a Flutter ToDo App step by step, employing robust state management techniques to ensure a smooth and interactive user experience.

Not only will this todo app tutorial equip you with the practical skills to build your own Flutter ToDo App, but it will also deepen your understanding of the Flutter framework and state management principles. By the end of this journey, you'll possess a fully functional todo app that you can extend, customize, and potentially release to the world.

Understanding the Basics

What is Flutter?

Flutter is an open-source UI software development kit created by Google. It's used to develop cross-platform applications for Android, iOS, Linux, Mac, Windows, Google Fuchsia, and the web from a single codebase. The beauty of developing an app with Flutter lies in its write once, run everywhere philosophy, saving you time and resources during development.

State Management in Flutter

State management is the technique used to manage the state of an app across its different components. It's a crucial concept in Flutter, especially when developing a project like a Flutter ToDo App where you need to track the tasks' states (completed, pending, or deleted). The state of your app will determine what the UI displays at any moment, allowing for dynamic and responsive app behavior.

Setting Up the Development Environment

Before we embark on creating your first Flutter ToDo App, we need to set up our development environment. Begin by installing the Flutter SDK, and make sure to choose a preferred code editor—a popular choice is Visual Studio Code for its robust Flutter support.

Initialize your new Flutter project by opening your command line tool of choice, navigating to the folder where you want to create your project, and run the following command:

Copy
flutter create todo_app

This command creates a new Flutter project with all the necessary boilerplate code to kickstart your todo app Flutter development.

Designing the Task Class

Crafting a Task Model

A task class serves as a blueprint for the tasks in our app. Define this class by specifying properties such as final String title to maintain the task’s description, final String id for unique identification, and bool completed to track the task's completion status. This modularity and clarity will aid in managing tasks efficiently.

Inside your Flutter ToDo App project, create a new file called 'task.dart', and define your task class as follows:

Here, toggleCompleted is an instance method providing task functionality to mark a task as complete or incomplete.

Creating the User Interface

Building a Simple ToDo App Layout

Now, let's craft the user interface for our simple todo app. We want an interface that is clean and intuitive, allowing users to input new tasks and view a list of existing tasks easily.

Open your main.dart file and define your main application widget. Use a StatefulWidget since our UI will change dynamically based on the user interactions. The build method should return a Scaffold widget that provides the basic material design visual layout structure.

In the build method, start by defining a FloatingActionButton which users will interact with to add new tasks. Inside your Scaffold, let's also add an AppBar for the title and a ListView.builder that will be used to display the list of tasks.

Here's an example of what the code could look like inside the StatefulWidget:

Inside addNewTask, we're adding a new task to our task list and calling setState to tell Flutter that it needs to rebuild the UI with the new task added. The buildTaskItem function returns a ListTile widget for each task item, providing a title and changeable leading icon to depict the task's completion status.

Progress till now:

Next, let's enhance our simple todo app by adding a dialog box where users can input task titles for their new tasks.

Implementing State Management

State management will ensure that when we add, update, or delete a task, the UI reflects these changes consistently. Since we're holding the state within the _ToDoAppState class, our StatefulWidget takes care of its state management.

Each time a task is added or toggled, we invoke setState, triggering a rebuild of the Widget and updating the visual elements to reflect the current state.

Here is a simple example of how this state is managed when a user wants to add a new task:

When the add button is pressed, the startAddNewTask function displays an alert dialog box with a text field, allowing users to type in their task's title. Once confirmed, addNewTask is invoked, the task is added, and the dialog box is closed.

Adding Functionality to the ToDo App

Having set the stage for our state management, we are at the most exciting part: adding functionality.

Creating New Tasks

Create a method called _showAddTaskDialog and call it when the FloatingActionButton is pressed:

In the _showAddTaskDialog method, simply use the showDialog function with the AlertDialog widget incorporating a TextField, as demonstrated in the state management section.

Progress till now:

Displaying the List of Tasks

By now, the basic structure to add and display tasks in our Flutter ToDo App is ready. But let's make viewing tasks a bit more interactive. The ability to discern completed tasks from pending ones is crucial for any simple todo app.

Extend the _buildTaskItem widget with some additional UI to visually indicate the task completion state:

The Card widget wraps our ListTile adding a nice elevation effect and some margins. Completed tasks are styled with TextDecoration.lineThrough, and we use distinct icons to represent different task states. The ability to delete tasks is introduced with a trailing IconButton that calls setState to update our todo list.

Progress till now:

Updating Task Status

The onTap method of ListTile toggles the completion status of a task. This change affects the representation of the task within the list, thanks to the toggleCompleted method defined in our task class.

Deleting Tasks

The trailing IconButton on each ListTile listens for a press event to execute its deletion logic. When the button is pressed, the corresponding task is removed from the task array using the removeAt method, followed by a call to setState to update the UI.

Since the user might accidentally delete a task, let's provide a way to undo this operation. To do this, incorporate a SnackBar that temporarily appears on deletion and offers an undo action:

And replace the onPressed action within the delete button with a call to _deleteTask(index).

Progress till now:

Enhancing the User Experience

User interaction doesn't stop at just adding, checking off, and removing tasks. Subtle feedback mechanisms and animations can greatly enhance the overall experience.

One way to do this is by adding a simple animation to the task list when a task's completion state changes. Flutter's AnimatedList widget can be a good choice for it.

With _listKey.currentState?.insertItem and removeItem, the list animates the addition and deletion of items.

Additionally, consider incorporating haptic feedback when performing sensitive operations. For instance, upon deleting a task, providing a physical sensation can confirm the user's action:

Progress till now:

Persisting ToDo List State

Storing our todo list items is crucial for a real-world application. While there are various ways to persist data in a Flutter App, such as using a local database or a REST API, we're going to use simple file storage for demonstration purposes.

Use the path_provider plugin to locate the correct local path and write your tasks to a file. You can do this in simple JSON format for easy retrieval and manipulation.

Run flutter pub get in your terminal to install it. Then, create methods to read and write your todo items to a file:

Add the below code to your previously created 'task.dart' file:

After adding JSON serialization to your Task class, you can update your _ToDoAppState to read from the file when the app launches and to write to it whenever tasks are added or removed:

By now, you've added persistent state management to your Flutter ToDo App. Tasks added will be there when the user returns, and completed and deleted tasks will be reflected accurately.

Final app output:

Debugging and Testing

Building a robust Flutter ToDo App requires thorough debugging and testing. Use Flutter's DevTools for debugging performance issues, and write unit and widget tests to verify app functionality.

Flutter's hot reload feature makes it easier to iterate on your todo app faster, allowing you to quickly test changes without restarting your app. Make sure to handle exceptions and errors gracefully to provide a better overall user experience.

Testing is crucial for ensuring that your new features work as expected. For instance, you can write a widget test to confirm tasks are added to the todo list when the add button is clicked:

Conclusion

Congratulations! You've built a complete Flutter ToDo App, complete with state management, user interaction, and data persistence. Your app lays a solid foundation on which you can build more complex real-world applications.

Consider extending your todo app Flutter with additional features like sorting, filtering, or syncing with a web server. With the skills gained from this todo app tutorial, you're now better equipped to tackle more sophisticated Flutter projects.

If you've found this tutorial helpful and want to explore more complex app development topics with Flutter, explore DhiWise blogs for Flutter. To get the complete app code I am attaching the GitHub repository . Happy coding!

class Task {
  final String id;
  final String title;
  bool completed;

  Task({required this.id, required this.title, this.completed = false});

  void toggleCompleted() {
    completed = !completed;
  }
}

class ToDoApp extends StatefulWidget {
  @override
  _ToDoAppState createState() => _ToDoAppState();
}

class _ToDoAppState extends State<ToDoApp> {
  final List<Task> _tasks = [];

  void _addNewTask(String title) {
    final newTask = Task(
      title: title,
      id: DateTime.now().toString(),
    );

    setState(() {
      _tasks.add(newTask);
    });
  }

  Widget _buildTaskItem(BuildContext context, int index) {
    return ListTile(
      title: Text(_tasks[index].title),
      leading: Icon(_tasks[index].completed ? Icons.check : Icons.circle),
      onTap: () {
        setState(() {
          _tasks[index].toggleCompleted();
        });
      },
    );
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Flutter ToDo App'),
      ),
      body: ListView.builder(
        itemBuilder: _buildTaskItem,
        itemCount: _tasks.length,
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () {
          // Add functionality to show an input dialog
        },
        tooltip: 'Add Task',
        child: Icon(Icons.add),
      ),
    );
  }
}

void main() {
  runApp(MaterialApp(
    home: ToDoApp(),
  ));
}

void _startAddNewTask(BuildContext context) {
  showDialog(
    context: context,
    builder: (ctx) {
      String taskTitle = '';
      return AlertDialog(
        title: Text('Add New Task'),
        content: TextField(
          onChanged: (value) {
            taskTitle = value;
          },
          decoration: InputDecoration(
            labelText: 'Task Title',
          ),
        ),
        actions: <Widget>[
          ElevatedButton(
            child: Text('Cancel'),
            onPressed: () {
              Navigator.of(ctx).pop();
            },
          ),
          ElevatedButton(
            child: Text('Add'),
            onPressed: () {
              if(taskTitle.isNotEmpty) {
                _addNewTask(taskTitle);
                Navigator.of(ctx).pop();
              }
            },
          ),
        ],
      );
    }
  );
}

floatingActionButton: FloatingActionButton(
  onPressed: () => _showAddTaskDialog(context),
  tooltip: 'Add Task',
  child: Icon(Icons.add),
),

Widget _buildTaskItem(BuildContext context, int index) {
  return Card(
    elevation: 4,
    margin: const EdgeInsets.symmetric(horizontal: 10, vertical: 5),
    child: ListTile(
      title: Text(
        _tasks[index].title,
        style: TextStyle(
          decoration: _tasks[index].completed ? TextDecoration.lineThrough : null
        ),
      ),
      leading: Icon(
        _tasks[index].completed ? Icons.check_circle : Icons.radio_button_unchecked,
        color: _tasks[index].completed ? Colors.green : null,
      ),
      trailing: IconButton(
        icon: Icon(Icons.delete),
        onPressed: () {
          setState(() {
            _tasks.removeAt(index);
          });
        },
      ),
      onTap: () {
        setState(() {
          _tasks[index].toggleCompleted();
        });
      },
    ),
  );
}

void _deleteTask(int index) {
  final removedTask = _tasks[index];
  setState(() {
    _tasks.removeAt(index);
  });

  ScaffoldMessenger.of(context).showSnackBar(
    SnackBar(
      content: Text('Task removed!'),
      action: SnackBarAction(
        label: 'UNDO',
        onPressed: () {
          setState(() {
            _tasks.insert(index, removedTask);
          });
        },
      ),
    ),
  );
}

// Within the _ToDoAppState class

GlobalKey<AnimatedListState> _listKey = GlobalKey();

void _addNewTask(String title) {
  // ... existing code ...
  _listKey.currentState?.insertItem(_tasks.length - 1);
}

void _deleteTask(int index) {
  // ... existing deletion logic ...
  _listKey.currentState?.removeItem(
    index,
    (context, animation) => _buildTaskItemWithAnimation(context, index, animation),
  );
}

void _deleteTask(int index) {
  // ... existing deletion logic ...
  HapticFeedback.heavyImpact();  // Trigger a haptic feedback
}

dependencies:
  flutter:
    sdk: flutter
  path_provider: ^2.1.3

import 'dart:io';
import 'dart:convert';
import 'package:path_provider/path_provider.dart';

class Storage {
  Future<String> get _localPath async {
    final directory = await getApplicationDocumentsDirectory();
    return directory.path;
  }

  Future<File> get _localFile async {
    final path = await _localPath;
    return File('$path/tasks.json');
  }

  Future<List<Task>> readTasks() async {
    try {
      final file = await _localFile;
      // Read the file
      String contents = await file.readAsString();
      List<dynamic> jsonData = jsonDecode(contents);
      return jsonData.map((item) => Task.fromJson(item)).toList();
    } catch (e) {
      // If encountering an error, return an empty list
      return [];
    }
  }

  Future<File> writeTasks(List<Task> tasks) async {
    final file = await _localFile;
    // Convert tasks to json and write to file
    String json = jsonEncode(tasks.map((task) => task.toJson()).toList());
    return file.writeAsString(json);
  }
}

// Convert a Task instance to a Map
  Map<String, dynamic> toJson() => {
    'id': id,
    'title': title,
    'completed': completed,
  };

  // Convert a Map to a Task instance
  factory Task.fromJson(Map<String, dynamic> json) => Task(
    id: json['id'] as String,
    title: json['title'] as String,
    completed: json['completed'] as bool,
  );

class _ToDoAppState extends State<ToDoApp> {
  final List<Task> _tasks = [];
  final Storage storage = Storage();

  @override
  void initState() {
    super.initState();
    storage.readTasks().then((taskList) {
      setState(() {
        _tasks.addAll(taskList);
      });
    });
  }

  void _addNewTask(String title) {
    // ... existing logic ...
    storage.writeTasks(_tasks);
  }

  void _deleteTask(int index) {
    // ... existing logic ...
    storage.writeTasks(_tasks);
  }

  // ... rest of your code ...
}

import 'package:flutter_test/flutter_test.dart';
import 'package:todo_app/main.dart';

void main() {
  testWidgets('Add task to list test', (WidgetTester tester) async {
    await tester.pumpWidget(ToDoApp());

    // Enter 'Test Task' into the TextField widget
    await tester.enterText(find.byType(TextField), 'Test Task');

    // Tap the 'Add' button to add the task
    await tester.tap(find.text('Add'));

    await tester.pump(); // Rebuild the widget after the state has changed

    // Verify that the item has been added to the list
    expect(find.text('Test Task'), findsOneWidget);
  });
}