Breaking change: Changed from ListView to CollectionView in BookmarksView which resolves ItemTemplate issue in iOS

src/Samples/Toolkit.SampleApp.Maui/Samples/BookmarksViewSample.xaml

@@ -10,12 +10,10 @@
              x:Class="Toolkit.SampleApp.Maui.Samples.BookmarksViewSample">
     <ContentPage.Resources>
         <DataTemplate x:Key="ItemTemplateOne">
-            <TextCell Text="{Binding Name}" TextColor="Red" />
+            <Label Text="{Binding Name}" TextColor="Red" />
         </DataTemplate>
         <DataTemplate x:Key="ItemTemplateTwo">
-            <ViewCell>
-                <Label BackgroundColor="Red" TextColor="White" Text="{Binding Name}" />
-            </ViewCell>
+            <Label BackgroundColor="Red" TextColor="White" Text="{Binding Name}" />
         </DataTemplate>
     </ContentPage.Resources>
     <ContentPage.Content>

src/Toolkit/Toolkit.Maui/BookmarksView/BookmarksView.cs

@@ -14,6 +14,7 @@
 //  *   limitations under the License.
 //  ******************************************************************************/
 using Esri.ArcGISRuntime.Mapping;
+using System.Collections.Specialized;
 using System.Diagnostics.CodeAnalysis;
 
 namespace Esri.ArcGISRuntime.Toolkit.Maui;
@@ -24,8 +25,8 @@ namespace Esri.ArcGISRuntime.Toolkit.Maui;
 /// </summary>
 public class BookmarksView : TemplatedView
 {
-    private ListView? _presentingView;
     private BookmarksViewDataSource _dataSource = new BookmarksViewDataSource();
+    private const string _presentingViewName = "PresentingView";
 
     private static readonly DataTemplate DefaultDataTemplate;
     private static readonly ControlTemplate DefaultControlTemplate;
@@ -35,18 +36,17 @@ static BookmarksView()
     {
         DefaultDataTemplate = new DataTemplate(() =>
         {
-            var defaultCell = new TextCell();
-            defaultCell.SetBinding(TextCell.TextProperty, nameof(Bookmark.Name));
-            return defaultCell;
+            var defaultLabel = new Label();
+            defaultLabel.SetBinding(Label.TextProperty, nameof(Bookmark.Name));
+            return defaultLabel;
         });
 
-        string template = @"<ControlTemplate xmlns=""http://schemas.microsoft.com/dotnet/2021/maui"" xmlns:x=""http://schemas.microsoft.com/winfx/2009/xaml"" xmlns:esriTK=""clr-namespace:Esri.ArcGISRuntime.Toolkit.Maui"">
-                                    <ListView x:Name=""PresentingView"" HorizontalOptions=""FillAndExpand"" VerticalOptions=""FillAndExpand"">
-                                        <x:Arguments>
-                                            <ListViewCachingStrategy>RecycleElement</ListViewCachingStrategy>
-                                        </x:Arguments>
-                                    </ListView>
-                                </ControlTemplate>";
+        string template =
+            $@"<ControlTemplate xmlns=""http://schemas.microsoft.com/dotnet/2021/maui""
+                               xmlns:x=""http://schemas.microsoft.com/winfx/2009/xaml""
+                               xmlns:esriTK=""clr-namespace:Esri.ArcGISRuntime.Toolkit.Maui"">
+                <CollectionView x:Name=""{_presentingViewName}"" SelectionMode=""Single"" />
+             </ControlTemplate>";
         DefaultControlTemplate = Microsoft.Maui.Controls.Xaml.Extensions.LoadFromXaml(new ControlTemplate(), template);
     }
 
@@ -56,8 +56,11 @@ static BookmarksView()
     public BookmarksView()
     {
         ItemTemplate = DefaultDataTemplate;
-
         ControlTemplate = DefaultControlTemplate;
+#if ANDROID
+        // This Fixes a bug with Android adding item couple of times when new Bookmark is added to BookmarkCollection.
+        _dataSource.CollectionChanged += OnBookmarksCollectionChanged; 
+#endif
     }
 
     /// <summary>
@@ -66,20 +69,7 @@ public BookmarksView()
     protected override void OnApplyTemplate()
     {
         base.OnApplyTemplate();
-
-        if (_presentingView != null)
-        {
-            _presentingView.ItemSelected -= Internal_bookmarkSelected;
-        }
-
-        _presentingView = GetTemplateChild("PresentingView") as ListView;
-
-        if (_presentingView != null)
-        {
-            _presentingView.ItemSelected += Internal_bookmarkSelected;
-            _presentingView.ItemTemplate = ItemTemplate;
-            _presentingView.ItemsSource = _dataSource;
-        }
+        UpdateListView();
     }
 
     /// <summary>
@@ -157,19 +147,7 @@ private static void GeoViewChanged(BindableObject sender, object? oldValue, obje
     private static void ItemTemplateChanged(BindableObject sender, object? oldValue, object? newValue)
     {
         BookmarksView bookmarkView = (BookmarksView)sender;
-
-        if (bookmarkView._presentingView != null)
-        {
-            bookmarkView._presentingView.ItemTemplate = newValue as DataTemplate;
-
-#if WINDOWS
-            // This workaround addresses an issue with MAUI WinUI. 
-            // Without refreshing the items source of the BookmarksView ListView the change is not reflected in the UI.
-            var existingItems = bookmarkView._presentingView.ItemsSource;
-            bookmarkView._presentingView.ItemsSource = null;
-            bookmarkView._presentingView.ItemsSource = existingItems;
-#endif
-        }
+        bookmarkView.UpdateListView();
     }
 
     /// <summary>
@@ -192,16 +170,36 @@ private void SelectAndNavigateToBookmark(Bookmark bookmark)
     /// <summary>
     /// Handles selection on the underlying list view.
     /// </summary>
-    private void Internal_bookmarkSelected(object? sender, SelectedItemChangedEventArgs e)
+    private void Internal_bookmarkSelected(object? sender, SelectionChangedEventArgs e)
+    {
+        if (sender is CollectionView cv)
+        {
+            if (cv.SelectedItem is Bookmark item)
+            {
+                SelectAndNavigateToBookmark(item);
+            }
+            cv.ClearValue(CollectionView.SelectedItemProperty);
+        }
+    }
+
+    private void UpdateListView()
     {
-        if (e.SelectedItem is Bookmark bm)
+        var collection = (CollectionView)GetTemplateChild(_presentingViewName);
+        if (collection != null)
         {
-            SelectAndNavigateToBookmark(bm);
+            collection.SelectionChanged -= Internal_bookmarkSelected;
+            collection.SelectionChanged += Internal_bookmarkSelected;
+            collection.ItemTemplate = null;
+            collection.ItemTemplate = ItemTemplate;
+            collection.ItemsSource = _dataSource;
         }
+    }
 
-        if (e.SelectedItem != null && sender is ListView lv)
+    private void OnBookmarksCollectionChanged(object? sender, NotifyCollectionChangedEventArgs e)
+    {
+        if (e.Action is NotifyCollectionChangedAction.Add)
         {
-            lv.SelectedItem = null;
+            UpdateListView();
         }
     }