Merge branch '23-use-navigation-widgets-from-flutter_custom_toolbox' into 'master'

Resolve "Use navigation widgets from flutter_custom_toolbox"

Closes #23

See merge request !20

fastlane/metadata/android/en-US/changelogs/20.txt

+Use navigation tools from flutter_custom_toolbox.

fastlane/metadata/android/fr-FR/changelogs/20.txt

+Utilisation des outils de navigation entre pages depuis flutter_custom_toolbox.

lib/common/config/activity_page.dart

-import 'package:flutter/material.dart';
-import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
-import 'package:midisynth/cubit/activity/activity_cubit.dart';
-import 'package:midisynth/models/activity/activity.dart';
-
-import 'package:midisynth/ui/pages/editor.dart';
-import 'package:midisynth/ui/pages/home.dart';
-import 'package:midisynth/ui/pages/player.dart';
-
-class ActivityPageItem {
-  final String code;
-  final Icon icon;
-  final Widget Function({required Activity currentActivity})? builder;
-
-  const ActivityPageItem({
-    required this.code,
-    required this.icon,
-    required this.builder,
-  });
-}
-
-class ActivityPage {
-  static const bool displayBottomNavBar = true;
-
-  static const indexHome = 0;
-  static final pageHome = ActivityPageItem(
-    code: 'page_home',
-    icon: Icon(UniconsLine.home),
-    builder: ({required Activity currentActivity}) {
-      return PageHome();
-    },
-  );
-
-  static const indexEditor = 1;
-  static final pageEditor = ActivityPageItem(
-    code: 'page_editor',
-    icon: Icon(UniconsLine.edit),
-    builder: ({required Activity currentActivity}) {
-      return PageEditor();
-    },
-  );
-
-  static const indexPlayer = 2;
-  static final pagePlayer = ActivityPageItem(
-    code: 'page_player',
-    icon: Icon(UniconsLine.play),
-    builder: ({required Activity currentActivity}) {
-      return PagePlayer();
-    },
-  );
-
-  static final Map<int, ActivityPageItem> items = {
-    indexHome: pageHome,
-    indexEditor: pageEditor,
-    indexPlayer: pagePlayer,
-  };
-
-  static int defaultPageIndex = indexHome;
-
-  static bool isIndexAllowed(int pageIndex) {
-    return items.keys.contains(pageIndex);
-  }
-
-  static Widget getWidget(int pageIndex) {
-    return BlocBuilder<ActivityCubit, ActivityState>(
-      builder: (BuildContext context, ActivityState activityState) {
-        final Activity currentActivity = activityState.currentActivity;
-
-        if (items.keys.contains(pageIndex)) {
-          return items[pageIndex]?.builder!(currentActivity: currentActivity) ?? Text('oups');
-        } else {
-          return getWidget(defaultPageIndex);
-        }
-      },
-    );
-  }
-}

lib/common/config/screen.dart

-import 'package:flutter/material.dart';
-import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
-
-import 'package:midisynth/common/ui/screens/about.dart';
-import 'package:midisynth/common/ui/screens/activity.dart';
-import 'package:midisynth/common/ui/screens/settings.dart';
-
-class ScreenItem {
-  final String code;
-  final Icon icon;
-  final Widget screen;
-
-  const ScreenItem({
-    required this.code,
-    required this.icon,
-    required this.screen,
-  });
-}
-
-class Screen {
-  static const indexActivity = 0;
-  static const screenActivity = ScreenItem(
-    code: 'screen_activity',
-    icon: Icon(UniconsLine.home),
-    screen: ScreenActivity(),
-  );
-
-  static const indexSettings = 1;
-  static const screenSettings = ScreenItem(
-    code: 'screen_settings',
-    icon: Icon(UniconsLine.setting),
-    screen: ScreenSettings(),
-  );
-
-  static const indexAbout = 2;
-  static const screenAbout = ScreenItem(
-    code: 'screen_about',
-    icon: Icon(UniconsLine.info_circle),
-    screen: ScreenAbout(),
-  );
-
-  static Map<int, ScreenItem> items = {
-    indexActivity: screenActivity,
-    indexSettings: screenSettings,
-    indexAbout: screenAbout,
-  };
-
-  static bool isIndexAllowed(int screenIndex) {
-    return items.keys.contains(screenIndex);
-  }
-
-  static Widget getWidget(int screenIndex) {
-    return items[screenIndex]?.screen ?? screenActivity.screen;
-  }
-}

