feat: FlyoutController.close can now return a value to the previous route. (Fixes #1246)

Author: bdlukaa

CHANGELOG.md

@@ -6,7 +6,27 @@
 - feat: Added `WindowsIcon` and `WindowsIcons` ([#1237](https://github.com/bdlukaa/fluent_ui/pull/1237))
 - fix: `Slider` label on drag ([#1248](https://github.com/bdlukaa/fluent_ui/issues/1248))
 - fix: `closeAfterClick` at the item level is no longer ignored on `DropDownButton` ([#1245](https://github.com/bdlukaa/fluent_ui/issues/1245))
+- **MINOR BREAKING** feat: `FlyoutController.close` can now return a value to the previous route. ([#1246](https://github.com/bdlukaa/fluent_ui/issues/1246))
+  Before:
+
+  ```dart
+  // normally close the flyout
+  flyoutController.close();
 
+  // forcefully close the flyout
+  flyoutController.close(true);
+  ```
+
+  After:
+
+  ```dart
+  // normally close the flyout
+  final result = flyoutController.close<String>('my result');
+
+  // forcefully close the flyout
+  flyoutController.forceClose();
+  ```
+  
 ## 4.12.0
 
 - feat: Support Flutter 3.32

lib/src/controls/flyouts/flyout.dart

@@ -877,18 +877,37 @@ class FlyoutController with ChangeNotifier, WidgetsBindingObserver {
   /// be closed. It is a good practice to close the flyout before pushing new
   /// routes.
   ///
-  /// If [force] is true, the flyout is removed from the navigator stack without
-  /// completing the transition.
-  void close([bool force = false]) {
+  /// See also:
+  ///
+  ///   * [forceClose], which forcefully closes the flyout without completing
+  ///     the transition.
+  void close<T>([T? result]) {
     _ensureAttached();
     _ensureOpen();
     if (_route == null) return; // safe for release
-    if (force) {
-      _currentNavigator!.removeRoute(_route!);
-    } else {
-      _currentNavigator!.maybePop();
-    }
+    _currentNavigator!.maybePop(result);
+    _route = _currentNavigator = null;
+  }
 
+  /// Forcefully closes the flyout.
+  ///
+  /// The flyout must be open, otherwise an error is thrown.
+  ///
+  /// If any other route is pushed above the Flyout, this route is likely to
+  /// be closed. It is a good practice to close the flyout before pushing new
+  /// routes.
+  ///
+  /// The flyout will be removed from the navigator stack without completing the
+  /// transition.
+  ///
+  /// See also:
+  ///
+  ///   * [close], which closes the flyout completing the transition.
+  void forceClose() {
+    _ensureAttached();
+    _ensureOpen();
+    if (_route == null) return; // safe for release
+    _currentNavigator!.removeRoute(_route!);
     _route = _currentNavigator = null;
   }