neon: add ability to scroll to a specific setting

1 year ago · 58e8392dca
6 changed files with 305 additions and 208 deletions
--- a/packages/app/pubspec.lock
+++ b/packages/app/pubspec.lock
@ -1037,6 +1037,14 @@ packages:
      url: "https://pub.dev"
    source: hosted
    version: "0.1.6"
+  scrollable_positioned_list:
+    dependency: transitive
+    description:
+      name: scrollable_positioned_list
+      sha256: "1b54d5f1329a1e263269abc9e2543d90806131aa14fe7c6062a8054d57249287"
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.3.8"
  share_plus:
    dependency: transitive
    description:
--- a/packages/neon/neon/lib/src/pages/settings.dart
+++ b/packages/neon/neon/lib/src/pages/settings.dart
@ -27,11 +27,25 @@ import 'package:neon/src/widgets/exception.dart';
 import 'package:package_info_plus/package_info_plus.dart';
 import 'package:provider/provider.dart';

+enum SettingsCageories {
+  apps,
+  theme,
+  navigation,
+  pushNotifications,
+  startup,
+  systemTray,
+  accounts,
+  other,
+}
+
 class SettingsPage extends StatefulWidget {
  const SettingsPage({
+    this.initialCategory,
    super.key,
  });

+  final SettingsCageories? initialCategory;
+
  @override
  State<SettingsPage> createState() => _SettingsPageState();
 }