lib/common/cubit/nav/nav_cubit_pages.dart

-import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
-
-import 'package:midisynth/common/config/activity_page.dart';
-
-class NavCubitPage extends HydratedCubit<int> {
-  NavCubitPage() : super(0);
-
-  void updateIndex(int index) {
-    if (ActivityPage.isIndexAllowed(index)) {
-      emit(index);
-    } else {
-      emit(ActivityPage.indexHome);
-    }
-  }
-
-  void goToPageHome() {
-    updateIndex(ActivityPage.indexHome);
-  }
-
-  void goToPageEditor() {
-    updateIndex(ActivityPage.indexEditor);
-  }
-
-  @override
-  int fromJson(Map<String, dynamic> json) {
-    return ActivityPage.indexHome;
-  }
-
-  @override
-  Map<String, dynamic>? toJson(int state) {
-    return <String, int>{'index': state};
-  }
-}

lib/common/cubit/nav/nav_cubit_screens.dart

-import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
-
-import 'package:midisynth/common/config/screen.dart';
-
-class NavCubitScreen extends HydratedCubit<int> {
-  NavCubitScreen() : super(0);
-
-  void updateIndex(int index) {
-    if (Screen.isIndexAllowed(index)) {
-      emit(index);
-    } else {
-      goToScreenActivity();
-    }
-  }
-
-  void goToScreenActivity() {
-    emit(Screen.indexActivity);
-  }
-
-  void goToScreenSettings() {
-    emit(Screen.indexSettings);
-  }
-
-  void goToScreenAbout() {
-    emit(Screen.indexAbout);
-  }
-
-  @override
-  int fromJson(Map<String, dynamic> json) {
-    return Screen.indexActivity;
-  }
-
-  @override
-  Map<String, dynamic>? toJson(int state) {
-    return <String, int>{'index': state};
-  }
-}

lib/common/ui/nav/bottom_nav_bar.dart

-import 'package:flutter/material.dart';
-import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
-
-import 'package:midisynth/common/config/activity_page.dart';
-import 'package:midisynth/common/cubit/nav/nav_cubit_pages.dart';
-
-class BottomNavBar extends StatelessWidget {
-  const BottomNavBar({super.key});
-
-  @override
-  Widget build(BuildContext context) {
-    return Card(
-      margin: const EdgeInsets.only(top: 1, right: 4, left: 4),
-      elevation: 4,
-      shadowColor: Theme.of(context).colorScheme.shadow,
-      color: Theme.of(context).colorScheme.surfaceContainerHighest,
-      shape: const RoundedRectangleBorder(
-        borderRadius: BorderRadius.only(
-          topLeft: Radius.circular(16),
-          topRight: Radius.circular(16),
-        ),
-      ),
-      child: BlocBuilder<NavCubitPage, int>(builder: (BuildContext context, int state) {
-        final List<BottomNavigationBarItem> items = [];
-
-        ActivityPage.items.forEach((int pageIndex, ActivityPageItem item) {
-          items.add(BottomNavigationBarItem(
-            icon: item.icon,
-            label: tr(item.code),
-          ));
-        });
-
-        return BottomNavigationBar(
-          currentIndex: state,
-          onTap: (int index) => BlocProvider.of<NavCubitPage>(context).updateIndex(index),
-          type: BottomNavigationBarType.fixed,
-          elevation: 0,
-          backgroundColor: Colors.transparent,
-          selectedItemColor: Theme.of(context).colorScheme.primary,
-          unselectedItemColor: Theme.of(context).textTheme.bodySmall!.color,
-          items: items,
-        );
-      }),
-    );
-  }
-}

