Add setting to automatically show submit button (#200)

- Adds a toggle that automatically shows submit button. Off by default addresses #199 --------- Co-authored-by: Gold87 <[email protected]>
Gold872 · Feb 6, 2025 · 864513f · 864513f
1 parent d3205fb
commit 864513f
Show file tree

Hide file tree

Showing 6 changed files with 118 additions and 5 deletions.
diff --git a/lib/pages/dashboard_page.dart b/lib/pages/dashboard_page.dart
@@ -1658,6 +1658,10 @@ class _DashboardPageState extends State<DashboardPage> with WindowListener {
           }
           setState(() {});
         },
+        onAutoSubmitButtonChanged: (value) async {
+          await preferences.setBool(PrefKeys.autoTextSubmitButton, value);
+          setState(() {});
+        },
         onOpenAssetsFolderPressed: () async {
           Uri uri = Uri.file(
               '${path.dirname(Platform.resolvedExecutable)}/data/flutter_assets/assets/');

diff --git a/lib/services/settings.dart b/lib/services/settings.dart
@@ -74,4 +74,5 @@ class PrefKeys {
   static String logLevel = 'log_level';
   static String gridDpiOverride = 'grid_dpi_override';
   static String windowPosition = 'window_position';
+  static String autoTextSubmitButton = 'auto_text_submit_button';
 }
diff --git a/lib/widgets/nt_widgets/single_topic/text_display.dart b/lib/widgets/nt_widgets/single_topic/text_display.dart
@@ -7,6 +7,7 @@ import 'package:dot_cast/dot_cast.dart';
 import 'package:provider/provider.dart';
 
 import 'package:elastic_dashboard/services/nt4_client.dart';
+import 'package:elastic_dashboard/services/settings.dart';
 import 'package:elastic_dashboard/widgets/dialog_widgets/dialog_toggle_switch.dart';
 import 'package:elastic_dashboard/widgets/nt_widgets/nt_widget.dart';
 
@@ -37,8 +38,12 @@ class TextDisplayModel extends SingleTopicNTWidgetModel {
     super.dataType,
     super.period,
   }) : super() {
-    showSubmitButton ??= ntConnection.getTopicFromName(topic)?.isPersistent;
-    showSubmitButton ??= false;
+    if (preferences.getBool(PrefKeys.autoTextSubmitButton) ?? false) {
+      showSubmitButton ??= true;
+    } else {
+      showSubmitButton ??= ntConnection.getTopicFromName(topic)?.isPersistent;
+      showSubmitButton ??= false;
+    }
     _showSubmitButton = showSubmitButton;
   }
 

