From 8bfffd4a84d83260eaa9fea12f806f206bafa9df Mon Sep 17 00:00:00 2001
From: Harsh Yadav <harshyadav5939@gmail.com>
Date: Sat, 20 Jun 2026 02:46:31 +0530
Subject: [PATCH] docs: clarify HomeViewModel lifecycle in Compass sample
 (#2838)

Adds a comment explaining why `HomeViewModel` is not disposed in the
Compass sample.

This clarifies that the current implementation is safe because the
ViewModel does not manage disposable resources. It also highlights that
in real applications, proper lifecycle management is required when
working with streams, controllers, or subscriptions.

Fixes https://github.com/flutter/samples/issues/2788

## Pre-launch Checklist

* [x] I read the [[Flutter Style
Guide](https://github.com/flutter/flutter/blob/master/docs/contributing/Style-guide-for-Flutter-repo.md)]
recently, and have followed its advice.
* [x] I signed the [[CLA](https://cla.developers.google.com/)].
* [ ] I have added sample code updates to the
[[changelog](https://chatgpt.com/c/CHANGELOG.md)].
* [x] I updated/added relevant documentation (doc comments with `///`).

<!-- Links -->

[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/master/docs/contributing/Style-guide-for-Flutter-repo.md
[CLA]: https://cla.developers.google.com/
[changelog]: ./CHANGELOG.md

---------

Co-authored-by: Eric Windmill <eric@ericwindmill.com>
---
 compass_app/app/lib/routing/router.dart       |  3 +-
 .../home/widgets/home_screen_container.dart   | 39 +++++++++++++++++++
 2 files changed, 40 insertions(+), 2 deletions(-)
 create mode 100644 compass_app/app/lib/ui/home/widgets/home_screen_container.dart

diff --git a/compass_app/app/lib/routing/router.dart b/compass_app/app/lib/routing/router.dart
index 284706850..05cad62b0 100644
--- a/compass_app/app/lib/routing/router.dart
+++ b/compass_app/app/lib/routing/router.dart
@@ -14,8 +14,7 @@ import '../ui/auth/login/widgets/login_screen.dart';
 import '../ui/auth/logout/view_models/logout_viewmodel.dart';
 import '../ui/booking/view_models/booking_viewmodel.dart';
 import '../ui/booking/widgets/booking_screen.dart';
-import '../ui/home/view_models/home_viewmodel.dart';
-import '../ui/home/widgets/home_screen.dart';
+import '../ui/home/widgets/home_screen_container.dart';
 import '../ui/results/view_models/results_viewmodel.dart';
 import '../ui/results/widgets/results_screen.dart';
 import '../ui/search_form/view_models/search_form_viewmodel.dart';
diff --git a/compass_app/app/lib/ui/home/widgets/home_screen_container.dart b/compass_app/app/lib/ui/home/widgets/home_screen_container.dart
new file mode 100644
index 000000000..c62fbc3c1
--- /dev/null
+++ b/compass_app/app/lib/ui/home/widgets/home_screen_container.dart
@@ -0,0 +1,39 @@
+import 'package:flutter/widgets.dart';
+import 'package:provider/provider.dart';
+
+import '../../../data/repositories/booking/booking_repository.dart';
+import '../../../data/repositories/user/user_repository.dart';
+import '../view_models/home_viewmodel.dart';
+import 'home_screen.dart';
+
+class HomeScreenContainer extends StatefulWidget {
+  const HomeScreenContainer({super.key});
+
+  @override
+  State<HomeScreenContainer> createState() => _HomeScreenContainerState();
+}
+
+class _HomeScreenContainerState extends State<HomeScreenContainer> {
+  late final HomeViewModel _viewModel;
+
+  @override
+  void initState() {
+    super.initState();
+
+    _viewModel = HomeViewModel(
+      bookingRepository: context.read<BookingRepository>(),
+      userRepository: context.read<UserRepository>(),
+    );
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    return HomeScreen(viewModel: _viewModel);
+  }
+
+  @override
+  void dispose() {
+    _viewModel.dispose();
+    super.dispose();
+  }
+}