lib/common/ui/nav/global_app_bar.dart

-import 'package:flutter/material.dart';
-import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
-
-import 'package:midisynth/common/config/screen.dart';
-import 'package:midisynth/common/cubit/nav/nav_cubit_pages.dart';
-import 'package:midisynth/common/cubit/nav/nav_cubit_screens.dart';
-
-import 'package:midisynth/cubit/activity/activity_cubit.dart';
-import 'package:midisynth/models/activity/activity.dart';
-
-class GlobalAppBar extends StatelessWidget implements PreferredSizeWidget {
-  const GlobalAppBar({super.key});
-
-  @override
-  Widget build(BuildContext context) {
-    return BlocBuilder<ActivityCubit, ActivityState>(
-      builder: (BuildContext context, ActivityState activityState) {
-        return BlocBuilder<NavCubitScreen, int>(
-          builder: (BuildContext context, int pageIndex) {
-            final Activity currentActivity = activityState.currentActivity;
-
-            final List<Widget> menuActions = [];
-
-            if (currentActivity.isRunning && !currentActivity.isFinished) {
-              menuActions.add(ActivityButtonQuit(
-                onPressed: () {},
-                onLongPress: () {
-                  BlocProvider.of<ActivityCubit>(context).quitActivity();
-                  BlocProvider.of<NavCubitPage>(context).goToPageHome();
-                },
-              ));
-            } else {
-              if (pageIndex == Screen.indexActivity) {
-                // go to Settings page
-                menuActions.add(ElevatedButton(
-                  onPressed: () {
-                    BlocProvider.of<NavCubitScreen>(context).goToScreenSettings();
-                  },
-                  style: ElevatedButton.styleFrom(
-                    shape: const CircleBorder(),
-                  ),
-                  child: Screen.screenSettings.icon,
-                ));
-
-                // go to About page
-                menuActions.add(ElevatedButton(
-                  onPressed: () {
-                    BlocProvider.of<NavCubitScreen>(context).goToScreenAbout();
-                  },
-                  style: ElevatedButton.styleFrom(
-                    shape: const CircleBorder(),
-                  ),
-                  child: Screen.screenAbout.icon,
-                ));
-              } else {
-                // back to Home page
-                menuActions.add(ElevatedButton(
-                  onPressed: () {
-                    BlocProvider.of<NavCubitScreen>(context).goToScreenActivity();
-                  },
-                  style: ElevatedButton.styleFrom(
-                    shape: const CircleBorder(),
-                  ),
-                  child: Screen.screenActivity.icon,
-                ));
-              }
-            }
-
-            return AppBar(
-              title: const AppHeader(text: 'app_name'),
-              actions: menuActions,
-            );
-          },
-        );
-      },
-    );
-  }
-
-  @override
-  Size get preferredSize => const Size.fromHeight(50);
-}

lib/common/ui/screens/about.dart

-import 'package:flutter/material.dart';
-import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
-
-class ScreenAbout extends StatelessWidget {
-  const ScreenAbout({super.key});
-
-  @override
-  Widget build(BuildContext context) {
-    return Padding(
-      padding: const EdgeInsets.symmetric(horizontal: 8),
-      child: Column(
-        mainAxisAlignment: MainAxisAlignment.start,
-        crossAxisAlignment: CrossAxisAlignment.start,
-        mainAxisSize: MainAxisSize.max,
-        children: <Widget>[
-          const SizedBox(height: 8),
-          const AppTitle(text: 'about_title'),
-          const Text('about_content').tr(),
-          FutureBuilder<PackageInfo>(
-            future: PackageInfo.fromPlatform(),
-            builder: (context, snapshot) {
-              switch (snapshot.connectionState) {
-                case ConnectionState.done:
-                  return const Text('about_version').tr(
-                    namedArgs: {
-                      'version': snapshot.data!.version,
-                    },
-                  );
-                default:
-                  return const SizedBox();
-              }
-            },
-          ),
-        ],
-      ),
-    );
-  }
-}

