MudDataGrid: Allow disabling selection per row via criteria #11554

Anu6is · 2025-06-25T18:28:04Z

Description

Created a new DisabledFunc parameter in the SelectColumn to allow for conditionally disabling the select checkbox.
The following applies once disabled

The checkbox is disabled
Select on row click is ignored
Select all does not select the row

Additionally, the select all checkbox has been hidden from the header and footer when MultiSelection is false .

Resolves #11546
Resolves #11500

The documentation page includes an example of using this function.

How Has This Been Tested?

Visually and unit tests

Type of Changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation (fix or improvement to the website or code docs)

Docs:

Demo:

disable.mod.5.mp4

Checklist

The PR is submitted to the correct branch (dev).
My code follows the code style of this project.
I've added relevant tests.

…PerRow

…ithub.com/Anu6is/MudBlazor into 11546-MudDataGrid-DisableSelection-PerRow

codecov · 2025-06-25T18:32:21Z

Codecov Report

❌ Patch coverage is 97.61905% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 91.33%. Comparing base (1b5ac83) to head (fb99c5b).

Files with missing lines	Patch %	Lines
...udBlazor/Components/DataGrid/SelectColumn.razor.cs	91.66%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##              dev   #11554      +/-   ##
==========================================
+ Coverage   91.31%   91.33%   +0.02%     
==========================================
  Files         466      466              
  Lines       14725    14768      +43     
  Branches     2870     2871       +1     
==========================================
+ Hits        13446    13489      +43     
  Misses        636      636              
  Partials      643      643

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

versile2

Very clean updates. While the proper null checks are in place I think those two should still be "nullable" for form and a better doc would always help others.

src/MudBlazor.Docs/Pages/Components/DataGrid/DataGridPage.razor

src/MudBlazor/Components/DataGrid/SelectColumn.razor

src/MudBlazor/Components/DataGrid/SelectColumn.razor.cs

versile2 · 2025-07-01T13:04:54Z

real cool docs update. I like it.

sonarqubecloud · 2025-08-07T13:09:30Z

Quality Gate passed

Issues
9 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

ProgramGeek02 · 2025-09-12T10:21:45Z

Does this pull request has been merged?

BigBasti123 · 2025-10-21T05:55:53Z

I have another question according to this. Maybe a bit late. But is it possible to automatically unselect a selected row, when the row is then filtered and hence hidden?

mudbot · 2025-10-21T05:57:14Z

That's an interesting question about how filtering should interact with selections. For usage questions and discussions about potential new behavior, the best places to get input from the community and maintainers are our support channels.

For similar topics or broader help, you're welcome to use GitHub Discussions or our Discord community.

I'm an AI assistant — If I missed something or made a mistake, please let me know in a reply!

Anu6is · 2025-10-21T11:50:07Z

@BigBasti123 not really related to this change. However, you could probably utilize a custom FilterTemplate that either clears all selected items when applying the filter or clears items not in the FilteredItems list after the filter is applied.

Copilot

Pull Request Overview

This PR adds support for disabling specific rows in the DataGrid's SelectColumn through a new DisabledFunc parameter. The implementation refactors SelectColumn to inherit from TemplateColumn and ensures disabled rows cannot be selected via checkboxes, row clicks, or "select all" operations.

Key Changes:

Added DisabledFunc parameter to SelectColumn for conditional row selection disabling
Refactored SelectColumn to inherit from TemplateColumn with overridden template properties
Enhanced selection logic to respect disabled state in individual and bulk operations

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
SelectColumn.razor.cs	Refactored to inherit from TemplateColumn, added DisabledFunc parameter, removed redundant properties now inherited from base class
SelectColumn.razor	Moved template logic to code methods, integrated DisabledFunc into checkbox rendering
MudDataGrid.razor.cs	Updated SetSelectedItemAsync and SetSelectAllAsync to check and respect DisabledFunc
HeaderContext.cs	Added IsMultiSelection property for conditional header checkbox rendering
FooterContext.cs	Added IsMultiSelection property for conditional footer checkbox rendering
Column.razor.cs	Made template properties virtual to allow overriding in derived classes
DataGridTests.cs	Added comprehensive test coverage for DisabledFunc functionality
DataGridSelectionExample.razor	Updated example to demonstrate DisabledFunc usage
DataGridPage.razor	Added documentation section for row selection features

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-10-30T00:37:46Z

