DataGrid: add FilterDefaultItem* parameters to DataGridSelectColumn (#6074)

* Add FilterDefaultItem* parameters and conditionally render based on cell being in a filter on not

* Formating

* removes unnecessary `false`s

* Refactored DataGrid cell area logic by introducing DataGridCellArea enum.

* Rename to DataGridCellSection

---------

Co-authored-by: Mladen Macanovic <mladen.macanovic@blazorise.com>
Co-authored-by: Mladen Macanovic <mladen.macanovic@gmail.com>

Author: tesar-tech

Documentation/Blazorise.Docs/Pages/News/2025-03-10-release-notes-180.razor

@@ -118,6 +118,14 @@
     Introduced the <Code>Task New( TItem newItem )</Code> overload method in DataGrid, enabling the programmatic addition of new items to the batch edit collection when batch editing is enabled. This method ensures that newly added items are tracked as unsaved changes, allowing them to be persisted upon saving or discarded upon cancellation.
 </Paragraph>
 
+<Heading Size="HeadingSize.Is3">
+    DataGrid: Added support for default item in filter for DataGridSelectColumn
+</Heading>
+
+<Paragraph>
+    New parameters <Code>FilterDefaultItemText</Code>, <Code>FilterDefaultItemValue</Code>, <Code>FilterDefaultItemDisabled</Code>, and <Code>FilterDefaultItemHidden</Code> allow customizing the default item shown in filter dropdowns of <Code>DataGridSelectColumn</Code>. This gives developers more control over how filter options are presented and improves the user experience when working with dropdown filters.
+</Paragraph>
+
 <Heading Size="HeadingSize.Is3">
     Show Week Numbers On DatePicker
 </Heading>

Source/Extensions/Blazorise.DataGrid/DataGridSelectColumn.cs

@@ -65,12 +65,32 @@ public override string FormatDisplayValue( object value )
     /// <summary>
     /// If true, disables the default item.
     /// </summary>
-    [Parameter] public bool DefaultItemDisabled { get; set; } = false;
+    [Parameter] public bool DefaultItemDisabled { get; set; }
 
     /// <summary>
     /// If true, disables the default item.
     /// </summary>
-    [Parameter] public bool DefaultItemHidden { get; set; } = false;
+    [Parameter] public bool DefaultItemHidden { get; set; }
+
+    /// <summary>
+    /// Display text of the default item shown in filter dropdowns.
+    /// </summary>
+    [Parameter] public string FilterDefaultItemText { get; set; }
+
+    /// <summary>
+    /// Value of the default item used in filter dropdowns.
+    /// </summary>
+    [Parameter] public object FilterDefaultItemValue { get; set; }
+
+    /// <summary>
+    /// If true, disables the default item in filter dropdowns.
+    /// </summary>
+    [Parameter] public bool FilterDefaultItemDisabled { get; set; }
+
+    /// <summary>
+    /// If true, hides the default item from filter dropdowns.
+    /// </summary>
+    [Parameter] public bool FilterDefaultItemHidden { get; set; }
 
     /// <summary>
     /// Custom css class-names.

Source/Extensions/Blazorise.DataGrid/Enums/DataGridCellSection.cs

@@ -0,0 +1,17 @@
+namespace Blazorise.DataGrid;
+
+/// <summary>
+/// Determines the section where the cell is located within DataGrid.
+/// </summary>
+public enum DataGridCellSection
+{
+    /// <summary>
+    /// A cell in the main content area (body).
+    /// </summary>
+    Body,
+
+    /// <summary>
+    /// A cell in the filter row area.
+    /// </summary>
+    Filter,
+}

Source/Extensions/Blazorise.DataGrid/_DataGridCellFilter.razor

@@ -1,29 +1,25 @@
 @using Blazorise.Extensions;
 @typeparam TItem
 @{
-    if ( Column is DataGridNumericColumn<TItem> numericColumn )
+    @if ( Column is DataGridNumericColumn<TItem> numericColumn )
     {
-        <_DataGridCellNumericEdit Column="@numericColumn" CellValue="@GetSearchValue()" CellValueChanged="@FilterChanged"></_DataGridCellNumericEdit>
-
+        <_DataGridCellNumericEdit Column="@numericColumn" CellValue="@GetSearchValue()" CellValueChanged="@FilterChanged" />
     }
     else if ( Column is DataGridSelectColumn<TItem> selectColumn )
     {
-        <_DataGridCellSelectEdit Column="@selectColumn" CellValue="@GetSearchValue()" CellValueChanged="@FilterChanged"></_DataGridCellSelectEdit>
-
+        <_DataGridCellSelectEdit Column="@selectColumn" CellValue="@GetSearchValue()" CellValueChanged="@FilterChanged" CellSection="DataGridCellSection.Filter" />
     }
     else if ( Column is DataGridCheckColumn<TItem> checkColumn )
     {
-        <_DataGridCellCheckEdit Column="@checkColumn" CellValue="@GetSearchValue()" CellValueChanged="@FilterChanged"></_DataGridCellCheckEdit>
-
+        <_DataGridCellCheckEdit Column="@checkColumn" CellValue="@GetSearchValue()" CellValueChanged="@FilterChanged" />
     }
     else if ( Column is DataGridDateColumn<TItem> dateColumn )
     {
-        <_DataGridCellDatePicker Column="@dateColumn" CellValue="@GetSearchValue()" CellValueChanged="@FilterChanged"></_DataGridCellDatePicker>
-
+        <_DataGridCellDatePicker Column="@dateColumn" CellValue="@GetSearchValue()" CellValueChanged="@FilterChanged" />
     }
     else
     {
-        <TextEdit Text="@GetSearchValueAsString()" TextChanged="@((newValue) => FilterChanged(newValue))" />
+        <TextEdit Text="@GetSearchValueAsString()" TextChanged="@(( newValue ) => FilterChanged( newValue ))" />
     }
 }
 @code {
@@ -84,5 +80,4 @@
     {
         return ( Column.Filter.SearchValue as object[] )?[1];
     }
-
 }

Source/Extensions/Blazorise.DataGrid/_DataGridCellSelectEdit.razor

@@ -1,11 +1,20 @@
 @typeparam TItem
 @inherits ComponentBase
-<Select TValue="object" ElementId="@elementId" SelectedValues="@GetSelectedValues()" SelectedValuesChanged="OnSelectedValuesChanged" SelectedValuesExpression="@(() => CellValue as string[] )" SelectedValue="@CellValue" SelectedValueChanged="@OnSelectedValueChanged" SelectedValueExpression="@(() => CellValue )"
+<Select TValue="object" ElementId="@elementId" SelectedValues="@GetSelectedValues()" SelectedValuesChanged="OnSelectedValuesChanged" SelectedValuesExpression="@(() => CellValue as string[])" SelectedValue="@CellValue" SelectedValueChanged="@OnSelectedValueChanged" SelectedValueExpression="@(() => CellValue)"
         Class="@Column.Class" Style="@Column.Style" Size="@Column.Size" MaxVisibleItems="@Column.MaxVisibleItems" TabIndex="@Column.TabIndex" Disabled="@Column.Disabled" Multiple="@Column.Multiple" Attributes="@Column.Attributes">
     <ChildContent>
-        @if ( Column.DefaultItemText is not null )
+        @{
+            var defaultText = CellSection == DataGridCellSection.Filter ? Column.FilterDefaultItemText : Column.DefaultItemText;
+            var defaultValue = CellSection == DataGridCellSection.Filter ? Column.FilterDefaultItemValue : Column.DefaultItemValue;
+            var defaultDisabled = CellSection == DataGridCellSection.Filter ? Column.FilterDefaultItemDisabled : Column.DefaultItemDisabled;
+            var defaultHidden = CellSection == DataGridCellSection.Filter ? Column.FilterDefaultItemHidden : Column.DefaultItemHidden;
+        }
+
+        @if ( defaultText is not null )
         {
-            <SelectItem @key="@Column.DefaultItemValue" Value="@Column.DefaultItemValue" Disabled="@Column.DefaultItemDisabled" Hidden="@Column.DefaultItemHidden">@Column.DefaultItemText</SelectItem>
+            <SelectItem @key="@defaultValue" Value="@defaultValue" Disabled="@defaultDisabled" Hidden="@defaultHidden">
+                @defaultText
+            </SelectItem>
         }
         @if ( Column.Data is not null && selectItems is not null )
         {

Source/Extensions/Blazorise.DataGrid/_DataGridCellSelectEdit.razor.cs

@@ -208,7 +208,15 @@ public async Task Select()
     /// </summary>
     [Parameter] public EventCallback<object> CellValueChanged { get; set; }
 
+    /// <summary>
+    /// Indicates whether to display validation feedback to the user.
+    /// </summary>
     [Parameter] public bool ShowValidationFeedback { get; set; }
 
+    /// <summary>
+    /// Determines the area where the cell is located.
+    /// </summary>
+    [Parameter] public DataGridCellSection CellSection { get; set; }
+
     #endregion
 }