[dev-v5][DataGrid] Add a SelectColumn Comparer property

src/Core.Scripts/Microsoft.FluentUI.AspNetCore.Components.Scripts.esproj

@@ -1,8 +1,9 @@
-<Project Sdk="Microsoft.VisualStudio.JavaScript.Sdk/1.0.3804879">
+<Project Sdk="Microsoft.VisualStudio.JavaScript.Sdk/1.0.4110890">
   <PropertyGroup>
     <DebugAssetsDirectory>dist\</DebugAssetsDirectory>
     <StaticWebAssetSourceId>Microsoft.FluentUI.AspNetCore.Components</StaticWebAssetSourceId>
     <IsPackable>false</IsPackable>
+    <ShouldRunNpmAudit>false</ShouldRunNpmAudit>
     <BuildCommand>npm run build</BuildCommand>
     <CleanCommand>npm run clean</CleanCommand>
   </PropertyGroup>

src/Core/Components/DataGrid/Columns/SelectColumn.cs

@@ -221,6 +221,15 @@ public DataGridSelectMode SelectMode
     [Parameter]
     public override IGridSort<TGridItem>? SortBy { get; set; } = null;
 
+    /// <summary>
+    /// Gets or sets the equality comparer used to determine whether two grid items are equal.
+    /// </summary>
+    /// <remarks>If not set, the default equality comparer for <typeparamref name="TGridItem"/> is used.
+    /// Setting this property allows customization of how grid items are compared for equality, which can affect
+    /// operations such as selection, filtering, or updating items in the grid.</remarks>
+    [Parameter]
+    public IEqualityComparer<TGridItem>? Comparer { get; set; } = null;
+
     /// <summary>
     /// Allows to clear the selection.
     /// </summary>
