Merge pull request #40 from Iconica-Development/fix/splashscreen-future

fix: always call the splashHandler with the splashScreenFuture and killswitchService when a splashScreenBuilder is provided

.github/workflows/release.yml

@@ -0,0 +1,14 @@
+name: Iconica Standard Component Release Workflow
+# Workflow Caller version: 1.0.0
+
+on:
+  release:
+    types: [published]
+    
+  workflow_dispatch:
+
+jobs:
+  call-global-iconica-workflow:
+    uses: Iconica-Development/.github/.github/workflows/component-release.yml@master
+    secrets: inherit
+    permissions: write-all

CHANGELOG.md

@@ -1,6 +1,14 @@
-## 4.2.1
+## 4.2.4
+- Fixed the userstory to always call the splashScreenFuture and killswitchservice logic when a custom splashScreenBuilder is provided
 
-* Updated flutter_introduction to 5.0.0
+## 4.2.3
+- Added check if introduction should be shown according to the service before showing the introduction at all
+
+## 4.2.2
+- Added custom navigator in the root of the navigator user-story
+
+## 4.2.1
+- Updated flutter_introduction to 5.0.0
 
 ## 4.1.0
 - Updated README

example/.gitignore

@@ -31,6 +31,9 @@ migrate_working_dir/
 .pub/
 /build/
 
+# platforms
+/web
+
 # Symbolication related
 app.*.symbols
 

example/README.md

@@ -0,0 +1,16 @@
+# example
+
+A new Flutter project.
+
+## Getting Started
+
+This project is a starting point for a Flutter application.
+
+A few resources to get you started if this is your first Flutter project:
+
+- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
+- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
+
+For help getting started with Flutter development, view the
+[online documentation](https://docs.flutter.dev/), which offers tutorials,
+samples, guidance on mobile development, and a full API reference.

lib/src/user_stories/flutter_start_userstory_navigator.dart

@@ -19,13 +19,11 @@ class NavigatorStartUserStory extends StatelessWidget {
   final void Function(BuildContext context) onComplete;
 
   @override
-  Widget build(BuildContext context) {
-    if (!configuration.showSplashScreen) {
-      return _introduction(configuration, context, onComplete);
-    }
-
-    return _splashScreen(configuration, context, onComplete);
-  }
+  Widget build(BuildContext context) => Navigator(
+        onGenerateInitialRoutes: (_, __) => [
+          _getInitialRoute(configuration, onComplete),
+        ],
+      );
 }
 
 /// Enter the start user story with the Navigator 1.0 API.
@@ -42,6 +40,15 @@ Future<void> startNavigatorUserStory(
   StartUserStoryConfiguration configuration, {
   required void Function(BuildContext context) onComplete,
 }) async {
+  var initialRoute = _getInitialRoute(configuration, onComplete);
+
+  await Navigator.of(context).push(initialRoute);
+}
+
+MaterialPageRoute<dynamic> _getInitialRoute(
+  StartUserStoryConfiguration configuration,
+  void Function(BuildContext context) onComplete,
+) {
   var initialRoute = MaterialPageRoute(
     builder: (context) => _splashScreen(
       configuration,
@@ -59,8 +66,7 @@ Future<void> startNavigatorUserStory(
       ),
     );
   }
-
-  await Navigator.of(context).push(initialRoute);
+  return initialRoute;
 }
 
 Widget _splashScreen(
@@ -98,28 +104,32 @@ Widget _splashScreen(
 
     if (configuration.useKillswitch && isAllowedToPassThrough) return;
 
-    if ((!configuration.showIntroduction) && context.mounted) {
-      onComplete(context);
-      return;
-    }
+    var introService = configuration.introductionService ??
+        IntroductionService(SharedPreferencesIntroductionDataProvider());
 
-    if (context.mounted) {
-      await navigator.pushReplacement(
-        MaterialPageRoute(
-          builder: (context) => _introduction(
-            configuration,
-            context,
-            onComplete,
-          ),
+    var shouldShowIntroduction =
+        configuration.showIntroduction && await introService.shouldShow();
+
+    if (!context.mounted) return;
+
+    if (!shouldShowIntroduction) return onComplete(context);
+
+    await navigator.pushReplacement(
+      MaterialPageRoute(
+        builder: (context) => _introduction(
+          configuration,
+          context,
+          onComplete,
         ),
-      );
-    }
+      ),
+    );
   }
 
+  unawaited(splashHandler());
+
   var builder = configuration.splashScreenBuilder;
 
   if (builder == null) {
-    unawaited(splashHandler());
     return Scaffold(
       backgroundColor: configuration.splashScreenBackgroundColor,
       body: Center(

pubspec.yaml

@@ -1,6 +1,6 @@
 name: flutter_start
 description: "Flutter_start is a package that allows you to jumpstart your application with a splashScreen, introduction and a home."
-version: 4.2.1
+version: 4.2.4
 
 publish_to: https://forgejo.internal.iconica.nl/api/packages/internal/pub
 
@@ -16,7 +16,7 @@ dependencies:
   package_info_plus: ">=8.0.0 <9.0.0"
   flutter_introduction:
     hosted: https://forgejo.internal.iconica.nl/api/packages/internal/pub
-    version: "^5.0.0"
+    version: ^5.0.0
   flutter_introduction_shared_preferences:
     hosted: https://forgejo.internal.iconica.nl/api/packages/internal/pub/
     version: ^5.0.0

test/_test.dart

@@ -0,0 +1,14 @@
+// This is an example unit test.
+//
+// A unit test tests a single function, method, or class. To learn more about
+// writing unit tests, visit
+// https://flutter.dev/docs/cookbook/testing/unit/introduction
+import 'package:flutter_test/flutter_test.dart';
+
+void main() {
+  group('Plus Operator', () {
+    test('should add two numbers together', () {
+      expect(1 + 1, 2);
+    });
+  });
+}