Add useOverlayPortalController

README.md

@@ -358,6 +358,7 @@ A series of hooks with no particular theme.
 | [useExpansionTileController](https://api.flutter.dev/flutter/material/ExpansionTileController-class.html)                            | Creates a `ExpansionTileController`.                                                                                        |
 | [useDebounced](https://pub.dev/documentation/flutter_hooks/latest/flutter_hooks/useDebounced.html)                                   | Returns a debounced version of the provided value, triggering widget updates accordingly after a specified timeout duration |
 | [useDraggableScrollableController](https://api.flutter.dev/flutter/widgets/DraggableScrollableController-class.html)                 | Creates a `DraggableScrollableController`.                                                                                  |
+| [useOverlayPortalController](https://api.flutter.dev/flutter/widgets/OverlayPortalController-class.html)                 | Creates and manages an `OverlayPortalController` for controlling the visibility of overlay content. The controller will be automatically disposed when no longer needed.  |
 
 ## Contributions
 

packages/flutter_hooks/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased build
+
+- Added `useOverlayPortalController` (thanks to @offich)
+
 ## 0.21.1-pre.4 - 2024-08-01
 
 - Added `useFixedExtentScrollController` (thanks to @whynotmake-it)

packages/flutter_hooks/lib/src/hooks.dart

@@ -26,6 +26,7 @@ part 'keep_alive.dart';
 part 'listenable.dart';
 part 'listenable_selector.dart';
 part 'misc.dart';
+part 'overlay_portal_controller.dart';
 part 'page_controller.dart';
 part 'platform_brightness.dart';
 part 'primitives.dart';

packages/flutter_hooks/lib/src/overlay_portal_controller.dart

@@ -0,0 +1,30 @@
+part of 'hooks.dart';
+
+/// Creates a [OverlayPortalController] that will be disposed automatically.
+///
+/// See also:
+/// - [OverlayPortalController]
+OverlayPortalController useOverlayPortalController({
+  List<Object?>? keys,
+}) {
+  return use(_OverlayPortalControllerHook(keys: keys));
+}
+
+class _OverlayPortalControllerHook extends Hook<OverlayPortalController> {
+  const _OverlayPortalControllerHook({List<Object?>? keys}) : super(keys: keys);
+
+  @override
+  HookState<OverlayPortalController, Hook<OverlayPortalController>>
+      createState() => _OverlayPortalControllerHookState();
+}
+
+class _OverlayPortalControllerHookState
+    extends HookState<OverlayPortalController, _OverlayPortalControllerHook> {
+  final controller = OverlayPortalController();
+
+  @override
+  OverlayPortalController build(BuildContext context) => controller;
+
+  @override
+  String get debugLabel => 'useOverlayPortalController';
+}

packages/flutter_hooks/test/use_overlay_portal_controller_test.dart

@@ -0,0 +1,91 @@
+import 'package:flutter/foundation.dart';
+import 'package:flutter/material.dart';
+import 'package:flutter_hooks/src/framework.dart';
+import 'package:flutter_hooks/src/hooks.dart';
+
+import 'mock.dart';
+
+void main() {
+  testWidgets('debugFillProperties', (tester) async {
+    await tester.pumpWidget(
+      HookBuilder(builder: (context) {
+        useOverlayPortalController();
+        return const SizedBox();
+      }),
+    );
+
+    await tester.pump();
+
+    final element = tester.element(find.byType(HookBuilder));
+
+    expect(
+      element
+          .toDiagnosticsNode(style: DiagnosticsTreeStyle.offstage)
+          .toStringDeep(),
+      equalsIgnoringHashCodes(
+        'HookBuilder\n'
+        ' │ useOverlayPortalController: OverlayPortalController DETACHED\n'
+        ' └SizedBox(renderObject: RenderConstrainedBox#00000)\n',
+      ),
+    );
+  });
+
+  group('useOverlayPortalController', () {
+    testWidgets('initial values matches with real constructor', (tester) async {
+      late OverlayPortalController controller;
+      final controller2 = OverlayPortalController();
+
+      await tester.pumpWidget(MaterialApp(
+        home: Scaffold(
+          body: HookBuilder(builder: (context) {
+            controller = useOverlayPortalController();
+            return Column(
+              children: [
+                OverlayPortal(
+                  controller: controller,
+                  overlayChildBuilder: (context) =>
+                      const Text('Overlay Portal'),
+                ),
+                OverlayPortal(
+                  controller: controller2,
+                  overlayChildBuilder: (context) =>
+                      const Text('Overlay Portal 2'),
+                ),
+              ],
+            );
+          }),
+        ),
+      ));
+      expect(controller, isA<OverlayPortalController>());
+      expect(controller.isShowing, controller2.isShowing);
+    });
+
+    testWidgets('check show/hide of overlay portal', (tester) async {
+      late OverlayPortalController controller;
+      await tester.pumpWidget(MaterialApp(
+        home: Scaffold(
+          body: HookBuilder(builder: (context) {
+            controller = useOverlayPortalController();
+            return OverlayPortal(
+              controller: controller,
+              overlayChildBuilder: (context) => const Text('Overlay Content'),
+            );
+          }),
+        ),
+      ));
+
+      expect(controller.isShowing, false);
+      expect(find.text('Overlay Content'), findsNothing);
+
+      controller.show();
+      await tester.pump();
+      expect(controller.isShowing, true);
+      expect(find.text('Overlay Content'), findsOneWidget);
+
+      controller.hide();
+      await tester.pump();
+      expect(controller.isShowing, false);
+      expect(find.text('Overlay Content'), findsNothing);
+    });
+  });
+}