Merge branch 'development'

Release 0.7.6

Author: TNorbury

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.7.6 - 2024-08-23
+### Added
+- The text used for the instructions bar is now user-configurable using the new `CommandPaletteInstructionConfig` object
+
+### Deprecated
+- `CommandPaletteConfig.showInstructions` is deprecated in favor of `CommandPaletteInstructionConfig.showInstructions`
+
 ## 0.7.5 - 2024-08-08
 ### Changed
 - Upgrade to Flutter 3.24

example/lib/main.dart

@@ -70,7 +70,9 @@ class _MyHomePageState extends State<MyHomePage> {
               //   LogicalKeyboardKey.keyC,
               // ),
 
-              showInstructions: true,
+              instructionConfig: CommandPaletteInstructionConfig(
+                showInstructions: true,
+              ),
             ),
             actions: [
               CommandPaletteAction.single(

example/pubspec.lock

@@ -47,7 +47,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.7.5"
+    version: "0.7.6"
   fake_async:
     dependency: transitive
     description:

lib/src/models/command_palette_config.dart

@@ -1,4 +1,3 @@
-// ignore_for_file: public_member_api_docs, sort_constructors_first
 import 'package:command_palette/src/controller/command_palette_controller.dart';
 import 'package:command_palette/src/widgets/options/command_palette_body.dart';
 import 'package:flutter/foundation.dart';
@@ -87,18 +86,15 @@ class CommandPaletteConfig {
 
   /// Whether or not to show the instructions bar at the bottom of the command
   /// palette modal, under all the options.
-  /// The current instructions tell the user how to user the modal with their
-  /// keyboard
   ///
-  /// The current instructions are:
-  /// * enter/return: to select, (or if an input action) to confirm
-  /// * up/down arrow: to navigate
-  /// * escape: to close
-  ///
-  /// When a nested action is selected:
-  /// * backspace: to cancel selected action
+  /// This option is deprecated, prefer to use [instructionConfig] and set its
+  /// property [CommandPaletteInstructionConfig.showInstructions]
   final bool showInstructions;
 
+  /// Configuration options for the instructions bar at the bottom of the
+  /// command palette
+  final CommandPaletteInstructionConfig instructionConfig;
+
   CommandPaletteConfig({
     ActionFilter? filter,
     Key? key,
@@ -115,11 +111,15 @@ class CommandPaletteConfig {
     this.right,
     this.height,
     this.width,
+    @Deprecated("Use CommandPaletteInstructionConfig.showInstructions instead")
     this.showInstructions = false,
+    CommandPaletteInstructionConfig? instructionConfig,
   })  : filter = filter ?? kDefaultFilter,
         builder = builder ?? kDefaultBuilder,
         openKeySet = openKeySet ?? _defaultOpenKeySet,
-        closeKeySet = closeKeySet ?? _defaultCloseKeySet;
+        closeKeySet = closeKeySet ?? _defaultCloseKeySet,
+        instructionConfig = instructionConfig ??
+            CommandPaletteInstructionConfig(showInstructions: showInstructions);
 
   @override
   bool operator ==(Object other) {
@@ -139,7 +139,9 @@ class CommandPaletteConfig {
         other.left == left &&
         other.right == right &&
         other.height == height &&
-        other.width == width;
+        other.width == width &&
+        other.showInstructions == showInstructions &&
+        other.instructionConfig == instructionConfig;
   }
 
   @override
@@ -157,6 +159,85 @@ class CommandPaletteConfig {
         left.hashCode ^
         right.hashCode ^
         height.hashCode ^
-        width.hashCode;
+        width.hashCode ^
+        showInstructions.hashCode ^
+        instructionConfig.hashCode;
+  }
+}
+
+/// Configures the text and visibility of the instructions bar at the bottom of
+/// the command palette
+/// The current instructions tell the user how to user the modal with their
+/// keyboard
+///
+/// The current instructions are:
+/// * enter/return: to select, (or if an input action) to confirm
+/// * up/down arrow: to navigate
+/// * escape: to close
+///
+/// When a nested action is selected:
+/// * backspace: to cancel selected action
+class CommandPaletteInstructionConfig {
+  /// Default value is "to confirm".
+  /// Used with [CommandPaletteActionType.input] type actions to indicate to the
+  /// user that the currently entered text can be submitted with the
+  /// return/enter key
+  final String confirmLabel;
+
+  /// Default value is "to select"
+  /// Appears for all non input type action to indicate to the user that hitting
+  /// the return/enter key will select the currently highlighted action
+  final String selectLabel;
+
+  /// Default value is "to navigate"
+  /// Tells the user the the up and down arrow keys can be used to highlight
+  /// different actions in the command palette
+  final String navigationLabel;
+
+  /// Default value is "to cancel selected action".
+  /// Used with [CommandPaletteActionType.input] and
+  /// [CommandPaletteActionType.nested] type actions, after that action has been
+  /// select. Tells the user that pressing back-space will unselect the
+  /// currently selected action
+  final String cancelSelectedLabel;
+
+  /// Default value is "to close"
+  /// Tells the user that the ESC key will close the command palette
+  final String closeLabel;
+
+  /// Whether or not to show the instructions bar at the bottom of the command
+  /// palette modal, under all the options.
+  final bool showInstructions;
+
+  const CommandPaletteInstructionConfig({
+    this.confirmLabel = "to confirm",
+    this.selectLabel = "to select",
+    this.navigationLabel = "to navigate",
+    this.cancelSelectedLabel = "to cancel selected action",
+    this.closeLabel = "to close",
+    this.showInstructions = false,
+  });
+
+  @override
+  bool operator ==(Object other) {
+    if (identical(this, other)) return true;
+
+    return other is CommandPaletteInstructionConfig &&
+        other.confirmLabel == confirmLabel &&
+        other.selectLabel == selectLabel &&
+        other.navigationLabel == navigationLabel &&
+        other.cancelSelectedLabel == cancelSelectedLabel &&
+        other.closeLabel == closeLabel &&
+        other.showInstructions == showInstructions;
+  }
+
+  @override
+  int get hashCode {
+    return confirmLabel.hashCode ^
+        selectLabel.hashCode ^
+        navigationLabel.hashCode ^
+        cancelSelectedLabel.hashCode ^
+        closeLabel.hashCode ^
+        showInstructions.hashCode;
   }
 }

lib/src/widgets/command_palette_instructions.dart

@@ -13,6 +13,7 @@ class CommandPaletteInstructions extends StatelessWidget {
         CommandPaletteControllerProvider.of(context);
     final outline = Theme.of(context).dividerColor;
     var color = controller.style.instructionColor;
+    final instructionConfig = controller.config.instructionConfig;
     return Container(
       margin: const EdgeInsets.all(8.0),
       padding: const EdgeInsets.only(top: 8),
@@ -38,8 +39,8 @@ class CommandPaletteInstructions extends StatelessWidget {
                   instruction:
                       (controller.currentlySelectedAction?.actionType ==
                               CommandPaletteActionType.input)
-                          ? "to confirm"
-                          : "to select",
+                          ? instructionConfig.confirmLabel
+                          : instructionConfig.selectLabel,
                 ),
                 if (controller.currentlySelectedAction?.actionType !=
                     CommandPaletteActionType.input)
@@ -54,7 +55,7 @@ class CommandPaletteInstructions extends StatelessWidget {
                         color: color,
                       ),
                     ],
-                    instruction: "to navigate",
+                    instruction: instructionConfig.navigationLabel,
                   ),
                 if (controller.currentlySelectedAction != null)
                   _KeyboardInstruction(
@@ -64,7 +65,7 @@ class CommandPaletteInstructions extends StatelessWidget {
                         color: color,
                       ),
                     ],
-                    instruction: "to cancel selected action",
+                    instruction: instructionConfig.cancelSelectedLabel,
                   ),
                 _KeyboardInstruction(
                   icons: [
@@ -73,7 +74,7 @@ class CommandPaletteInstructions extends StatelessWidget {
                       color: color,
                     ),
                   ],
-                  instruction: "to close",
+                  instruction: instructionConfig.closeLabel,
                 ),
               ],
             ),

lib/src/widgets/options/command_palette_body.dart

@@ -95,7 +95,7 @@ class _CommandPaletteBodyState extends State<CommandPaletteBody> {
               },
             ),
           ),
