Add custom dialog config

Author: luiges90

lib/flutter_force_permission_config.dart

@@ -1,13 +1,17 @@
 library flutter_force_permission;
 
+import 'package:flutter/material.dart';
 import 'package:flutter_force_permission/permission_item_config.dart';
 
+typedef ShowDialogCallback = void Function(String title, String content, String buttonText, VoidCallback callback);
+
 /// Configuration for Flutter Force Permission.
 class FlutterForcePermissionConfig {
   FlutterForcePermissionConfig({
     required this.title,
     required this.confirmText,
     required this.permissionItemConfigs,
+    this.showDialogCallback,
   });
 
   /// The title for the disclosure page.
@@ -21,4 +25,16 @@ class FlutterForcePermissionConfig {
   /// The list ordering dictates the order of the permissions requested in the disclosure page and the order the OS shows the permission dialogs.
   /// See [PermissionItemConfig] for details.
   final List<PermissionItemConfig> permissionItemConfigs;
+
+  /// Optional callback to show a custom dialog. If you wish to use dialogs other than
+  /// the provided Material Design dialogs, provide a callback in this parameter.
+  /// The parameters provided to the callback consists of all the texts to be shown
+  /// as `title`, `content` and the confirm button `buttonText` respectively, as well
+  /// as a `callback` for you to call when the confirm button is clicked.
+  ///
+  /// This callback SHOULD invoke the provided `callback` in your callback to ensure proper functionality by invoking system OS settings.
+  /// The dialog shown during your callback SHOULD NOT be dismissable. It is typically
+  /// achieved by setting `barrierDismissible` to false and provide an empty callback
+  /// e.g. (`() async => false`) to `willPopCallback` for your dialog.
+  final ShowDialogCallback? showDialogCallback;
 }

lib/src/views/disclosure_page.dart

@@ -273,54 +273,53 @@ class _DisclosurePageState extends State<DisclosurePage>
     VoidCallback openSettings,
   ) async {
     final dialogConfig = permConfig.forcedPermissionDialogConfig;
-    // ignore: avoid-ignoring-return-values, not needed.
-    await showDialog(
-      context: context,
-      barrierDismissible: false,
-      builder: (context) => WillPopScope(
-        onWillPop: () async => false,
-        child: AlertDialog(
-          title: Text(
-            dialogConfig?.title ?? '',
-          ),
-          content: Text(
-            dialogConfig?.text ?? '',
-          ),
-          actions: [
-            TextButton(
-              onPressed: openSettings,
-              child: Text(
-                dialogConfig?.buttonText ?? '',
-              ),
+    final callback = widget.permissionConfig.showDialogCallback;
+
+    if (callback == null) {
+      // ignore: avoid-ignoring-return-values, not needed.
+      await showDialog(
+        context: context,
+        barrierDismissible: false,
+        builder: (context) => WillPopScope(
+          onWillPop: () async => false,
+          child: AlertDialog(
+            title: Text(
+              dialogConfig?.title ?? '',
+            ),
+            content: Text(
+              dialogConfig?.text ?? '',
             ),
-          ],
+            actions: [
+              TextButton(
+                onPressed: openSettings,
+                child: Text(
+                  dialogConfig?.buttonText ?? '',
+                ),
+              ),
+            ],
+          ),
         ),
-      ),
-    );
+      );
+    } else {
+      callback(
+        dialogConfig?.title ?? '',
+        dialogConfig?.text ?? '',
+        dialogConfig?.buttonText ?? '',
+        openSettings,
+      );
+    }
   }
 
   Future<void> _showPhoneSettings() async {
-    final navigator = Navigator.of(context);
-
     // TODO(peter): find function to open phone settings directly if possible.
     await widget._service.openAppSettings();
-
-    navigator.pop();
   }
 
   Future<void> _showLocationSettings() async {
-    final navigator = Navigator.of(context);
-
     await widget._service.openLocationSettings();
-
-    navigator.pop();
   }
 
   Future<void> _showAppSettings() async {
-    final navigator = Navigator.of(context);
-
     await widget._service.openAppSettings();
-
-    navigator.pop();
   }
 }

test/widget_test/disclosure_page_test.dart

@@ -411,4 +411,84 @@ void main() {
 
     await resumed.close();
   });
+
+  testWidgets('Required permission denied with custom dialog callback `showDialogCallback`', (tester) async {
+    final testStub = MockTestStub();
+    when(testStub.getSharedPreference())
+        .thenAnswer((realInvocation) => Future.value(prefs));
+    when(testStub.request(Permission.location))
+        .thenAnswer((realInvocation) => Future.value(PermissionStatus.denied));
+    when(testStub.status(Permission.location))
+        .thenAnswer((realInvocation) => Future.value(PermissionStatus.denied));
+    when(testStub.openAppSettings())
+        .thenAnswer((realInvocation) => Future.value());
+
+    final config = FlutterForcePermissionConfig(
+      title: 'Title',
+      confirmText: 'Confirm',
+      permissionItemConfigs: [
+        PermissionItemConfig(
+          permissions: [
+            Permission.location,
+          ],
+          itemText: PermissionItemText(
+            header: 'Foreground location',
+            rationaleText: 'Rationale',
+            forcedPermissionDialogConfig: ForcedPermissionDialogConfig(
+              title: 'Location required',
+              text: 'Location needed for proper operation',
+              buttonText: 'Settings',
+            ),
+          ),
+          required: true,
+        ),
+      ],
+      showDialogCallback: (title, text, button, callback) {
+        callback();
+      },
+    );
+    final status = <Permission, PermissionServiceStatus>{
+      Permission.location: PermissionServiceStatus(
+        status: PermissionStatus.denied,
+        requested: false,
+        serviceStatus: ServiceStatus.enabled,
+      ),
+    };
+    final StreamController<bool> resumed = StreamController.broadcast()
+      ..add(true);
+
+    await tester.pumpWidget(
+      MaterialApp(
+        home: DisclosurePage.stub(
+          permissionConfig: config,
+          permissionStatuses: status,
+          service: testStub,
+          resumed: resumed,
+        ),
+      ),
+    );
+
+    expect(find.text('Title'), findsOneWidget);
+    expect(find.text('Foreground location'), findsOneWidget);
+    expect(find.text('Rationale'), findsOneWidget);
+    expect(find.text('Confirm'), findsOneWidget);
+
+    await tester.tap(find.text('Confirm'));
+    await tester.pump();
+
+    verify(testStub.openAppSettings());
+
+    resumed.add(true);
+    await tester.pump();
+
+    when(testStub.status(Permission.location))
+        .thenAnswer((realInvocation) => Future.value(PermissionStatus.granted));
+    resumed.add(true);
+    await tester.pump();
+
+    verify(testStub.openAppSettings());
+    expect(find.text('Settings'), findsNothing);
+
+    await resumed.close();
+  });
 }