@ -42,6 +56,7 @@ class _SettingsPageState extends State<SettingsPage> {
    final globalOptions = Provider.of<GlobalOptions>(context);
    final accountsBloc = Provider.of<AccountsBloc>(context, listen: false);
    final appImplementations = Provider.of<Iterable<AppImplementation>>(context);
+
    return Scaffold(
      resizeToAvoidBottomInset: false,
      appBar: AppBar(
@ -68,38 +83,25 @@ class _SettingsPageState extends State<SettingsPage> {
      ),
      body: StreamBuilder<List<Account>>(
        stream: accountsBloc.accounts,
+        initialData: accountsBloc.accounts.valueOrNull,
        builder: (
          final context,
          final accountsSnapshot,
        ) {
-          final settingsExportHelper = SettingsExportHelper(
-            globalOptions: globalOptions,
-            appImplementations: appImplementations,
-            accountSpecificOptions: {
-              if (accountsSnapshot.hasData) ...{
-                for (final account in accountsSnapshot.requireData) ...{
-                  account: accountsBloc.getOptionsFor(account).options,
-                },
-              },
-            },
-          );
          final platform = Provider.of<NeonPlatform>(context, listen: false);
-          return StreamBuilder<Account?>(
-            stream: accountsBloc.activeAccount,
-            builder: (
-              final context,
-              final activeAccountSnapshot,
-            ) =>
-                StreamBuilder<bool>(
+          return StreamBuilder<bool>(
            stream: globalOptions.pushNotificationsEnabled.enabled,
+            initialData: globalOptions.pushNotificationsEnabled.enabled.valueOrNull,
            builder: (
              final context,
              final pushNotificationsEnabledEnabledSnapshot,
            ) =>
                SettingsList(
+              initialCategory: widget.initialCategory?.name,
              categories: [
                SettingsCategory(
                  title: Text(AppLocalizations.of(context).settingsApps),
+                  key: ValueKey(SettingsCageories.apps.name),
                  tiles: <SettingsTile>[
                    for (final appImplementation in appImplementations) ...[
                      if (appImplementation.options.options.isNotEmpty) ...[
@ -116,6 +118,7 @@ class _SettingsPageState extends State<SettingsPage> {
                ),
                SettingsCategory(
                  title: Text(AppLocalizations.of(context).optionsCategoryTheme),
+                  key: ValueKey(SettingsCageories.theme.name),
                  tiles: [
                    DropdownButtonSettingsTile(
                      option: globalOptions.themeMode,
@ -130,6 +133,7 @@ class _SettingsPageState extends State<SettingsPage> {
                ),
                SettingsCategory(
                  title: Text(AppLocalizations.of(context).optionsCategoryNavigation),
+                  key: ValueKey(SettingsCageories.navigation.name),
                  tiles: [
                    DropdownButtonSettingsTile(
                      option: globalOptions.navigationMode,
@ -139,6 +143,7 @@ class _SettingsPageState extends State<SettingsPage> {
                if (platform.canUsePushNotifications) ...[
                  SettingsCategory(
                    title: Text(AppLocalizations.of(context).optionsCategoryPushNotifications),
+                    key: ValueKey(SettingsCageories.pushNotifications.name),
                    tiles: [
                      if (pushNotificationsEnabledEnabledSnapshot.hasData &&
                          !pushNotificationsEnabledEnabledSnapshot.requireData) ...[
@ -163,6 +168,7 @@ class _SettingsPageState extends State<SettingsPage> {
                if (platform.canUseWindowManager) ...[
                  SettingsCategory(
                    title: Text(AppLocalizations.of(context).optionsCategoryStartup),
+                    key: ValueKey(SettingsCageories.startup.name),
                    tiles: [
                      CheckBoxSettingsTile(
                        option: globalOptions.startupMinimized,
@ -176,6 +182,7 @@ class _SettingsPageState extends State<SettingsPage> {
                if (platform.canUseWindowManager && platform.canUseSystemTray) ...[
                  SettingsCategory(
                    title: Text(AppLocalizations.of(context).optionsCategorySystemTray),
+                    key: ValueKey(SettingsCageories.systemTray.name),
                    tiles: [
                      CheckBoxSettingsTile(
                        option: globalOptions.systemTrayEnabled,
@ -186,9 +193,9 @@ class _SettingsPageState extends State<SettingsPage> {
                    ],
                  ),
                ],
-                  if (accountsSnapshot.hasData) ...[
                SettingsCategory(
                  title: Text(AppLocalizations.of(context).optionsCategoryAccounts),
+                  key: ValueKey(SettingsCageories.accounts.name),
                  tiles: [
                    if (accountsSnapshot.requireData.length > 1) ...[
                      CheckBoxSettingsTile(
@ -215,9 +222,9 @@ class _SettingsPageState extends State<SettingsPage> {
                    )
                  ],
                ),
-                  ],
                SettingsCategory(
                  title: Text(AppLocalizations.of(context).optionsCategoryOther),
+                  key: ValueKey(SettingsCageories.other.name),
                  tiles: <SettingsTile>[
                    CustomSettingsTile(
                      leading: Icon(
@ -243,6 +250,8 @@ class _SettingsPageState extends State<SettingsPage> {
                      ),
                      title: Text(AppLocalizations.of(context).settingsExport),
                      onTap: () async {
+                        final settingsExportHelper = _buildSettingsExportHelper(context);
+
                        try {
                          final fileName =
                              'nextcloud-neon-settings-${DateTime.now().millisecondsSinceEpoch ~/ 1000}.json.base64';
@ -268,6 +277,8 @@ class _SettingsPageState extends State<SettingsPage> {
                      ),
                      title: Text(AppLocalizations.of(context).settingsImport),
                      onTap: () async {
+                        final settingsExportHelper = _buildSettingsExportHelper(context);
+
                        try {
                          final result = await FilePicker.platform.pickFiles(
                            withData: true,
@ -287,8 +298,8 @@ class _SettingsPageState extends State<SettingsPage> {
                            return;
                          }

-                            final data =
-                                json.decode(utf8.decode(base64.decode(utf8.decode(result.files.single.bytes!))));
+                          final data = json.decode(utf8.decode(base64.decode(utf8.decode(result.files.single.bytes!))));
+
                          await settingsExportHelper.applyFromJson(data as Map<String, dynamic>);
                        } catch (e, s) {
                          debugPrint(e.toString());
@ -301,12 +312,25 @@ class _SettingsPageState extends State<SettingsPage> {
                ),
              ],
            ),
-            ),
          );
        },
      ),
    );
  }
+
+  SettingsExportHelper _buildSettingsExportHelper(final BuildContext context) {
+    final globalOptions = Provider.of<GlobalOptions>(context);
+    final accountsBloc = Provider.of<AccountsBloc>(context, listen: false);
+    final appImplementations = Provider.of<Iterable<AppImplementation>>(context);
+
+    return SettingsExportHelper(
+      globalOptions: globalOptions,
+      appImplementations: appImplementations,
+      accountSpecificOptions: accountsBloc.accounts.value.asMap().map(
+            (final _, final account) => MapEntry(account, accountsBloc.getOptionsFor(account).options),
+          ),
+    );
+  }
 }

 enum SettingsAccountAction {
--- a/packages/neon/neon/lib/src/router.dart
+++ b/packages/neon/neon/lib/src/router.dart
@ -367,8 +367,11 @@ class NextcloudAppSettingsRoute extends GoRouteData {

@immutable
 class SettingsRoute extends GoRouteData {
-  const SettingsRoute();
+  const SettingsRoute({this.initialCategory});
+
+  /// The initial category to show.
+  final SettingsCageories? initialCategory;

  @override
-  Widget build(final BuildContext context, final GoRouterState state) => const SettingsPage();
+  Widget build(final BuildContext context, final GoRouterState state) => SettingsPage(initialCategory: initialCategory);
 }
--- a/packages/neon/neon/lib/src/router.g.dart
+++ b/packages/neon/neon/lib/src/router.g.dart
@ -71,13 +71,21 @@ extension $HomeRouteExtension on HomeRoute {
  Future<T?> push<T>(BuildContext context) => context.push<T>(location);

  void pushReplacement(BuildContext context) => context.pushReplacement(location);
+
+  void replace(BuildContext context) => context.replace(location);
 }

 extension $SettingsRouteExtension on SettingsRoute {
-  static SettingsRoute _fromState(GoRouterState state) => const SettingsRoute();
+  static SettingsRoute _fromState(GoRouterState state) => SettingsRoute(
+        initialCategory:
+            _$convertMapValue('initial-category', state.queryParameters, _$SettingsCageoriesEnumMap._$fromName),
+      );

  String get location => GoRouteData.$location(
        '/settings',
+        queryParams: {
+          if (initialCategory != null) 'initial-category': _$SettingsCageoriesEnumMap[initialCategory!],
+        },
      );

  void go(BuildContext context) => context.go(location);
@ -85,8 +93,21 @@ extension $SettingsRouteExtension on SettingsRoute {
  Future<T?> push<T>(BuildContext context) => context.push<T>(location);

  void pushReplacement(BuildContext context) => context.pushReplacement(location);
+
+  void replace(BuildContext context) => context.replace(location);
 }

+const _$SettingsCageoriesEnumMap = {
+  SettingsCageories.apps: 'apps',
+  SettingsCageories.theme: 'theme',
+  SettingsCageories.navigation: 'navigation',
+  SettingsCageories.pushNotifications: 'push-notifications',
+  SettingsCageories.startup: 'startup',
+  SettingsCageories.systemTray: 'system-tray',
+  SettingsCageories.accounts: 'accounts',
+  SettingsCageories.other: 'other',
+};
+
 extension $NextcloudAppSettingsRouteExtension on NextcloudAppSettingsRoute {
  static NextcloudAppSettingsRoute _fromState(GoRouterState state) => NextcloudAppSettingsRoute(
        appid: state.pathParameters['appid']!,
@ -101,6 +122,8 @@ extension $NextcloudAppSettingsRouteExtension on NextcloudAppSettingsRoute {
  Future<T?> push<T>(BuildContext context) => context.push<T>(location);

  void pushReplacement(BuildContext context) => context.pushReplacement(location);
+
+  void replace(BuildContext context) => context.replace(location);
 }

 extension $_AddAccountRouteExtension on _AddAccountRoute {
@ -115,6 +138,8 @@ extension $_AddAccountRouteExtension on _AddAccountRoute {
  Future<T?> push<T>(BuildContext context) => context.push<T>(location);

  void pushReplacement(BuildContext context) => context.pushReplacement(location);
+
+  void replace(BuildContext context) => context.replace(location);
 }

 extension $_AddAccountFlowRouteExtension on _AddAccountFlowRoute {
@ -206,6 +231,21 @@ extension $AccountSettingsRouteExtension on AccountSettingsRoute {
  Future<T?> push<T>(BuildContext context) => context.push<T>(location);

  void pushReplacement(BuildContext context) => context.pushReplacement(location);
+
+  void replace(BuildContext context) => context.replace(location);
+}
+
+T? _$convertMapValue<T>(
+  String key,
+  Map<String, String> map,
+  T Function(String) converter,
+) {
+  final value = map[key];
+  return value == null ? null : converter(value);
+}
+
+extension<T extends Enum> on Map<T, String> {
+  T _$fromName(String value) => entries.singleWhere((element) => element.value == value).key;
 }

 RouteBase get $loginRoute => GoRouteData.$route(
@ -244,6 +284,8 @@ extension $LoginRouteExtension on LoginRoute {
  Future<T?> push<T>(BuildContext context) => context.push<T>(location);

  void pushReplacement(BuildContext context) => context.pushReplacement(location);
+
+  void replace(BuildContext context) => context.replace(location);
 }

 extension $LoginFlowRouteExtension on LoginFlowRoute {
@ -277,6 +319,8 @@ extension $LoginQrcodeRouteExtension on LoginQrcodeRoute {
  Future<T?> push<T>(BuildContext context) => context.push<T>(location);

  void pushReplacement(BuildContext context) => context.pushReplacement(location);
+
+  void replace(BuildContext context) => context.replace(location);
 }

 extension $LoginCheckServerStatusRouteExtension on LoginCheckServerStatusRoute {
@ -296,6 +340,8 @@ extension $LoginCheckServerStatusRouteExtension on LoginCheckServerStatusRoute {
  Future<T?> push<T>(BuildContext context) => context.push<T>(location);

  void pushReplacement(BuildContext context) => context.pushReplacement(location);
+
+  void replace(BuildContext context) => context.replace(location);
 }

 extension $LoginCheckAccountRouteExtension on LoginCheckAccountRoute {
@ -319,4 +365,6 @@ extension $LoginCheckAccountRouteExtension on LoginCheckAccountRoute {
  Future<T?> push<T>(BuildContext context) => context.push<T>(location);

  void pushReplacement(BuildContext context) => context.pushReplacement(location);
+
+  void replace(BuildContext context) => context.replace(location);
 }
--- a/packages/neon/neon/lib/src/settings/widgets/settings_list.dart
+++ b/packages/neon/neon/lib/src/settings/widgets/settings_list.dart
@ -1,23 +1,36 @@
 import 'package:flutter/material.dart';
-import 'package:intersperse/intersperse.dart';
 import 'package:meta/meta.dart';
 import 'package:neon/src/settings/widgets/settings_category.dart';
+import 'package:scrollable_positioned_list/scrollable_positioned_list.dart';

@internal
 class SettingsList extends StatelessWidget {
  const SettingsList({
    required this.categories,
+    this.initialCategory,
    super.key,
  });

  final List<SettingsCategory> categories;
+  final String? initialCategory;
+
+  int? _getIndex(final String? initialCategory) {
+    if (initialCategory == null) {
+      return null;
+    }
+
+    final key = Key(initialCategory);
+    final index = categories.indexWhere((final category) => category.key == key);
+
+    return index != -1 ? index : null;
+  }

  @override
-  Widget build(final BuildContext context) => Scrollbar(
-        child: ListView(
-          primary: true,
+  Widget build(final BuildContext context) => ScrollablePositionedList.separated(
        padding: const EdgeInsets.all(20),
-          children: categories.cast<Widget>().intersperse(const Divider()).toList(),
-        ),
+        itemCount: categories.length,
+        initialScrollIndex: _getIndex(initialCategory) ?? 0,
+        itemBuilder: (final context, final index) => categories[index],
+        separatorBuilder: (final context, final index) => const Divider(),
      );
 }
--- a/packages/neon/neon/pubspec.yaml
+++ b/packages/neon/neon/pubspec.yaml
@ -40,6 +40,7 @@ dependencies:
  provider: ^6.0.5
  quick_actions: ^1.0.3
  rxdart: ^0.27.7
+  scrollable_positioned_list: ^0.3.8
  shared_preferences: ^2.1.1
  sort_box:
    git: