Skip to content

[DataGrid] Add a SelectColumn Comparer property #4344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vnbaaij merged 2 commits into from
Nov 22, 2025
Merged

[DataGrid] Add a SelectColumn Comparer property #4344

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e138e63
Added a SelectColumn comparer property
miguelhasse Nov 22, 2025
64b65d0
Added Comparer property summary on SelectColumn
miguelhasse Nov 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 34 additions & 25 deletions src/Core/Components/DataGrid/Columns/SelectColumn.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,15 @@ public DataGridSelectMode SelectMode
[Parameter]
public override IGridSort<TGridItem>? SortBy { get; set; }

/// <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>
Expand Down Expand Up @@ -296,14 +305,21 @@ 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 (SelectedItems.Contains(item))
{
_selectedItems.Remove(item);
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);
}
SelectAll = false;
await CallOnSelectAsync(item, false);
}
Expand Down Expand Up @@ -340,13 +356,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);
Expand Down Expand Up @@ -414,15 +429,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);
}
Expand Down Expand Up @@ -508,23 +524,16 @@ private void RefreshHeaderContent()
// Using SelectedItems only
if (InternalGridContext != null && (Grid.Items != null || Grid.ItemsProvider != null))
{
if (!SelectedItems.Any())
if (_selectedItems.Count == 0)
{
return false;
}
else if (SelectedItems.Count() == InternalGridContext.TotalItemCount || SelectAll == true)
else if (_selectedItems.Count == InternalGridContext.TotalItemCount || SelectAll == true)
{
return true;
}
else
{
return null;
}
}
else
{
return null;
}
return null;
}

/// <inheritdoc />
Expand Down Expand Up @@ -555,13 +564,13 @@ internal async Task OnClickAllAsync(MouseEventArgs e)
await SelectAllChanged.InvokeAsync(SelectAll);
}

var count = SelectedItems.Count();
// SelectedItems
var count = _selectedItems.Count;
_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)
);
}
Expand Down
Loading