@@ -310,14 +319,23 @@ private async Task AddOrRemoveSelectedItemAsync(TGridItem? item)
     {
         if (item != null && (Selectable == null || Selectable.Invoke(item)))
         {
-            if (SelectMode is DataGridSelectMode.SingleSticky && _selectedItems.Contains(item))
+            if (_selectedItems.Contains(item, Comparer))
             {
-                return;
-            }
+                if (SelectMode is DataGridSelectMode.SingleSticky)
+                {
+                    return;
+                }
+
+                if (Comparer != null)
+                {
+                    var toRemove = _selectedItems.First(i => Comparer.Equals(i, item));
+                    _selectedItems.Remove(toRemove);
+                }
+                else
+                {
+                    _selectedItems.Remove(item);
+                }
 
-            if (SelectedItems.Contains(item))
-            {
-                _selectedItems.Remove(item);
                 SelectAll = false;
                 await CallOnSelectAsync(item, isSelected: false);
             }
@@ -356,12 +374,12 @@ Task CallOnSelectAsync(TGridItem item, bool isSelected)
     private async Task UpdateSelectedItemsAsync()
     {
 
-        if (!SelectedItems.Any() || InternalGridContext == null || InternalGridContext.Items == null)
+        if (_selectedItems.Count == 0 || InternalGridContext == null || InternalGridContext.Items == null)
         {
             return;
         }
 
-        var itemsToRemove = _selectedItems.Where(item => !InternalGridContext.Items.Contains(item)).ToList();
+        var itemsToRemove = _selectedItems.Where(item => !InternalGridContext.Items.Contains(item, Comparer)).ToList();
         foreach (var item in itemsToRemove)
         {
             await AddOrRemoveSelectedItemAsync(item);
@@ -427,15 +445,16 @@ private RenderFragment<TGridItem> GetDefaultChildContent()
                 return;
             }
 
-            var selected = _selectedItems.Contains(item) || Property.Invoke(item);
+            var contained = _selectedItems.Contains(item, Comparer);
+            var selected = contained || Property.Invoke(item);
 
             // Sync with SelectedItems list
-            if (selected && !_selectedItems.Contains(item))
+            if (selected && !contained)
             {
                 _selectedItems.Add(item);
                 RefreshHeaderContent();
             }
-            else if (!selected && _selectedItems.Contains(item))
+            else if (!selected && contained)
             {
                 _selectedItems.Remove(item);
             }
@@ -524,12 +543,12 @@ private void RefreshHeaderContent()
         // Using SelectedItems only
         if (InternalGridContext != null && (Grid.Items != null || Grid.ItemsProvider != null))
         {
-            if (!SelectedItems.Any())
+            if (_selectedItems.Count == 0)
             {
                 return false;
             }
 
-            if (SelectedItems.Take(InternalGridContext.TotalItemCount + 1).Count() == InternalGridContext.TotalItemCount || SelectAll == true)
+            if (_selectedItems.Count == InternalGridContext.TotalItemCount || SelectAll == true)
             {
                 return true;
             }
@@ -570,13 +589,13 @@ internal async Task OnClickAllAsync(MouseEventArgs e)
             await SelectAllChanged.InvokeAsync(SelectAll);
         }
 
-        var count = SelectedItems.Count();
+        var count = _selectedItems.Count;
         // SelectedItems
         _selectedItems.Clear();
         if (SelectAll == true && count != InternalGridContext.TotalItemCount)
         {
             // Only add selectable items
-            _selectedItems.AddRange((InternalGridContext.Grid.Items?.ToList() ?? InternalGridContext.Items)
+            _selectedItems.AddRange(InternalGridContext.Items
                 .Where(item => Selectable?.Invoke(item) ?? true)
             );
         }

tests/Core/Components/DataGrid/SelectColumnTests.razor

@@ -76,8 +76,6 @@
         Assert.Single(SelectedItems);
     }
 
-
-
     [Fact]
     public async Task SelectColumnTests_Selectable_SingleSelect_SelectedItems()
     {
@@ -1099,7 +1097,7 @@
         // Arrange
         bool selectAllCalled = false;
         var people = People.ToList();
-        
+
         var selectColumn = new SelectColumn<Person>
         {
             SelectMode = DataGridSelectMode.Single,
@@ -1245,6 +1243,58 @@
         Assert.Equal(people[0], selectColumn.SelectedItems.First());
     }
 
+	// Add a test to cover the Comparer property
+	[Fact]
+	public void SelectColumnTests_Comparer_Property()
+	{
+		// Arrange
+		var selectColumn = new SelectColumn<Person>();
+		// Act
+		var comparer = EqualityComparer<Person>.Create((x, y) => x!.PersonId == y!.PersonId, x => x.PersonId.GetHashCode());
+		selectColumn.Comparer = comparer;
+		// Assert
+		Assert.Equal(comparer, selectColumn.Comparer);
+	}
+
+	[Fact]
+    public async Task SelectColumnTests_SingleSelect_SelectedItemsWithComparer()
+    {
+        IEnumerable<Person> SelectedItems = new List<Person>();
+
+		IQueryable<Person> People = new[]
+		{
+			new Person(1, "Jean Martin", new DateOnly(1985, 3, 16)),
+			new Person(2, "Jean Martin", new DateOnly(1985, 3, 16)),
+			new Person(3, "Julie Smith", new DateOnly(1958, 10, 10)),
+		}.AsQueryable();
+
+        // Arrange
+        var cut = Render(
+			@<FluentDataGrid Items="@People" TGridItem="Person">
+				<SelectColumn TGridItem="Person"
+							  SelectMode="@DataGridSelectMode.Single"
+							  Comparer = "@(EqualityComparer<Person>.Create((x, y) => x!.PersonId == y!.PersonId, x => x.PersonId.GetHashCode()))"
+							  @bind-SelectedItems="@SelectedItems"
+							  Tooltip="true"/>
+				<PropertyColumn Property="@(p => p.Name)" />
+			</FluentDataGrid>
+		);
+
+        // Pre-Assert
+        Assert.Empty(cut.FindAll("svg[row-selected]"));
+        Assert.Empty(SelectedItems);
+
+        // Act - Click and select Row 0
+        await ClickOnRowAsync(cut, row: 0);
+        Assert.Single(cut.FindAll("svg[row-selected]"));
+        Assert.Single(SelectedItems);
+
+        // Act - Click and select Row 1
+        await ClickOnRowAsync(cut, row: 0);
+
+        Assert.Empty(SelectedItems);
+    }
+
 #pragma warning restore BL0005
     /// <summary>
     /// Simulate a key down event on the DataGrid row number <paramref name="row"/>.