Merge pull request #86 from naoki0719:naoki0719/issue85

Added option for onValidate callback.

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [7.0.3] - 2022-07-21
+
+- Added option for onValidate callback.
+  - ⚠️There is a known bug where Secrets are not satisfied if the callback delays processing.
+
 ## [7.0.3] - 2022-07-19
 
 - Added useLandscape property.

example/lib/main.dart

@@ -1,3 +1,5 @@
+import 'dart:io';
+
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_screen_lock/flutter_screen_lock.dart';
@@ -295,6 +297,18 @@ class _MyHomePageState extends State<MyHomePage> {
               ),
               child: const Text('Disable landscape mode'),
             ),
+            ElevatedButton(
+              onPressed: () => screenLock(
+                context: context,
+                digits: 4,
+                correctString: '',
+                onValidate: (x) async {
+                  sleep(Duration(milliseconds: 500));
+                  return '1234' == x;
+                },
+              ),
+              child: const Text('Callback validation'),
+            ),
           ],
         ),
       ),

example/pubspec.lock

@@ -47,7 +47,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "7.0.3"
+    version: "7.0.4"
   intl:
     dependency: transitive
     description:

lib/src/functions.dart

@@ -31,6 +31,7 @@ import 'package:flutter_screen_lock/flutter_screen_lock.dart';
 /// - `withBlur`: Blur the background
 /// - `secretsBuilder`: Custom secrets animation widget builder
 /// - `useLandscape`: Use a landscape orientation. Default `true`
+/// - `onValidate`: Callback to validate input values filled in [digits].
 Future<void> screenLock({
   required BuildContext context,
   required String correctString,
@@ -60,6 +61,7 @@ Future<void> screenLock({
   bool withBlur = true,
   SecretsBuilderCallback? secretsBuilder,
   bool useLandscape = true,
+  ValidationCallback? onValidate,
 }) async {
   return Navigator.push<void>(
     context,
@@ -96,6 +98,7 @@ Future<void> screenLock({
           withBlur: withBlur,
           secretsBuilder: secretsBuilder,
           useLandscape: useLandscape,
+          onValidate: onValidate,
         ),
       ),
       transitionsBuilder: (context, animation, secondaryAnimation, child) =>

lib/src/input_controller.dart

@@ -1,13 +1,15 @@
 import 'dart:async';
 
 import 'package:flutter/material.dart';
+import 'package:flutter_screen_lock/flutter_screen_lock.dart';
 
 class InputController {
   InputController();
 
   late int _digits;
   late String _correctString;
   late bool _isConfirmed;
+  late ValidationCallback? _validationCallback;
 
   final List<String> _currentInputs = [];
 
@@ -91,6 +93,15 @@ class InputController {
       correctString = _correctString;
     }
 
+    if (_validationCallback == null) {
+      _localValidation(inputText, correctString);
+    } else {
+      _validationCallback!(inputText)
+          .then((success) => _verifyController.add(success));
+    }
+  }
+
+  void _localValidation(String inputText, String correctString) {
     if (inputText == correctString) {
       _verifyController.add(true);
     } else {
@@ -99,18 +110,19 @@ class InputController {
   }
 
   /// Create each stream.
-  void initialize({
-    required int digits,
-    required String correctString,
-    bool isConfirmed = false,
-  }) {
+  void initialize(
+      {required int digits,
+      required String correctString,
+      bool isConfirmed = false,
+      ValidationCallback? onValidate}) {
     _inputValueNotifier = ValueNotifier<String>('');
     _verifyController = StreamController.broadcast();
     _confirmedController = StreamController.broadcast();
 
     _digits = digits;
     _correctString = correctString;
     _isConfirmed = isConfirmed;
+    _validationCallback = onValidate;
   }
 
   /// Close all streams.

lib/src/screen_lock.dart

@@ -17,6 +17,10 @@ typedef SecretsBuilderCallback = Widget Function(
   Stream<bool> verifyStream,
 );
 
+typedef ValidationCallback = Future<bool> Function(
+  String input,
+);
+
 class ScreenLock extends StatefulWidget {
   const ScreenLock({
     Key? key,
@@ -46,6 +50,7 @@ class ScreenLock extends StatefulWidget {
     this.withBlur = true,
     this.secretsBuilder,
     this.useLandscape = true,
+    this.onValidate,
   })  : title = title ?? const Text('Please enter passcode.'),
         confirmTitle =
             confirmTitle ?? const Text('Please enter confirm passcode.'),
@@ -139,6 +144,11 @@ class ScreenLock extends StatefulWidget {
   /// Use a landscape orientation.
   final bool useLandscape;
 
+  /// Callback to validate input values filled in [digits].
+  ///
+  /// If `true` is returned, the lock is unlocked.
+  final ValidationCallback? onValidate;
+
   @override
   State<ScreenLock> createState() => _ScreenLockState();
 }
@@ -272,6 +282,7 @@ class _ScreenLockState extends State<ScreenLock> {
       correctString: widget.correctString,
       digits: widget.digits,
       isConfirmed: widget.confirmation,
+      onValidate: widget.onValidate,
     );
 
     inputController.verifyInput.listen((success) {
@@ -303,8 +314,15 @@ class _ScreenLockState extends State<ScreenLock> {
 
   @override
   Widget build(BuildContext context) {
-    final secretLength =
-        widget.confirmation ? widget.digits : widget.correctString.length;
+    late final int secretLength;
+
+    if (widget.confirmation) {
+      secretLength = widget.digits;
+    } else {
+      secretLength = widget.correctString.isNotEmpty
+          ? widget.correctString.length
+          : widget.digits;
+    }
 
     final orientations = <Orientation, Axis>{
       Orientation.portrait: Axis.vertical,

pubspec.yaml

@@ -1,7 +1,7 @@
 name: flutter_screen_lock
 description: Provides the ability to lock the screen on ios and android. Biometric authentication can be used in addition to passcode.
 homepage: https://github.com/naoki0719/flutter_screen_lock
-version: 7.0.3
+version: 7.0.4
 
 environment:
   sdk: ">=2.17.0-0 <3.0.0"