diff --git a/lib/widgets/settings_dialog.dart b/lib/widgets/settings_dialog.dart
@@ -51,6 +51,7 @@ class SettingsDialog extends StatefulWidget {
   final void Function(Level? level)? onLogLevelChanged;
   final FutureOr<void> Function(String? value)? onGridDPIChanged;
   final void Function()? onOpenAssetsFolderPressed;
+  final FutureOr<void> Function(bool value)? onAutoSubmitButtonChanged;
 
   const SettingsDialog({
     super.key,
@@ -72,6 +73,7 @@ class SettingsDialog extends StatefulWidget {
     this.onLogLevelChanged,
     this.onGridDPIChanged,
     this.onOpenAssetsFolderPressed,
+    this.onAutoSubmitButtonChanged,
   });
 
   @override
@@ -142,13 +144,15 @@ class _SettingsDialogState extends State<SettingsDialog> {
                       padding: const EdgeInsets.symmetric(horizontal: 4.0),
                       child: SingleChildScrollView(
                         child: ConstrainedBox(
-                          constraints: const BoxConstraints(maxHeight: 355),
+                          constraints: const BoxConstraints(maxHeight: 415),
                           child: Column(
                             mainAxisAlignment: MainAxisAlignment.start,
                             children: [
                               ..._themeSettings(),
                               const Divider(),
                               ..._gridSettings(),
+                              const Divider(),
+                              ..._otherSettings(),
                             ],
                           ),
                         ),
@@ -434,6 +438,31 @@ class _SettingsDialogState extends State<SettingsDialog> {
     ];
   }
 
+  List<Widget> _otherSettings() {
+    return [
+      const Align(
+        alignment: Alignment.topLeft,
+        child: Text('Other Settings'),
+      ),
+      const SizedBox(height: 5),
+      Row(
+        mainAxisAlignment: MainAxisAlignment.spaceEvenly,
+        children: [
+          Flexible(
+            child: DialogToggleSwitch(
+              initialValue: false,
+              label: 'Auto Show Text Submit Button',
+              onToggle: (value) async {
+                await widget.onAutoSubmitButtonChanged?.call(value);
+                setState(() {});
+              },
+            ),
+          )
+        ],
+      ),
+    ];
+  }
+
   List<Widget> _networkTablesSettings() {
     return [
       const Align(

diff --git a/test/widgets/nt_widgets/single-topic/text_display_test.dart b/test/widgets/nt_widgets/single-topic/text_display_test.dart
@@ -7,6 +7,7 @@ import 'package:shared_preferences/shared_preferences.dart';
 import 'package:elastic_dashboard/services/nt4_client.dart';
 import 'package:elastic_dashboard/services/nt_connection.dart';
 import 'package:elastic_dashboard/services/nt_widget_builder.dart';
+import 'package:elastic_dashboard/services/settings.dart';
 import 'package:elastic_dashboard/widgets/dialog_widgets/dialog_toggle_switch.dart';
 import 'package:elastic_dashboard/widgets/draggable_containers/draggable_nt_widget_container.dart';
 import 'package:elastic_dashboard/widgets/draggable_containers/models/nt_widget_container_model.dart';
@@ -82,7 +83,7 @@ void main() {
   });
 
   group('Show submit button defaults to', () {
-    test('true if topic is persistent', () {
+    test('true if topic is persistent', () async {
       NTConnection ntConnection = createMockOnlineNT4(
         virtualTopics: [
           NT4Topic(
@@ -108,7 +109,28 @@ void main() {
 
       expect(textDisplayModel.showSubmitButton, isTrue);
     });
-    test('false if topic is not persistent', () {
+    test('true if text auto submit button is true', () async {
+      SharedPreferences.setMockInitialValues({
+        PrefKeys.autoTextSubmitButton: true,
+      });
+      preferences = await SharedPreferences.getInstance();
+
+      TextDisplayModel textDisplayModel = TextDisplayModel(
+        ntConnection: ntConnection,
+        preferences: preferences,
+        topic: 'Test/Display Value',
+        dataType: 'double',
+        period: 0.100,
+      );
+
+      expect(textDisplayModel.showSubmitButton, isTrue);
+    });
+    test('false if auto submit button is false', () async {
+      SharedPreferences.setMockInitialValues({
+        PrefKeys.autoTextSubmitButton: false,
+      });
+      preferences = await SharedPreferences.getInstance();
+
       TextDisplayModel textDisplayModel = TextDisplayModel(
         ntConnection: ntConnection,
         preferences: preferences,

diff --git a/test/widgets/settings_dialog_test.dart b/test/widgets/settings_dialog_test.dart
@@ -48,6 +48,8 @@ class FakeSettingsMethods extends Mock {
   void changeGridDPIOverride();
 
   void openAssetsFolder();
+
+  void changeAutoSubmitButton();
 }
 
 void main() {
@@ -80,6 +82,7 @@ void main() {
       PrefKeys.defaultGraphPeriod: 0.033,
       PrefKeys.themeVariant: FlexSchemeVariant.chroma.variantName,
       PrefKeys.logLevel: Level.trace.levelName,
+      PrefKeys.autoTextSubmitButton: false,
     });
 
     preferences = await SharedPreferences.getInstance();
@@ -740,6 +743,55 @@ void main() {
     verify(fakeSettings.changeLockLayout()).called(2);
   });
 
+  testWidgets('Change auto submit button', (widgetTester) async {
+    FlutterError.onError = ignoreOverflowErrors;
+
+    await widgetTester.pumpWidget(
+      MaterialApp(
+        home: Scaffold(
+          body: SettingsDialog(
+            preferences: preferences,
+            ntConnection: createMockOfflineNT4(),
+            onAutoSubmitButtonChanged: (value) async {
+              fakeSettings.changeAutoSubmitButton();
+
+              await preferences.setBool(PrefKeys.autoTextSubmitButton, value);
+            },
+          ),
+        ),
+      ),
+    );
+
+    await widgetTester.pumpAndSettle();
+
+    expect(appearanceSettings, findsOneWidget);
+    await widgetTester.tap(appearanceSettings);
+    await widgetTester.pumpAndSettle();
+
+    final autoSubmitButtonSwitch =
+        find.widgetWithText(DialogToggleSwitch, 'Auto Show Text Submit Button');
+
+    expect(autoSubmitButtonSwitch, findsOneWidget);
+
+    // Widget tester.tap will not work for some reason
+    final switchWidget = find
+        .descendant(of: autoSubmitButtonSwitch, matching: find.byType(Switch))
+        .evaluate()
+        .first
+        .widget as Switch;
+
+    switchWidget.onChanged?.call(true);
+    await widgetTester.pumpAndSettle();
+
+    expect(preferences.getBool(PrefKeys.autoTextSubmitButton), true);
+
+    switchWidget.onChanged?.call(false);
+    await widgetTester.pumpAndSettle();
+
+    expect(preferences.getBool(PrefKeys.autoTextSubmitButton), false);
+    verify(fakeSettings.changeAutoSubmitButton()).called(2);
+  });
+
   testWidgets('Change log level', (widgetTester) async {
     FlutterError.onError = ignoreOverflowErrors;