lib/common/ui/screens/activity.dart

-import 'package:flutter/material.dart';
-import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
-
-import 'package:midisynth/common/config/activity_page.dart';
-import 'package:midisynth/common/cubit/nav/nav_cubit_pages.dart';
-
-class ScreenActivity extends StatelessWidget {
-  const ScreenActivity({super.key});
-
-  @override
-  Widget build(BuildContext context) {
-    return BlocBuilder<NavCubitPage, int>(
-      builder: (BuildContext context, int pageIndex) {
-        return ActivityPage.getWidget(pageIndex);
-      },
-    );
-  }
-}

lib/common/ui/screens/settings.dart

-import 'package:flutter/material.dart';
-import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
-
-class ScreenSettings extends StatelessWidget {
-  const ScreenSettings({super.key});
-
-  @override
-  Widget build(BuildContext context) {
-    return const Padding(
-      padding: EdgeInsets.symmetric(horizontal: 8),
-      child: Column(
-        mainAxisAlignment: MainAxisAlignment.start,
-        crossAxisAlignment: CrossAxisAlignment.start,
-        mainAxisSize: MainAxisSize.max,
-        children: <Widget>[
-          SizedBox(height: 8),
-          AppTitle(text: 'settings_title'),
-          SizedBox(height: 8),
-          ApplicationSettingsForm(),
-        ],
-      ),
-    );
-  }
-}

lib/config/application_config.dart

 import 'package:flutter/material.dart';
 import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
 
-import 'package:midisynth/common/cubit/nav/nav_cubit_pages.dart';
-
 import 'package:midisynth/cubit/activity/activity_cubit.dart';
 
