Merge pull request #1 from IgniteUI/dpetev/api-align-refactor

API align refactor

Author: dkamburov

README.md

@@ -56,18 +56,18 @@ In your `App.razor` or layout file, include one of the available themes:
 
 @code {
     private List<Employee> employees = new();
-    private List<ColumnConfiguration<Employee>> columns = new();
+    private List<IgbColumnConfiguration> columns = new();
 
     protected override void OnInitialized()
     {
         employees = GetEmployees();
         
-        columns = new List<ColumnConfiguration<Employee>>
+        columns = new List<IgbColumnConfiguration>
         {
-            new() { Key = nameof(Employee.Id), HeaderText = "ID", Width = "100px", Type = DataType.Number },
-            new() { Key = nameof(Employee.Name), HeaderText = "Employee Name", Type = DataType.String },
-            new() { Key = nameof(Employee.Department), HeaderText = "Department", Type = DataType.String },
-            new() { Key = nameof(Employee.Salary), HeaderText = "Salary", Width = "150px", Type = DataType.Number }
+            new() { Key = nameof(Employee.Id), HeaderText = "ID", Width = "100px", Type = GridLiteColumnDataType.Number },
+            new() { Key = nameof(Employee.Name), HeaderText = "Employee Name", Type = GridLiteColumnDataType.String },
+            new() { Key = nameof(Employee.Department), HeaderText = "Department", Type = GridLiteColumnDataType.String },
+            new() { Key = nameof(Employee.Salary), HeaderText = "Salary", Width = "150px", Type = GridLiteColumnDataType.Number }
         };
     }
 }