src/MudBlazor/Components/DataGrid/SelectColumn.razor

+                      ValueChanged="@context.Actions.SetSelectedItemAsync"
+                      Disabled="@(DisabledFunc?.Invoke(context.Item) ?? false)" />;
+
+#nullable enable


Duplicate #nullable enable directive. Line 6 already enables nullable reference types for this code block, making line 27 redundant.

Suggested change

#nullable enable

Copilot · 2025-10-30T00:37:46Z

src/MudBlazor/Components/DataGrid/SelectColumn.razor.cs

+    public override RenderFragment<HeaderContext<T>>? HeaderTemplate { get => ShowInHeader ? GetHeaderTemplate() : null; set { } }
+    public override RenderFragment<CellContext<T>> CellTemplate { get => GetCellTemplate(); set { } }
+    public override RenderFragment<FooterContext<T>>? FooterTemplate { get => ShowInFooter ? GetFooterTemplate() : null; set { } }


The getter methods create new RenderFragment delegates on every access. Consider caching these delegates if the properties are accessed multiple times during rendering, or ensuring that ShowInHeader/ShowInFooter changes trigger proper re-initialization.

Copilot · 2025-10-30T00:37:46Z

src/MudBlazor.Docs/Pages/Components/DataGrid/Examples/DataGridSelectionExample.razor

@@ -1,10 +1,12 @@
-@using System.Net.Http.Json
+@using System.Net.Http.Json


Line contains duplicate BOM characters (two UTF-8 BOMs). This should be cleaned to have only one BOM at the start of the file.

Suggested change

@using System.Net.Http.Json

@using System.Net.Http.Json

Copilot · 2025-10-30T00:37:47Z

src/MudBlazor.UnitTests/Components/DataGridTests.cs

+                new TestDataItem { Id = 2, Name = "Disabled Item 1", ShouldBeDisabled = true },
+                new TestDataItem { Id = 3, Name = "Enabled Item 2", ShouldBeDisabled = false }
+            };
+            Func<TestDataItem, bool> disabledFunc = item => item.ShouldBeDisabled;


This assignment to disabledFunc is useless, since its value is never read.

Suggested change

Func<TestDataItem, bool> disabledFunc = item => item.ShouldBeDisabled;

Copilot · 2025-10-30T00:37:47Z

src/MudBlazor.UnitTests/Components/DataGridTests.cs

+                new TestDataItem { Id = 3, Name = "Enabled Item 2", ShouldBeDisabled = false },
+                new TestDataItem { Id = 4, Name = "Disabled Item 2", ShouldBeDisabled = true }
+            };
+            Func<TestDataItem, bool> disabledFunc = item => item.ShouldBeDisabled;


This assignment to disabledFunc is useless, since its value is never read.

Copilot · 2025-10-30T00:37:47Z

src/MudBlazor.UnitTests/Components/DataGridTests.cs

+            Func<TestDataItem, bool> disabledFunc = item => false; // All items are effectively enabled
+


This assignment to disabledFunc is useless, since its value is never read.

Suggested change

Func<TestDataItem, bool> disabledFunc = item => false; // All items are effectively enabled

ScarletKuro · 2025-10-30T09:55:10Z

I guess it's breaking change because DragAndDropEnabled is gone from SelectColumn

…PerRow

Anu6is · 2025-10-30T12:00:37Z

@ScarletKuro DragAndDropEnabled is still available since SelectColumn now inherits from TemplateColumn

Anu6is added 4 commits June 25, 2025 14:01

Disable row selection based on criteria

2285dc1

Merge branch 'MudBlazor:dev' into 11546-MudDataGrid-DisableSelection-…

29f5909

…PerRow

rename disable parameter (Disable -> DisableFunc)

c5e507e