+import 'package:midisynth/ui/pages/editor.dart';
+import 'package:midisynth/ui/pages/home.dart';
+import 'package:midisynth/ui/pages/player.dart';
+
 class ApplicationConfig {
-  // sequence length
+  // activity parameter: sequence length
   static const String parameterCodeSequenceLength = 'sequenceLength';
   static const String sequenceLengthValueShort = 'short';
   static const String sequenceLengthValueMedium = 'medium';
   static const String sequenceLengthValueLong = 'long';
 
+  // activity pages
+  static const int activityPageIndexHome = 0;
+  static const int activityPageIndexEditor = 1;
+  static const int activityPageIndexPlayer = 2;
+
   static final ApplicationConfigDefinition config = ApplicationConfigDefinition(
     appTitle: 'MIDI Synth',
     activitySettings: [
@@ -30,26 +37,87 @@ class ApplicationConfig {
             value: sequenceLengthValueLong,
           ),
         ],
-        intValueGetter: (value) {
+        intValueGetter: (String value) {
           const Map<String, int> intValues = {
             sequenceLengthValueShort: 8,
             sequenceLengthValueMedium: 16,
             sequenceLengthValueLong: 32,
           };
-          return intValues[parameterCodeSequenceLength] ?? 0;
+          return intValues[value] ?? 0;
         },
       ),
     ],
     startNewActivity: (BuildContext context) {
       BlocProvider.of<ActivityCubit>(context).startNewActivity(context);
-      BlocProvider.of<NavCubitPage>(context).goToPageEditor();
+      BlocProvider.of<NavCubitPage>(context)
+          .updateIndex(ApplicationConfig.activityPageIndexEditor);
+    },
+    quitCurrentActivity: (BuildContext context) {
+      BlocProvider.of<ActivityCubit>(context).quitActivity();
+      BlocProvider.of<NavCubitPage>(context)
+          .updateIndex(ApplicationConfig.activityPageIndexHome);
     },
     deleteCurrentActivity: (BuildContext context) {
       BlocProvider.of<ActivityCubit>(context).deleteSavedActivity();
     },
     resumeActivity: (BuildContext context) {
       BlocProvider.of<ActivityCubit>(context).resumeSavedActivity();
-      BlocProvider.of<NavCubitPage>(context).goToPageEditor();
+      BlocProvider.of<NavCubitPage>(context)
+          .updateIndex(ApplicationConfig.activityPageIndexEditor);
     },
+    navigation: ApplicationNavigation(
+      screenActivity: ScreenItem(
+        code: 'screen_activity',
+        icon: Icon(UniconsLine.home),
+        screen: ({required ApplicationConfigDefinition appConfig}) =>
+            ScreenActivity(appConfig: appConfig),
+      ),
+      screenSettings: ScreenItem(
+        code: 'screen_settings',
+        icon: Icon(UniconsLine.setting),
+        screen: ({required ApplicationConfigDefinition appConfig}) => ScreenSettings(),
+      ),
+      screenAbout: ScreenItem(
+        code: 'screen_about',
+        icon: Icon(UniconsLine.info_circle),
+        screen: ({required ApplicationConfigDefinition appConfig}) => ScreenAbout(),
+      ),
+      displayBottomNavBar: true,
+      activityPages: {
+        activityPageIndexHome: ActivityPageItem(
+          code: 'page_home',
+          icon: Icon(UniconsLine.home),
+          builder: ({required ApplicationConfigDefinition appConfig}) {
+            return BlocBuilder<ActivityCubit, ActivityState>(
+              builder: (BuildContext context, ActivityState activityState) {
+                return PageHome();
+              },
+            );
+          },
+        ),
+        activityPageIndexEditor: ActivityPageItem(
+          code: 'page_editor',
+          icon: Icon(UniconsLine.edit),
+          builder: ({required ApplicationConfigDefinition appConfig}) {
+            return BlocBuilder<ActivityCubit, ActivityState>(
+              builder: (BuildContext context, ActivityState activityState) {
+                return PageEditor();
+              },
+            );
+          },
+        ),
+        activityPageIndexPlayer: ActivityPageItem(
+          code: 'page_player',
+          icon: Icon(UniconsLine.play),
+          builder: ({required ApplicationConfigDefinition appConfig}) {
+            return BlocBuilder<ActivityCubit, ActivityState>(
+              builder: (BuildContext context, ActivityState activityState) {
+                return PagePlayer();
+              },
+            );
+          },
+        ),
+      },
+    ),
   );
 }

lib/main.dart

@@ -4,9 +4,6 @@ import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
 
-import 'package:midisynth/common/cubit/nav/nav_cubit_pages.dart';
-import 'package:midisynth/common/cubit/nav/nav_cubit_screens.dart';
-
 import 'package:midisynth/config/application_config.dart';
 import 'package:midisynth/cubit/activity/activity_cubit.dart';
 import 'package:midisynth/ui/skeleton.dart';
