Grid: Translation of the filtering of the grid #292 - draft

BlazorBootstrap.Demo/Pages/Grid/Grid_Demo_30_Translations.razor

@@ -1,7 +1,8 @@
 <Grid TItem="Employee1"
+      AllowPaging="true"
       Class="table table-hover table-bordered table-striped"
       DataProvider="EmployeesDataProvider"
-      AllowPaging="true"
+      FiltersTranslationProvider="GridFiltersTranslationProvider"
       PageSize="10"
       PageSizeSelectorVisible="true"
       PageSizeSelectorItems="@(new int[] { 5,10,20 })"
@@ -30,6 +31,29 @@
 @code {
     private IEnumerable<Employee1> employees = default!;
 
+    private async Task<HashSet<FilterOperatorInfo>> GridFiltersTranslationProvider()
+    {
+        var filtersTranslation = new HashSet<FilterOperatorInfo>();
+
+        // number/date/boolean
+        filtersTranslation.Add(new("=", "Equals", FilterOperator.Equals));
+        filtersTranslation.Add(new("!=", "Not equals", FilterOperator.NotEquals));
+        // number/date
+        filtersTranslation.Add(new("<", "Less than", FilterOperator.LessThan));
+        filtersTranslation.Add(new("<=", "Less than or equals", FilterOperator.LessThanOrEquals));
+        filtersTranslation.Add(new(">", "Greater than", FilterOperator.GreaterThan));
+        filtersTranslation.Add(new(">=", "Greater than or equals", FilterOperator.GreaterThanOrEquals));
+        // string
+        filtersTranslation.Add(new("*a*", "Contains", FilterOperator.Contains));
+        filtersTranslation.Add(new("a**", "Starts with", FilterOperator.StartsWith));
+        filtersTranslation.Add(new("**a", "Ends with", FilterOperator.EndsWith));
+        filtersTranslation.Add(new("=", "Equals", FilterOperator.Equals));
+        // common
+        filtersTranslation.Add(new("x", "Clear", FilterOperator.Equals));
+
+        return await Task.FromResult(filtersTranslation);
+    }
+
     private async Task<GridDataProviderResult<Employee1>> EmployeesDataProvider(GridDataProviderRequest<Employee1> request)
     {
         if (employees is null) // pull employees only one time for client-side filtering, sorting, and paging
@@ -56,4 +80,6 @@
             new Employee1 { Id = 111, Name = "Glenda", Designation = "Data Engineer", DOJ = new DateOnly(1994, 1, 12), IsActive = true },
         };
     }
+
+
 }

blazorbootstrap/Components/Grid/Grid.razor

@@ -33,7 +33,7 @@
                             <th class="@column.Class">
                                 @if (column.Filterable)
                                 {
-                                    <GridColumnFilter PropertyTypeName="@column.GetPropertyTypeName()"
+                                    <GridColumnFilter TItem="TItem" PropertyTypeName="@column.GetPropertyTypeName()"
                                                       FilterOperator="@column.FilterOperator"
                                                       FilterValue="@column.FilterValue"
                                                       FilterWidth="@column.FilterTextboxWidth"

blazorbootstrap/Components/Grid/Grid.razor.cs

@@ -640,6 +640,20 @@ private string GetPaginationItemsText()
         builder.CloseElement(); // close: th
     });
 
+    [Parameter, EditorRequired] public string ItemsPerPageText { get; set; } = "Items per page";
+
+    /// <summary>
+    /// This event is triggered when the user clicks on the row. 
+    /// Set AllowRowClick to true to enable row clicking.
+    /// </summary>
+    [Parameter] public EventCallback<GridRowEventArgs<TItem>> OnRowClick { get; set; }
+
+    /// <summary>
+    /// This event is triggered when the user double clicks on the row.
+    /// Set AllowRowClick to true to enable row double clicking.
+    /// </summary>
+    [Parameter] public EventCallback<GridRowEventArgs<TItem>> OnRowDoubleClick { get; set; }
+
     /// <summary>
     /// Gets or sets the page size of the grid.
     /// </summary>
@@ -676,18 +690,6 @@ private string GetPaginationItemsText()
     /// </summary>
     [Parameter] public bool Responsive { get; set; }
 
-    /// <summary>
-    /// This event is triggered when the user clicks on the row. 
-    /// Set AllowRowClick to true to enable row clicking.
-    /// </summary>
-    [Parameter] public EventCallback<GridRowEventArgs<TItem>> OnRowClick { get; set; }
-
-    /// <summary>
-    /// This event is triggered when the user double clicks on the row.
-    /// Set AllowRowClick to true to enable row double clicking.
-    /// </summary>
-    [Parameter] public EventCallback<GridRowEventArgs<TItem>> OnRowDoubleClick { get; set; }
-
     /// <summary>
     /// This event is fired when the item selection changes.
     /// </summary>
@@ -704,7 +706,11 @@ private string GetPaginationItemsText()
     /// </summary>
     [Parameter] public GridSettingsProviderDelegate SettingsProvider { get; set; } = default!;
 
-    [Parameter, EditorRequired] public string ItemsPerPageText { get; set; } = "Items per page";
+    /// <summary>
+    /// Filters transalation is for grid filters to render.
+    /// The provider should always return a 'FilterOperatorInfo' collection, and 'null' is not allowed.
+    /// </summary>
+    [Parameter] public GridFiltersTranslationDelegate FiltersTranslationProvider { get; set; } = default!;
 
     #endregion Properties
 }

blazorbootstrap/Components/Grid/GridColumnFilter.razor

@@ -1,5 +1,6 @@
 @namespace BlazorBootstrap
 @inherits BaseComponent
+@typeparam TItem
 
 <div class="d-flex">
     <button type="button" class="btn btn-light me-1 d-flex dropdown-toggle bb-grid-filter" data-bs-toggle="dropdown" aria-expanded="false">

blazorbootstrap/Components/Grid/GridColumnFilter.razor.cs

@@ -1,6 +1,6 @@
 namespace BlazorBootstrap;
 
-public partial class GridColumnFilter : BaseComponent
+public partial class GridColumnFilter<TItem> : BaseComponent
 {
     #region Members
 
@@ -120,6 +120,8 @@ or StringConstants.PropertyTypeNameDecimal
 
     #region Properties
 
+    [CascadingParameter] public Grid<TItem> Grid { get; set; } = default!;
+
     [Parameter] public EventCallback<FilterEventArgs> GridColumnFilterChanged { get; set; }
 
     /// <summary>

blazorbootstrap/Models/GridFiltersTranslationDelegate.cs

@@ -0,0 +1,6 @@
+namespace BlazorBootstrap;
+
+/// <summary>
+/// Grid filters translation provider (delegate).
+/// </summary>
+public delegate Task<HashSet<FilterOperatorInfo>> GridFiltersTranslationDelegate();