-          if (controller.config.showInstructions)
+          if (controller.config.instructionConfig.showInstructions)
             const CommandPaletteInstructions(),
         ],
       ),

pubspec.lock

@@ -58,10 +58,10 @@ packages:
     dependency: "direct dev"
     description:
       name: flutter_lints
-      sha256: e2a421b7e59244faef694ba7b30562e489c2b489866e505074eb005cd7060db7
+      sha256: "3f41d009ba7172d5ff9be5f6e6e6abb4300e263aab8866d2a0842ed2a70f8f0c"
       url: "https://pub.dev"
     source: hosted
-    version: "3.0.1"
+    version: "4.0.0"
   flutter_test:
     dependency: "direct dev"
     description: flutter
@@ -95,10 +95,10 @@ packages:
     dependency: transitive
     description:
       name: lints
-      sha256: cbf8d4b858bb0134ef3ef87841abdf8d63bfc255c266b7bf6b39daa1085c4290
+      sha256: "976c774dd944a42e83e2467f4cc670daef7eed6295b10b36ae8c85bcbf828235"
       url: "https://pub.dev"
     source: hosted
-    version: "3.0.0"
+    version: "4.0.0"
   matcher:
     dependency: transitive
     description:

pubspec.yaml

@@ -1,6 +1,6 @@
 name: command_palette
 description: Flutter implementation of a Command Palette. Can be brought up via a keyboard shortcut.
-version: 0.7.5
+version: 0.7.6
 homepage: https://github.com/TNorbury/command_palette
 issue_tracker: https://github.com/TNorbury/command_palette/issues
 repository: https://github.com/TNorbury/command_palette
@@ -26,7 +26,7 @@ dependencies:
 dev_dependencies:
   flutter_test:
     sdk: flutter
-  flutter_lints: ^3.0.1
+  flutter_lints: ^4.0.0
 
 flutter:
 

test/command_palette_instructions_test.dart

@@ -21,7 +21,11 @@ void main() {
         [
           action,
         ],
-        config: CommandPaletteConfig(showInstructions: true),
+        config: CommandPaletteConfig(
+          instructionConfig: const CommandPaletteInstructionConfig(
+            showInstructions: true,
+          ),
+        ),
       );
 
       controller.currentlySelectedAction = action;
@@ -49,7 +53,11 @@ void main() {
             ],
           ),
         ],
-        config: CommandPaletteConfig(showInstructions: true),
+        config: CommandPaletteConfig(
+          instructionConfig: const CommandPaletteInstructionConfig(
+            showInstructions: true,
+          ),
+        ),
       );
 
       await tester.pumpWidget(

test/command_palette_options_test.dart

@@ -148,7 +148,11 @@ void main() {
       // setting flag will show instructions
       await tester.pumpWidget(
         MyApp(
-          config: CommandPaletteConfig(showInstructions: true),
+          config: CommandPaletteConfig(
+            instructionConfig: const CommandPaletteInstructionConfig(
+              showInstructions: true,
+            ),
+          ),
           actions: [
             CommandPaletteAction.single(
               label: "Action 1",