@@ -43,7 +40,7 @@ class MyApp extends StatelessWidget {
       providers: [
         // default providers
         BlocProvider<NavCubitPage>(
-          create: (context) => NavCubitPage(),
+          create: (context) => NavCubitPage(appConfig: ApplicationConfig.config),
         ),
         BlocProvider<NavCubitScreen>(
           create: (context) => NavCubitScreen(),

lib/ui/skeleton.dart

 import 'package:flutter/material.dart';
 import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
 
-import 'package:midisynth/common/config/activity_page.dart';
-import 'package:midisynth/common/config/screen.dart';
-import 'package:midisynth/common/cubit/nav/nav_cubit_screens.dart';
-import 'package:midisynth/common/ui/nav/global_app_bar.dart';
-import 'package:midisynth/common/ui/nav/bottom_nav_bar.dart';
+import 'package:midisynth/config/application_config.dart';
+import 'package:midisynth/cubit/activity/activity_cubit.dart';
+import 'package:midisynth/models/activity/activity.dart';
 
 class SkeletonScreen extends StatelessWidget {
   const SkeletonScreen({super.key});
@@ -14,22 +12,48 @@ class SkeletonScreen extends StatelessWidget {
   Widget build(BuildContext context) {
     return BlocBuilder<NavCubitScreen, int>(
       builder: (BuildContext context, int screenIndex) {
-        return Scaffold(
-          appBar: const GlobalAppBar(),
-          extendBodyBehindAppBar: false,
-          body: Material(
-            color: Theme.of(context).colorScheme.surface,
-            child: Padding(
-              padding: const EdgeInsets.only(
-                top: 8,
-                left: 2,
-                right: 2,
-              ),
-              child: Screen.getWidget(screenIndex),
-            ),
-          ),
-          backgroundColor: Theme.of(context).colorScheme.surface,
-          bottomNavigationBar: ActivityPage.displayBottomNavBar ? const BottomNavBar() : null,
+        return BlocBuilder<ActivityCubit, ActivityState>(
+          builder: (BuildContext context, ActivityState activityState) {
+            return BlocBuilder<NavCubitPage, int>(
+              builder: (BuildContext context, int pageIndex) {
+                final Activity currentActivity = activityState.currentActivity;
+
+                // autostart activity
+                if (ApplicationConfig.config.autoStartActivity &&
+                    (!currentActivity.isRunning)) {
+                  ApplicationConfig.config.startNewActivity(context);
+                }
+
+                return Scaffold(
+                  appBar: GlobalAppBar(
+                    appConfig: ApplicationConfig.config,
+                    pageIndex: pageIndex,
+                    isActivityRunning:
+                        currentActivity.isRunning && !currentActivity.isFinished,
+                  ),
+                  extendBodyBehindAppBar: false,
+                  body: Material(
+                    color: Theme.of(context).colorScheme.surface,
+                    child: Padding(
+                      padding: const EdgeInsets.only(
+                        top: 8,
+                        left: 2,
+                        right: 2,
+                      ),
+                      child: ApplicationConfig.config.navigation.getScreenWidget(
+                        appConfig: ApplicationConfig.config,
+                        screenIndex: screenIndex,
+                      ),
+                    ),
+                  ),
+                  backgroundColor: Theme.of(context).colorScheme.surface,
+                  bottomNavigationBar: ApplicationConfig.config.navigation.displayBottomNavBar
+                      ? BottomNavBar(appConfig: ApplicationConfig.config)
+                      : null,
+                );
+              },
+            );
+          },
         );
       },
     );

pubspec.lock

@@ -122,11 +122,11 @@ packages:
     dependency: "direct main"
     description:
       path: "."
-      ref: "0.5.0"
-      resolved-ref: b8164a50489ba981ea57d9f02e2334f09cb8c6a7
+      ref: "0.6.0"
+      resolved-ref: dfe0f6b7b49f9aa32f085e4a5d3ea320b3611eed
       url: "https://git.harrault.fr/android/flutter-toolbox.git"
     source: git
-    version: "0.5.0"
+    version: "0.6.0"
   flutter_lints:
     dependency: "direct dev"
     description:

pubspec.yaml

@@ -3,7 +3,7 @@ description: MIDI Synth
 
 publish_to: "none"
 
-version: 0.4.0+19
+version: 0.5.0+20
 
 environment:
   sdk: "^3.0.0"
@@ -16,7 +16,7 @@ dependencies:
   flutter_custom_toolbox:
     git:
       url: https://git.harrault.fr/android/flutter-toolbox.git
-      ref: 0.5.0
+      ref: 0.6.0
 
   # specific
   # (none)