auto_disposal 0.0.2

A Flutter package that provides a mixin to automatically dispose of common resources in StatefulWidgets, reducing boilerplate and preventing memory leaks.

example/lib/main.dart

import 'dart:async';

import 'package:auto_disposal/auto_disposal.dart';
import 'package:example/second_screen.dart';
import 'package:flutter/material.dart';

void main() {
  runApp(const MyApp());
}

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

  // This widget is the root of your application.
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Auto Disposal Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
      ),
      home: const MyHomePage(title: 'Auto Disposal Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage>
    with AutoDisposalMixin<MyHomePage> {
  int _counter = 0;

  late final TextEditingController _controller = autoDispose(
    TextEditingController(),
    name: 'My Controller',
  );
  late final StreamController<int> _streamController = autoDispose(
    StreamController<int>(),
  );

  @override
  void initState() {
    super.initState();
    debugMode = true; // Enable debug mode to see registered objects in the console
  }

  void _incrementCounter() {
    _streamController.add(++_counter);
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            TextField(controller: _controller),
            StreamBuilder<int>(
              stream: _streamController.stream,
              initialData: _counter,
              builder: (context, snapshot) {
                return Text(
                  'Stream value: ${snapshot.data}',
                  style: Theme.of(context).textTheme.headlineMedium,
                );
              },
            ),
            // Navigating to second screen to test auto disposal of registered objects when the widget is disposed.
            TextButton(
              onPressed: () {
                Navigator.pushReplacement(
                  context,
                  MaterialPageRoute(builder: (context) => const SecondScreen()),
                );
              },
              child: const Text('Go to Second Screen'),
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}