feat: use async steps results (#164)

Numoy · web-flow · commit 3993fb0cfd3b · 2025-11-11T09:53:40.000+01:00
* feat: use async step results

* feat: update changelog + version

* fix: update color opacity method and improve image answer view state management

* feat: update flutter deps
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,16 @@
+# 0.3.3
+
+- INFO: Updated dependencies (Flutter 3.35.6)
+- INFO: Steps are now return a Future, so you can do async operations before returning the step
+- INFO: onResult is now called after onNextStep has finished
+- FIX: Replaced deprecated `groupValue` parameter in Radio widget with RadioGroup wrapper (Flutter 3.32.0+)
+- FIX: Fixed `InputDecorationThemeData` type error in time_picker_widget.dart for compatibility with newer Flutter versions
+- FIX: Replaced deprecated `withOpacity` method with `withValues` for Color in input_decoration.dart
+
+# 0.3.2
+
+- INFO: Updated dependencies (Flutter 3.33.0)
+
 # 0.3.1
 
 - INFO: Updated dependencies (Flutter 3.32.1)
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -47,7 +47,7 @@ class _MyAppState extends State<MyApp> {
                     themeData: Theme.of(context).copyWith(
                       primaryColor: Colors.cyan,
                       appBarTheme: const AppBarTheme(
-                        color: Colors.white,
+                        backgroundColor: Colors.white,
                         iconTheme: IconThemeData(
                           color: Colors.cyan,
                         ),
diff --git a/lib/src/controller/survey_controller.dart b/lib/src/controller/survey_controller.dart
@@ -1,3 +1,5 @@
+import 'dart:async';
+
 import 'package:flutter/widgets.dart';
 import 'package:flutter_bloc/flutter_bloc.dart';
 import 'package:survey_kit/src/presenter/survey_event.dart';
@@ -15,7 +17,7 @@ class SurveyController {
   ///
   /// Returns:
   /// - `true` if the default behavior should still be executed after this function, `false` otherwise.
-  final bool Function(
+  final FutureOr<bool> Function(
     BuildContext context,
     QuestionResult Function() resultFunction,
   )? onNextStep;
@@ -56,12 +58,12 @@ class SurveyController {
     this.onCloseSurvey,
   });
 
-  void nextStep(
+  Future<void> nextStep(
     BuildContext context,
     QuestionResult Function() resultFunction,
-  ) {
+  ) async {
     if (onNextStep != null) {
-      if (!onNextStep!(context, resultFunction)) return;
+      if (!await onNextStep!(context, resultFunction)) return;
     }
     BlocProvider.of<SurveyPresenter>(context).add(
       NextStep(
diff --git a/lib/src/presenter/survey_presenter.dart b/lib/src/presenter/survey_presenter.dart
@@ -1,3 +1,5 @@
+import 'dart:async';
+
 import 'package:collection/collection.dart' show IterableExtension;
 import 'package:flutter_bloc/flutter_bloc.dart';
 import 'package:survey_kit/src/configuration/app_bar_configuration.dart';
@@ -13,7 +15,7 @@ import 'package:survey_kit/src/steps/identifier/step_identifier.dart';
 //TO DO: Extract gathering of the results into another class
 class SurveyPresenter extends Bloc<SurveyEvent, SurveyState> {
   final TaskNavigator taskNavigator;
-  final Function(SurveyResult) onResult;
+  final FutureOr<void> Function(SurveyResult) onResult;
 
   Set<QuestionResult> results = {};
   late final DateTime startDate;
@@ -22,40 +24,44 @@ class SurveyPresenter extends Bloc<SurveyEvent, SurveyState> {
     required this.taskNavigator,
     required this.onResult,
   }) : super(LoadingSurveyState()) {
-
-    on<StartSurvey>((event, emit){
-      emit(
-        _handleInitialStep()
-      );
+    on<StartSurvey>((event, emit) {
+      emit(_handleInitialStep());
     });
 
-    on<NextStep>((event, emit){
-      if (state is PresentingSurveyState){
-        emit(_handleNextStep(event, state as PresentingSurveyState));
+    on<NextStep>((event, emit) async {
+      if (state is PresentingSurveyState) {
+        final newState = _handleNextStep(event, state as PresentingSurveyState);
+        emit(newState);
+
+        // Call onResult after emitting the final state
+        if (newState is SurveyResultState) {
+          await onResult(newState.result);
+        }
       }
     });
 
-    on<StepBack>((event, emit){
-      if (state is PresentingSurveyState){
-        emit(
-          _handleStepBack(event, state as PresentingSurveyState)
-        );
+    on<StepBack>((event, emit) {
+      if (state is PresentingSurveyState) {
+        emit(_handleStepBack(event, state as PresentingSurveyState));
       }
     });
 
-    on<CloseSurvey>((event, emit){
-      if (state is PresentingSurveyState){
-        emit(
-          _handleClose(event, state as PresentingSurveyState)
-        );
+    on<CloseSurvey>((event, emit) async {
+      if (state is PresentingSurveyState) {
+        final newState = _handleClose(event, state as PresentingSurveyState);
+        emit(newState);
+
+        // Call onResult after emitting the final state
+        if (newState is SurveyResultState) {
+          await onResult(newState.result);
+        }
       }
     });
 
     this.startDate = DateTime.now();
     add(StartSurvey());
   }
 
-
   SurveyState _handleInitialStep() {
     Step? step = taskNavigator.firstStep();
     if (step != null) {
diff --git a/lib/src/survey_kit.dart b/lib/src/survey_kit.dart
@@ -1,3 +1,5 @@
+import 'dart:async';
+
 import 'package:collection/collection.dart' show IterableExtension;
 import 'package:flutter/material.dart';
 import 'package:flutter_bloc/flutter_bloc.dart';
@@ -24,7 +26,7 @@ class SurveyKit extends StatefulWidget {
   final ThemeData? themeData;
 
   /// Function which is called after the results are collected
-  final Function(SurveyResult) onResult;
+  final FutureOr<void> Function(SurveyResult) onResult;
 
   /// [SurveyController] to override the navigation methods
   /// onNextStep, onBackStep, onCloseSurvey
@@ -116,7 +118,7 @@ class _SurveyKitState extends State<SurveyKit> {
 class SurveyPage extends StatefulWidget {
   final int length;
   final Widget Function(AppBarConfiguration appBarConfiguration)? appBar;
-  final Function(SurveyResult) onResult;
+  final FutureOr<void> Function(SurveyResult) onResult;
 
   const SurveyPage({
     required this.length,
@@ -149,9 +151,6 @@ class _SurveyPageState extends State<SurveyPage>
     return BlocConsumer<SurveyPresenter, SurveyState>(
       listenWhen: (previous, current) => previous != current,
       listener: (context, state) async {
-        if (state is SurveyResultState) {
-          widget.onResult.call(state.result);
-        }
         if (state is PresentingSurveyState) {
           tabController.animateTo(state.currentStepIndex);
         }
diff --git a/lib/src/views/agreement_answer_view.dart b/lib/src/views/agreement_answer_view.dart
@@ -86,42 +86,43 @@ class _AgreementAnswerViewState extends State<AgreementAnswerView> {
                           href != null ? launchUrl(Uri.parse(href)) : null,
                     ),
                   ),
-                Row(
-                  crossAxisAlignment: CrossAxisAlignment.center,
-                  children: [
-                    Radio<BooleanResult>(
-                        groupValue: _result,
-                        value: BooleanResult.POSITIVE,
-                        onChanged: (v) {
+                RadioGroup<BooleanResult>(
+                  groupValue: _result,
+                  onChanged: (v) {
+                    setState(() {
+                      _result = v;
+                    });
+                  },
+                  child: Row(
+                    crossAxisAlignment: CrossAxisAlignment.center,
+                    children: [
+                      Radio<BooleanResult>(value: BooleanResult.POSITIVE),
+                      SizedBox(
+                        width: 16,
+                      ),
+                      Expanded(
+                          child: GestureDetector(
+                        onTap: () {
                           setState(() {
-                            _result = v;
+                            if (_result == BooleanResult.POSITIVE) {
+                              _result = BooleanResult.NEGATIVE;
+                            } else {
+                              _result = BooleanResult.POSITIVE;
+                            }
                           });
-                        }),
-                    SizedBox(
-                      width: 16,
-                    ),
-                    Expanded(
-                        child: GestureDetector(
-                      onTap: () {
-                        setState(() {
-                          if (_result == BooleanResult.POSITIVE) {
-                            _result = BooleanResult.NEGATIVE;
-                          } else {
-                            _result = BooleanResult.POSITIVE;
-                          }
-                        });
-                      },
-                      child: MarkdownBody(
-                        styleSheet: markDownStyleSheet.copyWith(
-                          p: theme.textTheme.bodySmall,
+                        },
+                        child: MarkdownBody(
+                          styleSheet: markDownStyleSheet.copyWith(
+                            p: theme.textTheme.bodySmall,
+                          ),
+                          data: _agreementAnswerFormat.markdownAgreementText ??
+                              '',
+                          onTapLink: (text, href, title) =>
+                              href != null ? launchUrl(Uri.parse(href)) : null,
                         ),
-                        data:
-                            _agreementAnswerFormat.markdownAgreementText ?? '',
-                        onTapLink: (text, href, title) =>
-                            href != null ? launchUrl(Uri.parse(href)) : null,
-                      ),
-                    )),
-                  ],
+                      )),
+                    ],
+                  ),
                 )
               ],
             ),
diff --git a/lib/src/views/decoration/input_decoration.dart b/lib/src/views/decoration/input_decoration.dart
@@ -12,15 +12,15 @@ InputDecoration textFieldInputDecoration({String hint = ''}) => InputDecoration(
           Radius.zero,
         ),
         borderSide: BorderSide(
-          color: Colors.black.withOpacity(0.2),
+          color: Colors.black.withValues(alpha: 0.2),
         ),
       ),
       enabledBorder: OutlineInputBorder(
         borderRadius: BorderRadius.all(
           Radius.zero,
         ),
         borderSide: BorderSide(
-          color: Colors.black.withOpacity(0.2),
+          color: Colors.black.withValues(alpha: 0.2),
         ),
       ),
       hintText: hint,
diff --git a/lib/src/views/widget/time_picker_widget.dart b/lib/src/views/widget/time_picker_widget.dart
@@ -270,8 +270,9 @@ class _HourMinuteControl extends StatelessWidget {
     final Color backgroundColor = timePickerTheme.hourMinuteColor ??
         WidgetStateColor.resolveWith((Set<WidgetState> states) {
           return states.contains(WidgetState.selected)
-              ? themeData.colorScheme.primary.withOpacity(isDark ? 0.24 : 0.12)
-              : themeData.colorScheme.onSurface.withOpacity(0.12);
+              ? themeData.colorScheme.primary
+                  .withValues(alpha: isDark ? 0.24 : 0.12)
+              : themeData.colorScheme.onSurface.withValues(alpha: 0.12);
         });
     final TextStyle style = timePickerTheme.hourMinuteTextStyle ??
         themeData.textTheme.displayMedium!;
@@ -542,7 +543,7 @@ class _DayPeriodControl extends StatelessWidget {
         WidgetStateColor.resolveWith((Set<WidgetState> states) {
           return states.contains(WidgetState.selected)
               ? colorScheme.primary
-              : colorScheme.onSurface.withOpacity(0.60);
+              : colorScheme.onSurface.withValues(alpha: 0.60);
         });
     final Color backgroundColor = timePickerTheme.dayPeriodColor ??
         WidgetStateColor.resolveWith((Set<WidgetState> states) {
@@ -551,7 +552,7 @@ class _DayPeriodControl extends StatelessWidget {
           // and allows the optional elevation overlay for dark mode to be
           // visible.
           return states.contains(WidgetState.selected)
-              ? colorScheme.primary.withOpacity(isDark ? 0.24 : 0.12)
+              ? colorScheme.primary.withValues(alpha: isDark ? 0.24 : 0.12)
               : Colors.transparent;
         });
     final bool amSelected = selectedTime.period == DayPeriod.am;
@@ -572,8 +573,8 @@ class _DayPeriodControl extends StatelessWidget {
         const RoundedRectangleBorder(borderRadius: _kDefaultBorderRadius);
     final BorderSide borderSide = timePickerTheme.dayPeriodBorderSide ??
         BorderSide(
-          color: Color.alphaBlend(
-              colorScheme.onSurface.withOpacity(0.38), colorScheme.surface),
+          color: Color.alphaBlend(colorScheme.onSurface.withValues(alpha: 0.38),
+              colorScheme.surface),
         );
     // Apply the custom borderSide.
     shape = shape.copyWith(
@@ -1270,7 +1271,7 @@ class _DialState extends State<_Dial> with SingleTickerProviderStateMixin {
     final ThemeData theme = Theme.of(context);
     final TimePickerThemeData pickerTheme = TimePickerTheme.of(context);
     final Color backgroundColor = pickerTheme.dialBackgroundColor ??
-        themeData.colorScheme.onSurface.withOpacity(0.12);
+        themeData.colorScheme.onSurface.withValues(alpha: 0.12);
     final Color accentColor =
         pickerTheme.dialHandColor ?? themeData.colorScheme.primary;
     final Color primaryLabelColor = WidgetStateProperty.resolveAs(
@@ -1715,8 +1716,7 @@ class _HourMinuteTextFieldState extends State<_HourMinuteTextField> {
     final TimePickerThemeData timePickerTheme = TimePickerTheme.of(context);
     final ColorScheme colorScheme = theme.colorScheme;
 
-    final InputDecorationThemeData? inputDecorationTheme =
-        timePickerTheme.inputDecorationTheme;
+    final inputDecorationTheme = timePickerTheme.inputDecorationTheme;
     InputDecoration inputDecoration;
     if (inputDecorationTheme != null) {
       inputDecoration =
@@ -1738,14 +1738,14 @@ class _HourMinuteTextFieldState extends State<_HourMinuteTextField> {
           borderSide: BorderSide(color: colorScheme.error, width: 2.0),
         ),
         hintStyle: widget.style
-            .copyWith(color: colorScheme.onSurface.withOpacity(0.36)),
+            .copyWith(color: colorScheme.onSurface.withValues(alpha: 0.36)),
         errorStyle: const TextStyle(
             fontSize: 0.0,
             height: 0.0), // Prevent the error text from appearing.
       );
     }
     final Color unfocusedFillColor = timePickerTheme.hourMinuteColor ??
-        colorScheme.onSurface.withOpacity(0.12);
+        colorScheme.onSurface.withValues(alpha: 0.12);
     // If screen reader is in use, make the hint text say hours/minutes.
     // Otherwise, remove the hint text when focused because the centered cursor
     // appears odd above the hint text.
@@ -2031,8 +2031,9 @@ class _TimePickerWidgetState extends State<TimePickerWidget> {
         const SizedBox(width: 10.0),
         IconButton(
           color: TimePickerTheme.of(context).entryModeIconColor ??
-              theme.colorScheme.onSurface.withOpacity(
-                theme.colorScheme.brightness == Brightness.dark ? 1.0 : 0.6,
+              theme.colorScheme.onSurface.withValues(
+                alpha:
+                    theme.colorScheme.brightness == Brightness.dark ? 1.0 : 0.6,
               ),
           onPressed: _handleEntryModeToggle,
           icon: Icon(_entryMode == TimePickerEntryMode.dial
diff --git a/packages/survey_kit_image_answer/lib/src/view/image_answer_view.dart b/packages/survey_kit_image_answer/lib/src/view/image_answer_view.dart
@@ -158,6 +158,8 @@ class _ImageAnswerViewState extends State<ImageAnswerView> {
       source: ImageSource.camera,
     );
 
+    if (!mounted) return;
+
     Navigator.pop(context);
 
     picture?.readAsBytes().then((value) {
@@ -172,6 +174,8 @@ class _ImageAnswerViewState extends State<ImageAnswerView> {
       source: ImageSource.gallery,
     );
 
+    if (!mounted) return;
+
     Navigator.pop(context);
 
     picture?.readAsBytes().then((value) {
diff --git a/pubspec.lock b/pubspec.lock
diff --git a/pubspec.yaml b/pubspec.yaml