Merge branch '11546-MudDataGrid-DisableSelection-PerRow' of https://g…

995f125

…ithub.com/Anu6is/MudBlazor into 11546-MudDataGrid-DisableSelection-PerRow

github-actions bot added the enhancement Request for adding a new feature or enhancing existing functionality (not fixing a defect) label Jun 25, 2025

Anu6is requested review from ScarletKuro and tjscience June 25, 2025 18:41

Merge branch 'dev' into 11546-MudDataGrid-DisableSelection-PerRow

c687035

versile2 reviewed Jun 29, 2025

View reviewed changes

src/MudBlazor.Docs/Pages/Components/DataGrid/DataGridPage.razor Show resolved Hide resolved

src/MudBlazor/Components/DataGrid/SelectColumn.razor Outdated Show resolved Hide resolved

src/MudBlazor/Components/DataGrid/SelectColumn.razor Outdated Show resolved Hide resolved

Anu6is added 3 commits June 30, 2025 07:21

nullability

b0f9436

Merge branch 'dev' into 11546-MudDataGrid-DisableSelection-PerRow

33221e4

don't fix conflicts on github web portal :)

66afca1

versile2 approved these changes Jun 30, 2025

View reviewed changes

ScarletKuro reviewed Jun 30, 2025

View reviewed changes

src/MudBlazor/Components/DataGrid/SelectColumn.razor.cs Show resolved Hide resolved

Anu6is added 3 commits June 30, 2025 21:24

Assign defaults in consructor

be64c55

make renderfragments overridable

ae83897

update docs

778b38c

Anu6is added 2 commits July 24, 2025 09:23

Merge branch 'dev' into 11546-MudDataGrid-DisableSelection-PerRow

99eb77c

Merge branch 'dev' into 11546-MudDataGrid-DisableSelection-PerRow

98d55f0

github-actions bot added the awaiting triage Needs maintainer review or assistance label Aug 3, 2025

Merge branch 'dev' into 11546-MudDataGrid-DisableSelection-PerRow

fb99c5b

danielchalmers removed the awaiting triage Needs maintainer review or assistance label Aug 17, 2025

Merge branch 'dev' into 11546-MudDataGrid-DisableSelection-PerRow

fc7da48

Merge branch 'dev' into 11546-MudDataGrid-DisableSelection-PerRow

6b68bea

Merge branch 'dev' into 11546-MudDataGrid-DisableSelection-PerRow

9dc68b6

danielchalmers requested a review from Copilot October 30, 2025 00:30

Copilot AI reviewed Oct 30, 2025

View reviewed changes

mudbot bot added the breaking change This change will require consumer code updates label Oct 30, 2025

Merge branch 'MudBlazor:dev' into 11546-MudDataGrid-DisableSelection-…

a3a6755

…PerRow

		@@ -1,10 +1,12 @@
		@using System.Net.Http.Json
		@using System.Net.Http.Json

		Func<TestDataItem, bool> disabledFunc = item => false; // All items are effectively enabled

Uh oh!

MudDataGrid: Allow disabling selection per row via criteria #11554

Are you sure you want to change the base?

MudDataGrid: Allow disabling selection per row via criteria #11554

Uh oh!

Conversation

Anu6is commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

How Has This Been Tested?

Type of Changes

Checklist

Uh oh!

codecov bot commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

versile2 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

versile2 commented Jul 1, 2025

Uh oh!

sonarqubecloud bot commented Aug 7, 2025

Quality Gate passed

Uh oh!

ProgramGeek02 commented Sep 12, 2025

Uh oh!

BigBasti123 commented Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mudbot bot commented Oct 21, 2025

Uh oh!

Anu6is commented Oct 21, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Key Changes:

Reviewed Changes

Uh oh!

Copilot AI Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

ScarletKuro commented Oct 30, 2025

Uh oh!

Anu6is commented Oct 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Anu6is commented Jun 25, 2025 •

edited

Loading

codecov bot commented Jun 25, 2025 •

edited

Loading

BigBasti123 commented Oct 21, 2025 •

edited

Loading