Merge branch 'development'

Release 0.6.1

Author: TNorbury

.github/workflows/ci.yml

@@ -21,11 +21,12 @@ jobs:
     name: Lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-java@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-java@v3
         with:
-          java-version: '12.x'
-      - uses: actions/cache@v2
+          distribution: 'adopt'
+          java-version: '12'
+      - uses: actions/cache@v3
         with:
           path: /opt/hostedtoolcache/flutter
           key: ${{ github.ref }}-${{ env.flutter_version }}
@@ -43,11 +44,12 @@ jobs:
     name: Test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-java@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-java@v3
         with:
-          java-version: '12.x'
-      - uses: actions/cache@v2
+          distribution: 'adopt'
+          java-version: '12'
+      - uses: actions/cache@v3
         with:
           path: /opt/hostedtoolcache/flutter
           key: ${{ github.ref }}-${{ env.flutter_version }}

CHANGELOG.md

@@ -4,10 +4,20 @@ 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.6.1 - 2022-12-15
+### Added
+- Added `CommandPaletteStyle.barrierFilter`, which is an optional `ImageFilter` which can be used to add an effect (usually a blurring) behind the command palette when it's open
+
+### Changed
+- The default value of `CommandPaletteStyle.borderRadius` has been changed to `BorderRadius.all(Radius.circular(5))`
+
+### Fixed
+- `CommandPaletteStyle.borderRadius` now correctly applies to the border of the entire modal, and not just the part with the actions/instructions.
+
 ## 0.6.0 - 2022-12-10
 ### Fixed
 - Semi-Breaking: Changed the type of `CommandPaletteConfig.openKeySet` and `CommandPaletteConfig.closeKeySet` from `LogicalKeySet` to `ShortcutActivator` (note: `LogicalKeySet` already implements `ShortcutActivator`, so existing custom shortcuts should still work, but a proposed solution is discussed below). This was done to fix an issue on Web builds for MacOS (discussed [here](https://github.com/TNorbury/command_palette/issues/22)). If you don't set custom values for the open and close key sets (or if you're not targeting Web), then no change will be required on your part. But if you are, the following change is suggested to make sure everything works well: If you're opening the palette with a keyboard shortcut, such as CTRL/CMD+U, then you could go from `LogicalKeySet(LogicalKeyboardKey.control, LogicalKeyboardKey.keyU)`/`LogicalKeySet(LogicalKeyboardKey.meta, LogicalKeyboardKey.keyU)` to `SingleActivator(LogicalKeyboardKey.keyU, control: true)`/`SingleActivator(LogicalKeyboardKey.keyU, meta: true)`. This also changes how the command palette control shortcuts (Up/down/enter/backspace) are handled (from `LogicalKeySet` to `SingleActivator`). This should make things a bit cleaner on my end, and more stable going forward.
-- Escape query correctly so that single a '' don't cause filtering to crash
+- Escape query correctly so that single a '\\' don't cause filtering to crash
 
 ## 0.5.1 - 2022-12-02
 ### Added
@@ -61,4 +71,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/pubspec.lock

@@ -42,7 +42,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.6.0"
+    version: "0.6.1"
   fake_async:
     dependency: transitive
     description:

lib/src/command_palette.dart

@@ -1,6 +1,5 @@
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
-import 'package:flutter/services.dart';
 
 import '../command_palette.dart';
 import 'controller/command_palette_controller.dart';
@@ -209,6 +208,7 @@ class _CommandPaletteInnerState extends State<_CommandPaletteInner> {
       prefixNestedActions: styleToCopy.prefixNestedActions,
       instructionColor: styleToCopy.instructionColor ??
           newActionLabelTextStyle?.color?.withOpacity(.84),
+      barrierFilter: styleToCopy.barrierFilter,
     );
 
     widget.controller.style = _style;
@@ -267,6 +267,7 @@ class _CommandPaletteInnerState extends State<_CommandPaletteInner> {
             transitionCurve: widget.config.transitionCurve,
             transitionDuration: widget.config.transitionDuration,
             closeKeySet: widget.config.closeKeySet,
+            filter: widget.config.style?.barrierFilter,
           ),
         )
         .then(

lib/src/models/command_palette_style.dart

@@ -1,3 +1,5 @@
+import 'dart:ui';
+
 import 'package:flutter/material.dart';
 
 /// Used to style a [CommandPalette]
@@ -63,10 +65,7 @@ class CommandPaletteStyle {
   ///
   /// Defaults to
   /// ```
-  /// BorderRadius.only(
-  ///   bottomLeft: Radius.circular(5),
-  ///   bottomRight: Radius.circular(5),
-  /// )
+  /// BorderRadius.all(Radius.circular(5))
   /// ```
   final BorderRadiusGeometry borderRadius;
 
@@ -80,6 +79,10 @@ class CommandPaletteStyle {
   /// Defaults to `Colors.black12`
   final Color commandPaletteBarrierColor;
 
+  /// Filter to apply behind the command palette when it's open. It's used to set
+  /// [ModalRoute.filter].
+  final ImageFilter? barrierFilter;
+
   /// Decoration used for the text field
   ///
   /// Defaults to
@@ -114,15 +117,13 @@ class CommandPaletteStyle {
     this.highlightSearchSubstring = true,
     this.actionDescriptionTextStyle,
     this.elevation = 4.0,
-    this.borderRadius = const BorderRadius.only(
-      bottomLeft: Radius.circular(5),
-      bottomRight: Radius.circular(5),
-    ),
+    this.borderRadius = const BorderRadius.all(Radius.circular(5)),
     this.actionLabelTextAlign = TextAlign.left,
     this.commandPaletteBarrierColor = Colors.black12,
     this.textFieldInputDecoration,
     this.prefixNestedActions = true,
     this.instructionColor,
+    this.barrierFilter,
   });
 
   @override
@@ -142,7 +143,8 @@ class CommandPaletteStyle {
         other.commandPaletteBarrierColor == commandPaletteBarrierColor &&
         other.textFieldInputDecoration == textFieldInputDecoration &&
         other.prefixNestedActions == prefixNestedActions &&
-        other.instructionColor == instructionColor;
+        other.instructionColor == instructionColor &&
+        other.barrierFilter == barrierFilter;
   }
 
   @override
@@ -159,7 +161,8 @@ class CommandPaletteStyle {
         commandPaletteBarrierColor.hashCode ^
         textFieldInputDecoration.hashCode ^
         prefixNestedActions.hashCode ^
-        instructionColor.hashCode;
+        instructionColor.hashCode ^
+        barrierFilter.hashCode;
   }
 }
 

lib/src/widgets/command_palette_modal.dart

@@ -1,5 +1,7 @@
 // ignore_for_file: body_might_complete_normally_nullable
 
+import 'dart:ui';
+
 import 'package:command_palette/src/controller/command_palette_controller.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
@@ -43,8 +45,10 @@ class CommandPaletteModal extends ModalRoute<void> {
     required Duration transitionDuration,
     required Curve transitionCurve,
     required this.closeKeySet,
+    ImageFilter? filter,
   })  : _transitionDuration = transitionDuration,
-        _transitionCurve = transitionCurve;
+        _transitionCurve = transitionCurve,
+        super(filter: filter);
 
   @override
   Color? get barrierColor =>

lib/src/widgets/command_palette_text_field.dart

@@ -54,8 +54,8 @@ class _CommandPaletteTextFieldState extends State<CommandPaletteTextField> {
   Widget build(BuildContext context) {
     final CommandPaletteController controller =
         CommandPaletteControllerProvider.of(context);
-    InputDecoration inputDecoration =
-        controller.style.textFieldInputDecoration!;
+    final style = controller.style;
+    InputDecoration inputDecoration = style.textFieldInputDecoration!;
 
     // if no prefix was provided, the selected action is a nested action, and
     // the user indicates that they want nested actions to have prefix text,
@@ -64,7 +64,7 @@ class _CommandPaletteTextFieldState extends State<CommandPaletteTextField> {
         inputDecoration.prefixIcon == null &&
         inputDecoration.prefixText == null;
     if (styleHasNoPrefix &&
-        controller.style.prefixNestedActions &&
+        style.prefixNestedActions &&
         controller.currentlySelectedAction?.actionType ==
             CommandPaletteActionType.nested) {
       inputDecoration = inputDecoration.copyWith(
@@ -73,8 +73,13 @@ class _CommandPaletteTextFieldState extends State<CommandPaletteTextField> {
       );
     }
 
+    final radius = style.borderRadius.resolve(Directionality.of(context));
     return Material(
       elevation: 4,
+      borderRadius: BorderRadius.only(
+        topLeft: radius.topLeft,
+        topRight: radius.topRight,
+      ),
       child: TextField(
         controller: controller.textEditingController,
         textInputAction: TextInputAction.done,

lib/src/widgets/options/command_palette_body.dart

@@ -18,10 +18,14 @@ class CommandPaletteBody extends StatelessWidget {
     CommandPaletteController controller =
         CommandPaletteControllerProvider.of(context);
     List<CommandPaletteAction> actions = controller.getFilteredActions();
-
+    final borderRadius =
+        controller.style.borderRadius.resolve(Directionality.of(context));
     return Material(
       elevation: controller.style.elevation,
-      borderRadius: controller.style.borderRadius,
+      borderRadius: BorderRadius.only(
+        bottomLeft: borderRadius.bottomLeft,
+        bottomRight: borderRadius.bottomRight,
+      ),
       clipBehavior: Clip.antiAlias,
       child: Column(
         mainAxisSize: MainAxisSize.min,

pubspec.yaml

@@ -1,6 +1,6 @@
 name: command_palette
 description: Flutter implementation of the Command Palette. Can be brought up via a keyboard shortcut.
-version: 0.6.0
+version: 0.6.1
 homepage: https://github.com/TNorbury/command_palette
 issue_tracker: https://github.com/TNorbury/command_palette/issues
 repository: https://github.com/TNorbury/command_palette