feat: add itemBorderRadius and wrap itemBuilder with IgnorePointer

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).
 
+## [Unreleased]
+### Added
+- `itemBorderRadius` parameter to `TypeAheadField` and `CupertinoTypeAheadField` (#584)
+
+### Fixed
+- Mouse cursor doesn't change to pointer-hand when ListTile is returned in itemBuilder (#584)
+
 ## 5.2.0 - 2024-02-08
 ### Added
 - force refreshing suggestions with `SuggestionsController.refresh`

README.md

@@ -44,6 +44,7 @@ TypeAheadField<City>(
       )
     );
   },
+  itemBorderRadius: BorderRadius.circular(8),
   itemBuilder: (context, city) {
     return ListTile(
       title: Text(city.name),
@@ -257,6 +258,8 @@ You must then specify the following parameters:
 
 As well as all the usual parameters, such as `suggestionsCallback`, `onSelected`, etc.
 
+If you want to set border radius to the suggestion items, doing it inside `itemBuilder` probably won't work. Use `itemBorderRadius` parameter instead.
+
 The `decorationBuilder` can be used to inject required wrappers like `Material` or `DefaultTextStyle`.
 For more information, see the source code of the `TypeAheadField` widget.
 

example/lib/main.dart

@@ -92,6 +92,7 @@ class ExampleTypeAhead extends StatelessWidget
                   borderRadius: borderRadius,
                   child: child,
                 ),
+                itemBorderRadius: BorderRadius.circular(8),
                 itemBuilder: (context, product) => ListTile(
                   title: Text(product.name),
                   subtitle: product.description != null
@@ -224,6 +225,7 @@ class CupertinoExampleTypeAhead extends StatelessWidget
                   ),
                   child: child,
                 ),
+                itemBorderRadius: BorderRadius.circular(8),
                 itemBuilder: (context, product) => CupertinoListTile(
                   title: Text(product.name),
                   subtitle: product.description != null

example/lib/settings.dart

@@ -42,6 +42,7 @@ class SettingsTypeAhead extends StatelessWidget
                 hintText: hintText,
               ),
             ),
+            itemBorderRadius: BorderRadius.circular(8),
             itemBuilder: (context, setting) {
               if (setting is ToggleFieldOption) {
                 IconData? icon = setting.value
@@ -125,6 +126,7 @@ class CupertinoSettingsTypeAhead extends StatelessWidget
                         fontStyle: FontStyle.italic,
                       ),
             ),
+            itemBorderRadius: BorderRadius.circular(8),
             itemBuilder: (context, setting) {
               if (setting is ToggleFieldOption) {
                 return CupertinoListTile(

lib/src/cupertino/cupertino_defaults.dart

@@ -50,14 +50,18 @@ abstract final class TypeAheadCupertinoDefaults {
   /// Provides the functionality to select an item on tap.
   static SuggestionsItemBuilder<T> itemBuilder<T>(
     SuggestionsItemBuilder<T> builder,
+    BorderRadius itemBorderRadius,
   ) {
     return (context, item) {
-      return FocusableActionDetector(
-        mouseCursor: SystemMouseCursors.click,
-        child: GestureDetector(
-          behavior: HitTestBehavior.opaque,
-          child: builder(context, item),
-          onTap: () => SuggestionsController.of<T>(context).select(item),
+      return ClipRRect(
+        borderRadius: itemBorderRadius,
+        child: FocusableActionDetector(
+          mouseCursor: SystemMouseCursors.click,
+          child: GestureDetector(
+            behavior: HitTestBehavior.opaque,
+            child: IgnorePointer(child: builder(context, item)),
+            onTap: () => SuggestionsController.of<T>(context).select(item),
+          ),
         ),
       );
     };

lib/src/cupertino/typeahead_field.dart

@@ -29,6 +29,7 @@ class CupertinoTypeAheadField<T> extends RawTypeAheadField<T> {
     super.hideOnUnfocus,
     super.hideWithKeyboard,
     super.hideOnSelect,
+    BorderRadius itemBorderRadius = BorderRadius.zero,
     required SuggestionsItemBuilder<T> itemBuilder,
     super.itemSeparatorBuilder,
     super.retainOnLoading,
@@ -49,7 +50,8 @@ class CupertinoTypeAheadField<T> extends RawTypeAheadField<T> {
           loadingBuilder:
               loadingBuilder ?? TypeAheadCupertinoDefaults.loadingBuilder,
           emptyBuilder: emptyBuilder ?? TypeAheadCupertinoDefaults.emptyBuilder,
-          itemBuilder: TypeAheadCupertinoDefaults.itemBuilder(itemBuilder),
+          itemBuilder: TypeAheadCupertinoDefaults.itemBuilder(
+              itemBuilder, itemBorderRadius),
           decorationBuilder:
               TypeAheadCupertinoDefaults.wrapperBuilder(decorationBuilder),
         );

lib/src/material/material_defaults.dart

@@ -47,12 +47,14 @@ abstract final class TypeAheadMaterialDefaults {
   /// Provides the functionality to select an item on tap.
   static SuggestionsItemBuilder<T> itemBuilder<T>(
     SuggestionsItemBuilder<T> builder,
+    BorderRadius itemBorderRadius,
   ) {
     return (context, item) {
       return InkWell(
+        borderRadius: itemBorderRadius,
         focusColor: Theme.of(context).hoverColor,
         onTap: () => SuggestionsController.of<T>(context).select(item),
-        child: builder(context, item),
+        child: IgnorePointer(child: builder(context, item)),
       );
     };
   }

lib/src/material/typeahead_field.dart

@@ -29,6 +29,7 @@ class TypeAheadField<T> extends RawTypeAheadField<T> {
     super.hideOnUnfocus,
     super.hideWithKeyboard,
     super.hideOnSelect,
+    BorderRadius itemBorderRadius = BorderRadius.zero,
     required SuggestionsItemBuilder<T> itemBuilder,
     super.itemSeparatorBuilder,
     super.retainOnLoading,
@@ -49,7 +50,8 @@ class TypeAheadField<T> extends RawTypeAheadField<T> {
           loadingBuilder:
               loadingBuilder ?? TypeAheadMaterialDefaults.loadingBuilder,
           emptyBuilder: emptyBuilder ?? TypeAheadMaterialDefaults.emptyBuilder,
-          itemBuilder: TypeAheadMaterialDefaults.itemBuilder(itemBuilder),
+          itemBuilder: TypeAheadMaterialDefaults.itemBuilder(
+              itemBuilder, itemBorderRadius),
           decorationBuilder:
               TypeAheadMaterialDefaults.wrapperBuilder(decorationBuilder),
         );