Merge branch 'development'

0.7.4

Author: TNorbury

.github/workflows/ci.yml

@@ -8,10 +8,7 @@ on:
       - main
       - development
   pull_request:
-    types:
-      - ready_for_review
-      - synchronize
-      - opened
+    types: [synchronize, opened, reopened]
 
 env:
   flutter_version: 3.10.0

CHANGELOG.md

@@ -4,6 +4,11 @@ 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.4 - 2023-10-30
+### Added
+- Add FocusNode parameter which is passed to underlying Focus widget
+- Added input as a type for an action. This type of action will give the user a text field and accept the processed text, passing it to a callback
+
 ## 0.7.3 - 2023-05-12
 ### Changed
 - Upgrade to Flutter 3.10.0
@@ -91,4 +96,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## 0.1.0 - 2021-11-03
 ### Added
-- initial release
+- initial release

example/lib/main.dart

@@ -99,6 +99,16 @@ class _MyHomePageState extends State<MyHomePage> {
                   ),
                 ],
               ),
+              CommandPaletteAction.input(
+                id: "new-user",
+                label: "New User",
+                shortcut: ["ctrl", "shift", "n"],
+                leading: Icon(Icons.add),
+                onConfirmInput: (value) {
+                  ScaffoldMessenger.of(context).showSnackBar(
+                      SnackBar(content: Text('Created user: $value')));
+                },
+              ),
               CommandPaletteAction.nested(
                 id: 1, // or numbers (or really anything...)
                 label: "Set User",

example/pubspec.lock

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

lib/src/command_palette.dart

@@ -24,6 +24,8 @@ class CommandPalette extends InheritedWidget {
   /// functional configuration
   final CommandPaletteConfig config;
 
+  final FocusNode? focusNode;
+
   late final _CommandPaletteToggler _toggler;
 
   late final CommandPaletteController _controller;
@@ -33,6 +35,7 @@ class CommandPalette extends InheritedWidget {
     CommandPaletteConfig? config,
     required this.actions,
     required Widget child,
+    this.focusNode,
   })  : config = config ?? CommandPaletteConfig(),
         super(
           key: key,
@@ -45,6 +48,7 @@ class CommandPalette extends InheritedWidget {
             ),
             config: config ?? CommandPaletteConfig(),
             toggler: _CommandPaletteToggler(false),
+            focusNode: focusNode,
             child: child,
           ),
         ) {
@@ -109,14 +113,15 @@ class _CommandPaletteInner extends StatefulWidget {
   final CommandPaletteConfig config;
   final _CommandPaletteToggler toggler;
   final CommandPaletteController controller;
-
+  final FocusNode? focusNode;
   const _CommandPaletteInner({
     Key? key,
     required this.child,
     required this.actions,
     required this.config,
     required this.toggler,
     required this.controller,
+    required this.focusNode,
   }) : super(key: key);
 
   @override
@@ -239,6 +244,7 @@ class _CommandPaletteInnerState extends State<_CommandPaletteInner> {
                 )
               },
               child: Focus(
+                focusNode: widget.focusNode,
                 autofocus: true,
                 child: widget.child,
               ),

lib/src/controller/command_palette_controller.dart

@@ -85,6 +85,10 @@ class CommandPaletteController extends ChangeNotifier {
 
   /// Listens to [textEditingController] and is called whenever it changes.
   void _onTextControllerChange() {
+    if (currentlySelectedAction?.actionType == CommandPaletteActionType.input) {
+      return;
+    }
+
     if (_enteredQuery != textEditingController.text) {
       _enteredQuery = textEditingController.text;
       _actionsNeedRefiltered = true;
@@ -96,7 +100,8 @@ class CommandPaletteController extends ChangeNotifier {
   CommandPaletteAction? get currentlySelectedAction => _currentlySelectedAction;
   set currentlySelectedAction(CommandPaletteAction? newAction) {
     assert(newAction == null ||
-        newAction.actionType == CommandPaletteActionType.nested);
+        newAction.actionType == CommandPaletteActionType.nested ||
+        newAction.actionType == CommandPaletteActionType.input);
     _currentlySelectedAction = newAction;
     _actionsNeedRefiltered = true;
     textEditingController.clear();
@@ -118,6 +123,9 @@ class CommandPaletteController extends ChangeNotifier {
       if (currentlySelectedAction?.actionType ==
           CommandPaletteActionType.nested) {
         filteredActions = currentlySelectedAction!.childrenActions!;
+      } else if (currentlySelectedAction?.actionType ==
+          CommandPaletteActionType.input) {
+        filteredActions = [];
       } else {
         filteredActions = actions;
       }
@@ -193,14 +201,26 @@ class CommandPaletteController extends ChangeNotifier {
 
     // nested items we set this item as the selected which in turn
     // will display its children.
-    else if (action.actionType == CommandPaletteActionType.nested) {
+    else {
       currentlySelectedAction = action;
     }
   }
 
+  void handleActionInput(BuildContext context) {
+    _currentlySelectedAction?.onConfirmInput!(textEditingController.text);
+    if (Navigator.of(context).canPop()) {
+      Navigator.of(context).pop();
+    }
+  }
+
   /// performs the action which is currently selected by [highlightedAction]
   void performHighlightedAction(BuildContext context) {
-    handleAction(context, action: _filteredActionsCache[highlightedAction]);
+    if (_currentlySelectedAction?.actionType ==
+        CommandPaletteActionType.input) {
+      handleActionInput(context);
+    } else {
+      handleAction(context, action: _filteredActionsCache[highlightedAction]);
+    }
   }
 }
 

lib/src/models/command_palette_action.dart

@@ -8,7 +8,11 @@ enum CommandPaletteActionType {
 
   /// Upon being selected a nested action will change the state of the command
   /// palette so that it only shows its children
-  nested
+  nested,
+
+  /// Upon being selected the user will be given a text field that they can enter text into and submit.
+  /// The entered text will then be passed to the relevant callback
+  input
 }
 
 /// Action that is presented in the command palette. These are the things the
@@ -25,6 +29,10 @@ class CommandPaletteAction {
   /// Specifies what type of action this is
   final CommandPaletteActionType actionType;
 
+  /// Required when [actionType] set to [CommandPaletteActionType.input]. This
+  /// function is called when the action is confirmed
+  ValueChanged<String>? onConfirmInput;
+
   /// Required when [actionType] set to [CommandPaletteActionType.single]. This
   /// function is called when the action is selected
   VoidCallback? onSelect;
@@ -68,13 +76,16 @@ class CommandPaletteAction {
     required this.actionType,
     this.onSelect,
     this.childrenActions,
+    this.onConfirmInput,
     this.shortcut,
     this.id,
     this.leading,
   }) : assert((actionType == CommandPaletteActionType.single &&
                 onSelect != null) ||
             (actionType == CommandPaletteActionType.nested &&
-                (childrenActions?.isNotEmpty ?? false))) {
+                (childrenActions?.isNotEmpty ?? false)) ||
+            (actionType == CommandPaletteActionType.input &&
+                (onConfirmInput != null))) {
     // give all our children "us" as a parent.
     if (actionType == CommandPaletteActionType.nested) {
       for (final child in childrenActions!) {
@@ -106,6 +117,15 @@ class CommandPaletteAction {
     }
   }
 
+  CommandPaletteAction.input({
+    required this.label,
+    this.description,
+    required this.onConfirmInput,
+    this.shortcut,
+    this.id,
+    this.leading,
+  }) : actionType = CommandPaletteActionType.input;
+
   @override
   bool operator ==(Object other) {
     if (identical(this, other)) return true;

lib/src/models/command_palette_config.dart

@@ -91,7 +91,7 @@ class CommandPaletteConfig {
   /// keyboard
   ///
   /// The current instructions are:
-  /// * enter/return: to select
+  /// * enter/return: to select, (or if an input action) to confirm
   /// * up/down arrow: to navigate
   /// * escape: to close
   ///

lib/src/models/matched_command_palette_action.dart

@@ -13,6 +13,7 @@ class MatchedCommandPaletteAction extends CommandPaletteAction {
           childrenActions: action.childrenActions,
           description: action.description,
           onSelect: action.onSelect,
+          onConfirmInput: action.onConfirmInput,
           shortcut: action.shortcut,
           id: action.id,
           leading: action.leading,

lib/src/widgets/command_palette_instructions.dart

@@ -1,4 +1,5 @@
 import 'package:command_palette/src/controller/command_palette_controller.dart';
+import 'package:command_palette/src/models/command_palette_action.dart';
 import 'package:command_palette/src/widgets/keyboard_key_icon.dart';
 import 'package:flutter/material.dart';
 
@@ -34,21 +35,27 @@ class CommandPaletteInstructions extends StatelessWidget {
                       color: color,
                     ),
                   ],
-                  instruction: "to select",
-                ),
-                _KeyboardInstruction(
-                  icons: [
-                    KeyboardKeyIcon(
-                      icon: Icons.arrow_upward,
-                      color: color,
-                    ),
-                    KeyboardKeyIcon(
-                      icon: Icons.arrow_downward,
-                      color: color,
-                    ),
-                  ],
-                  instruction: "to navigate",
+                  instruction:
+                      (controller.currentlySelectedAction?.actionType ==
+                              CommandPaletteActionType.input)
+                          ? "to confirm"
+                          : "to select",
                 ),
+                if (controller.currentlySelectedAction?.actionType !=
+                    CommandPaletteActionType.input)
+                  _KeyboardInstruction(
+                    icons: [
+                      KeyboardKeyIcon(
+                        icon: Icons.arrow_upward,
+                        color: color,
+                      ),
+                      KeyboardKeyIcon(
+                        icon: Icons.arrow_downward,
+                        color: color,
+                      ),
+                    ],
+                    instruction: "to navigate",
+                  ),
                 if (controller.currentlySelectedAction != null)
                   _KeyboardInstruction(
                     icons: [