@@ -82,12 +82,12 @@ In your `App.razor` or layout file, include one of the available themes:
              FilterExpressions="@initialFilter" />
 
 @code {
-    private List<SortExpression> initialSort = new()
+    private List<IgbGridLiteSortExpression> initialSort = new()
     {
         new() { Key = nameof(Employee.Name), Direction = GridLiteSortingDirection.Ascending }
     };
     
-    private List<FilterExpression> initialFilter = new()
+    private List<IgbGridLiteFilterExpression> initialFilter = new()
     {
         new() { Key = nameof(Employee.Department), Condition = "contains", SearchTerm = "Sales" }
     };
@@ -101,7 +101,7 @@ In your `App.razor` or layout file, include one of the available themes:
 Enable sorting on specific columns:
 
 ```csharp
-new ColumnConfiguration<Employee> 
+new IgbColumnConfiguration
 { 
     Key = nameof(Employee.Name), 
     HeaderText = "Name",
@@ -115,11 +115,11 @@ new ColumnConfiguration<Employee>
 Enable filtering on columns:
 
 ```csharp
-new ColumnConfiguration<Employee> 
+new IgbColumnConfiguration
 { 
     Key = nameof(Employee.Department), 
     HeaderText = "Department",
-    Filter = new ColumnFilterConfiguration 
+    Filter = new IgbColumnFilterConfiguration 
     { 
         CaseSensitive = false 
     }
@@ -133,28 +133,28 @@ Handle sorting and filtering events:
 ```razor
 <IgbGridLite Data="@employees" 
              Columns="@columns"
-             OnSorting="@HandleSorting"
-             OnSorted="@HandleSorted"
-             OnFiltering="@HandleFiltering"
-             OnFiltered="@HandleFiltered" />
+             Sorting="@HandleSorting"
+             Sorted="@HandleSorted"
+             Filtering="@HandleFiltering"
+             Filtered="@HandleFiltered" />
 
 @code {
-    private void HandleSorting(IgbGridLiteSortingEvent e)
+    private void HandleSorting(IgbGridLiteSortingEventArgs e)
     {
         // Handle on sorting
     }
 
-    private void HandleSorted(IgbGridLiteSortedEvent e)
+    private void HandleSorted(IgbGridLiteSortedEventArgs e)
     {
         // Handle after sort
     }
 
-    private void HandleFiltering(IgbGridLiteFilteringEvent e)
+    private void HandleFiltering(IgbGridLiteFilteringEventArgs e)
     {
         // Handle on filtering
     }
 
-    private void HandleFiltered(IgbGridLiteFilteredEvent e)
+    private void HandleFiltered(IgbGridLiteFilteredEventArgs e)
     {
         // Handle after filter
     }
@@ -163,7 +163,7 @@ Handle sorting and filtering events:
 
 ## Column Configuration
 
-The `ColumnConfiguration<TItem>` class supports:
+The `IgbColumnConfiguration` class supports:
 
 - `Key`: Property name to bind to (use `nameof()` for type safety)
 - `HeaderText`: Column header display text

demo/GridLite.DemoApp/Components/Pages/Home.razor

@@ -4,8 +4,8 @@
           SortConfiguration="@sortConfiguration" Columns="cols"
           SortExpressions="@initialSort"
           FilterExpressions="@initialFilter"
-          OnSorting="HandleSorting" OnSorted="HandleSorted"
-          OnFiltering="HandleFiltering" OnFiltered="HandleFiltered">
+          Sorting="HandleSorting" Sorted="HandleSorted"
+          Filtering="HandleFiltering" Filtered="HandleFiltered">
 
 </IgbGridLite>
 
@@ -14,36 +14,36 @@
 @code {
     public IgbGridLite<NwindDataItem> grid;
 
-    private GridSortConfiguration sortConfiguration = new GridSortConfiguration()
+    private IgbGridLiteSortConfiguration sortConfiguration = new IgbGridLiteSortConfiguration()
     {
         Multiple = true,
         TriState = false
     };
 
-    private List<SortExpression> initialSort;
-    private List<FilterExpression> initialFilter;
+    private List<IgbGridLiteSortExpression> initialSort;
+    private List<IgbGridLiteFilterExpression> initialFilter;
 
     protected override void OnInitialized()
     {
-        initialFilter = new List<FilterExpression>
+        initialFilter = new List<IgbGridLiteFilterExpression>
         {
-            new FilterExpression
+            new IgbGridLiteFilterExpression
             {
                 Key = nameof(NwindDataItem.ProductName),
                 Condition = "contains",
                 SearchTerm = "a"
             },
-            new FilterExpression
+            new IgbGridLiteFilterExpression
             {
                 Key = nameof(NwindDataItem.ProductName),
                 Condition = "contains",
                 SearchTerm = "b"
             }
         };
 
-        initialSort = new List<SortExpression>
+        initialSort = new List<IgbGridLiteSortExpression>
         {
-            new SortExpression
+            new IgbGridLiteSortExpression
             {
                 Key = nameof(NwindDataItem.ProductName),
                 Direction = GridLiteSortingDirection.Ascending
@@ -53,9 +53,9 @@
 
     public async void BtnClick()
     {
-        await this.grid.SortAsync(new List<SortExpression>
+        await this.grid.SortAsync(new List<IgbGridLiteSortExpression>
             {
-                new SortExpression() { Key = nameof(NwindDataItem.ProductName), Direction = GridLiteSortingDirection.Descending }
+                new IgbGridLiteSortExpression() { Key = nameof(NwindDataItem.ProductName), Direction = GridLiteSortingDirection.Descending }
             }
         );
     }
@@ -74,42 +74,42 @@
         }
     }
 
-    private void HandleSorting(IgbGridLiteSortingEvent e)
+    private void HandleSorting(IgbGridLiteSortingEventArgs e)
     {
 
     }
 
-    private void HandleSorted(IgbGridLiteSortedEvent e)
+    private void HandleSorted(IgbGridLiteSortedEventArgs e)
     {
 
     }
 
-    private void HandleFiltering(IgbGridLiteFilteringEvent e)
+    private void HandleFiltering(IgbGridLiteFilteringEventArgs e)
     {
 
     }
 
-    private void HandleFiltered(IgbGridLiteFilteredEvent e)
+    private void HandleFiltered(IgbGridLiteFilteredEventArgs e)
     {
 
     }
 
-    public List<ColumnConfiguration<NwindDataItem>> cols = new List<ColumnConfiguration<NwindDataItem>>() {
-     new ColumnConfiguration<NwindDataItem>(){
-        Key = nameof(NwindDataItem.ProductID),
-        Type = DataType.Number,
-        Sort = new ColumnSortConfiguration(){
-         CaseSensitive = false
+    public List<IgbColumnConfiguration> cols = new List<IgbColumnConfiguration> {
+        new IgbColumnConfiguration {
+            Key = nameof(NwindDataItem.ProductID),
+            Type = GridLiteColumnDataType.Number,
+            Sort = new IgbColumnSortConfiguration {
+                CaseSensitive = false
+            },
+            Filter = true,
+            Resizable = true
+        },
+        new IgbColumnConfiguration {
+            Key = nameof(NwindDataItem.ProductName),
+            Type = GridLiteColumnDataType.String,
+            Sort = true,
+            Filter = true,
+            Resizable = true
         },
-        Filter = true,
-        Resizable = true
-     },
-        new ColumnConfiguration<NwindDataItem>(){
-        Key = nameof(NwindDataItem.ProductName),
-        Type = DataType.String,
-         Sort = true,
-        Filter = true,
-        Resizable = true
-     },
     };
 }

src/IgniteUI.Blazor.GridLite/IgbGridLite.razor.cs

@@ -23,7 +23,7 @@ public partial class IgbGridLite<TItem> : ComponentBase, IDisposable where TItem
     /// Column configurations for the grid
     /// </summary>
     [Parameter]
-    public List<ColumnConfiguration<TItem>>? Columns { get; set; }
+    public List<IgbColumnConfiguration>? Columns { get; set; }
 
     /// <summary>
     /// The options to customize the grid with
@@ -45,19 +45,19 @@ public partial class IgbGridLite<TItem> : ComponentBase, IDisposable where TItem
     /// Sort configuration property for the grid.
     /// </summary>
     [Parameter]
-    public GridSortConfiguration? SortConfiguration { get; set; }
+    public IgbGridLiteSortConfiguration? SortConfiguration { get; set; }
 
     /// <summary>
     /// Initial sort expressions to apply when the grid is rendered
     /// </summary>
     [Parameter]
-    public IEnumerable<SortExpression>? SortExpressions { get; set; }
+    public IEnumerable<IgbGridLiteSortExpression>? SortExpressions { get; set; }
 
     /// <summary>
     /// Initial filter expressions to apply when the grid is rendered
     /// </summary>
     [Parameter]
-    public IEnumerable<FilterExpression>? FilterExpressions { get; set; }
+    public IEnumerable<IgbGridLiteFilterExpression>? FilterExpressions { get; set; }
 
     /// <summary>
     /// Additional attributes for the component's HTML element
@@ -75,14 +75,14 @@ public partial class IgbGridLite<TItem> : ComponentBase, IDisposable where TItem
     /// The expression can be modified prior to the operation running.
     /// </remarks>
     [Parameter]
-    public EventCallback<IgbGridLiteSortingEvent> OnSorting { get; set; }
+    public EventCallback<IgbGridLiteSortingEventArgs> Sorting { get; set; }
 
     /// <summary>
     /// Fires when a sort operation initiated through the UI has completed.
     /// Returns the sort expression used for the operation.
     /// </summary>
     [Parameter]
-    public EventCallback<IgbGridLiteSortedEvent> OnSorted { get; set; }
+    public EventCallback<IgbGridLiteSortedEventArgs> Sorted { get; set; }
 
     /// <summary>
     /// Fires when filtering is initiated through the UI.
@@ -92,20 +92,20 @@ public partial class IgbGridLite<TItem> : ComponentBase, IDisposable where TItem
     /// The expression can be modified prior to the operation running.
     /// </remarks>
     [Parameter]
-    public EventCallback<IgbGridLiteFilteringEvent> OnFiltering { get; set; }
+    public EventCallback<IgbGridLiteFilteringEventArgs> Filtering { get; set; }
 
     /// <summary>
     /// Fires when a filter operation initiated through the UI has completed.
     /// Returns the filter state for the affected column.
     /// </summary>
     [Parameter]
-    public EventCallback<IgbGridLiteFilteredEvent> OnFiltered { get; set; }
+    public EventCallback<IgbGridLiteFilteredEventArgs> Filtered { get; set; }
 
     /// <summary>
     /// Fires when <see cref="RenderAsync"/> completes
     /// </summary>
     [Parameter]
-    public EventCallback OnRendered { get; set; }
+    public EventCallback Rendered { get; set; }
 
     private ElementReference grid;
     private IJSObjectReference blazorIgbGridLite;
@@ -203,17 +203,17 @@ private async Task RenderGridAsync()
         await InvokeVoidJsAsync("blazor_igc_grid_lite.renderGrid",
             jsHandler.ObjectReference, grid, json, GetEventFlags());
 
-        await OnRendered.InvokeAsync();
+        await Rendered.InvokeAsync();
     }
 
     private object GetEventFlags()
     {
         return new
         {
-            hasSorting = OnSorting.HasDelegate,
-            hasSorted = OnSorted.HasDelegate,
-            hasFiltering = OnFiltering.HasDelegate,
-            hasFiltered = OnFiltered.HasDelegate
+            hasSorting = Sorting.HasDelegate,
+            hasSorted = Sorted.HasDelegate,
+            hasFiltering = Filtering.HasDelegate,
+            hasFiltered = Filtered.HasDelegate
         };
     }
 
@@ -241,7 +241,7 @@ public virtual async Task UpdateDataAsync(IEnumerable<TItem> newData)
     /// Updates the column configurations for the grid.
     /// </summary>
     /// <param name="newColumns">The new column configurations</param>
-    public virtual async Task UpdateColumnsAsync(List<ColumnConfiguration<TItem>> newColumns)
+    public virtual async Task UpdateColumnsAsync(List<IgbColumnConfiguration> newColumns)
     {
         Columns = newColumns;
         var json = JsonSerializer.Serialize(newColumns.Select(c => c.ToJsConfig()), GridJsonSerializerOptions);
@@ -252,7 +252,7 @@ public virtual async Task UpdateColumnsAsync(List<ColumnConfiguration<TItem>> ne
     /// Performs a sort operation in the grid based on the passed expression(s).
     /// </summary>
     /// <param name="expressions">The sort expression(s) to apply</param>
-    public virtual async Task SortAsync(SortExpression expressions)
+    public virtual async Task SortAsync(IgbGridLiteSortExpression expressions)
     {
         var json = JsonSerializer.Serialize(expressions, GridJsonSerializerOptions);
         await InvokeVoidJsAsync("blazor_igc_grid_lite.sort", gridId, json);
@@ -262,7 +262,7 @@ public virtual async Task SortAsync(SortExpression expressions)
     /// Performs a sort operation in the grid based on the passed expression(s).
     /// </summary>
     /// <param name="expressions">The sort expression(s) to apply</param>
-    public virtual async Task SortAsync(List<SortExpression> expressions)
+    public virtual async Task SortAsync(List<IgbGridLiteSortExpression> expressions)
     {
         var json = JsonSerializer.Serialize(expressions, GridJsonSerializerOptions);
         await InvokeVoidJsAsync("blazor_igc_grid_lite.sort", gridId, json);
@@ -282,7 +282,7 @@ public virtual async Task ClearSortAsync(string key = null)
     /// Performs a filter operation in the grid based on the passed expression(s).
     /// </summary>
     /// <param name="expressions">The filter expression(s) to apply</param>
-    public virtual async Task FilterAsync(FilterExpression expression)
+    public virtual async Task FilterAsync(IgbGridLiteFilterExpression expression)
     {
         var json = JsonSerializer.Serialize(expression, GridJsonSerializerOptions);
         await InvokeVoidJsAsync("blazor_igc_grid_lite.filter", gridId, json);
@@ -292,7 +292,7 @@ public virtual async Task FilterAsync(FilterExpression expression)
     /// Performs a filter operation in the grid based on the passed expression(s).
     /// </summary>
     /// <param name="expressions">The filter expression(s) to apply</param>
-    public virtual async Task FilterAsync(List<FilterExpression> expressions)
+    public virtual async Task FilterAsync(List<IgbGridLiteFilterExpression> expressions)
     {
         var json = JsonSerializer.Serialize(expressions, GridJsonSerializerOptions);
         await InvokeVoidJsAsync("blazor_igc_grid_lite.filter", gridId, json);
@@ -313,7 +313,7 @@ public virtual async Task ClearFilterAsync(string key = null)
     /// </summary>
     /// <param name="key">The column key to retrieve</param>
     /// <returns>The column configuration if found, otherwise null</returns>
-    public virtual ColumnConfiguration<TItem> GetColumn(string key)
+    public virtual IgbColumnConfiguration GetColumn(string key)
     {
         return Columns?.FirstOrDefault(c => c.Key == key);
     }
@@ -323,7 +323,7 @@ public virtual ColumnConfiguration<TItem> GetColumn(string key)
     /// </summary>
     /// <param name="index">The zero-based column index</param>
     /// <returns>The column configuration if found, otherwise null</returns>
-    public virtual ColumnConfiguration<TItem> GetColumn(int index)
+    public virtual IgbColumnConfiguration GetColumn(int index)
     {
         return Columns?.ElementAtOrDefault(index);
     }