diff --git a/CHANGELOG.md b/CHANGELOG.md index 4794150..ea065c6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - **BREAKING**: In the `Filtering` and `Filtered` events, `IgbGridLiteFilterExpression.SearchTerm` holds a `string`, `double` or `bool` instead of a `JsonElement`. Numbers are always `double`, as JavaScript has one number type, so a search term set as an `int` comes back as a `double`. - **BREAKING**: `IgbGridLiteFilterExpression.Criteria` is a `GridLiteFilterCriteria?` (`And`, `Or`) instead of a `string?`, and `IgbGridLiteFilteringEventArgs.Type` is a `GridLiteFilteringType` (`Add`, `Modify`, `Remove`) instead of a `string`. - **BREAKING**: `IgbGridLiteFilteringEventArgs.Expressions` and `IgbGridLiteFilteredEventArgs.State` are `IReadOnlyList` instead of `List`. +- **BREAKING**: Renamed `IgbColumnConfiguration` → `IgbGridLiteColumnConfiguration`, the only public type without `GridLite` in its name. +- **BREAKING**: `GetColumnsAsync` returns `Task` instead of a `ValueTask`, like the grid's other methods. +- **BREAKING**: The single-expression overload of `SortAsync` names its parameter `expression` instead of `expressions`. Only calls that name the argument are affected. +- **BREAKING**: `NavigateToAsync` takes its `row` index as an `int` instead of a `long`, like collection indexers and other grids' row-index APIs. Calls passing a `long` need a cast. ## 0.10.0 - 2026-09-29 diff --git a/demo/GridLite.DemoApp/Components/Pages/Home.razor b/demo/GridLite.DemoApp/Components/Pages/Home.razor index 6b37023..7c9c153 100644 --- a/demo/GridLite.DemoApp/Components/Pages/Home.razor +++ b/demo/GridLite.DemoApp/Components/Pages/Home.razor @@ -89,7 +89,7 @@ { cols = [ .. cols, - new IgbColumnConfiguration { + new IgbGridLiteColumnConfiguration { Field = nameof(NwindDataItem.QuantityPerUnit), Header="Quantity Per Unit", DataType = GridLiteColumnDataType.String, @@ -97,7 +97,7 @@ Filterable = true, Resizable = true }, - new IgbColumnConfiguration { + new IgbGridLiteColumnConfiguration { Field = nameof(NwindDataItem.UnitPrice), Header="Unit Price", DataType = GridLiteColumnDataType.Number, @@ -155,8 +155,8 @@ } - public List cols = new List { - new IgbColumnConfiguration { + public List cols = new List { + new IgbGridLiteColumnConfiguration { Field = nameof(NwindDataItem.ProductID), Header="Product ID", DataType = GridLiteColumnDataType.Number, @@ -165,7 +165,7 @@ Filterable = true, Resizable = false }, - new IgbColumnConfiguration { + new IgbGridLiteColumnConfiguration { Field = nameof(NwindDataItem.ProductName), Header="Product Name", DataType = GridLiteColumnDataType.String, diff --git a/src/IgniteUI.Blazor.GridLite/IgbGridLite.razor.cs b/src/IgniteUI.Blazor.GridLite/IgbGridLite.razor.cs index a617a07..a17f460 100644 --- a/src/IgniteUI.Blazor.GridLite/IgbGridLite.razor.cs +++ b/src/IgniteUI.Blazor.GridLite/IgbGridLite.razor.cs @@ -293,11 +293,11 @@ public async Task UpdateDataAsync(IEnumerable newData) /// /// Performs a sort operation in the grid based on the passed expression(s). /// - /// The sort expression(s) to apply - public async Task SortAsync(IgbGridLiteSortingExpression expressions) + /// The sort expression to apply + public async Task SortAsync(IgbGridLiteSortingExpression expression) { - ArgumentNullException.ThrowIfNull(expressions); - var json = JsonSerializer.Serialize(expressions, GridLiteJsonContext.Default.IgbGridLiteSortingExpression); + ArgumentNullException.ThrowIfNull(expression); + var json = JsonSerializer.Serialize(expression, GridLiteJsonContext.Default.IgbGridLiteSortingExpression); await InvokeGridAsync("blazor_igc_grid_lite.sort", gridId, json); } @@ -358,7 +358,7 @@ public async Task ClearFilterAsync(string? key = null) /// Returns the current column configuration list. /// /// The column configurations - public async ValueTask GetColumnsAsync() + public async Task GetColumnsAsync() { if (!await clientRender.Task) { @@ -367,7 +367,7 @@ public async ValueTask GetColumnsAsync() var columns = await InvokeJsAsync("blazor_igc_grid_lite.getColumns", gridId); return columns is { ValueKind: JsonValueKind.Array } array - ? array.Deserialize(GridLiteJsonContext.Default.IgbColumnConfigurationArray) ?? [] + ? array.Deserialize(GridLiteJsonContext.Default.IgbGridLiteColumnConfigurationArray) ?? [] : []; } @@ -377,7 +377,7 @@ public async ValueTask GetColumnsAsync() /// The row index to navigate to /// The column field to navigate to, if any /// Optionally also activate the navigated cell - public async Task NavigateToAsync(long row, string? field = null, bool activate = false) + public async Task NavigateToAsync(int row, string? field = null, bool activate = false) { await InvokeGridAsync("blazor_igc_grid_lite.navigateTo", gridId, row, field, activate); } diff --git a/src/IgniteUI.Blazor.GridLite/Internal/GridLiteJsonContext.cs b/src/IgniteUI.Blazor.GridLite/Internal/GridLiteJsonContext.cs index 73614de..d1ac4e4 100644 --- a/src/IgniteUI.Blazor.GridLite/Internal/GridLiteJsonContext.cs +++ b/src/IgniteUI.Blazor.GridLite/Internal/GridLiteJsonContext.cs @@ -16,7 +16,7 @@ namespace IgniteUI.Blazor.Controls.Internal; [JsonSerializable(typeof(IEnumerable))] [JsonSerializable(typeof(IgbGridLiteFilterExpression))] [JsonSerializable(typeof(IEnumerable))] -[JsonSerializable(typeof(IgbColumnConfiguration[]))] +[JsonSerializable(typeof(IgbGridLiteColumnConfiguration[]))] [JsonSerializable(typeof(IgbGridLiteFilteringEventArgs))] [JsonSerializable(typeof(IgbGridLiteFilteredEventArgs))] internal partial class GridLiteJsonContext : JsonSerializerContext diff --git a/src/IgniteUI.Blazor.GridLite/Models/IgbColumnConfiguration.cs b/src/IgniteUI.Blazor.GridLite/Models/IgbGridLiteColumnConfiguration.cs similarity index 98% rename from src/IgniteUI.Blazor.GridLite/Models/IgbColumnConfiguration.cs rename to src/IgniteUI.Blazor.GridLite/Models/IgbGridLiteColumnConfiguration.cs index ac54954..54b461b 100644 --- a/src/IgniteUI.Blazor.GridLite/Models/IgbColumnConfiguration.cs +++ b/src/IgniteUI.Blazor.GridLite/Models/IgbGridLiteColumnConfiguration.cs @@ -6,7 +6,7 @@ namespace IgniteUI.Blazor.Controls; /// /// A column's configuration as the grid reports it, returned by . /// -public class IgbColumnConfiguration +public class IgbGridLiteColumnConfiguration { /// /// The field from the data that the column references. diff --git a/tests/IgniteUI.Blazor.GridLite.Tests/GridLiteJsInteropTests.cs b/tests/IgniteUI.Blazor.GridLite.Tests/GridLiteJsInteropTests.cs index 855166f..b063b9a 100644 --- a/tests/IgniteUI.Blazor.GridLite.Tests/GridLiteJsInteropTests.cs +++ b/tests/IgniteUI.Blazor.GridLite.Tests/GridLiteJsInteropTests.cs @@ -398,7 +398,7 @@ public async Task NavigateToAsync_InvokesNavigateTo_WithAllArguments() var invocation = GridApi.VerifyInvoke($"{Api}.navigateTo"); Assert.Equal(cut.Find("igc-grid-lite").GetAttribute("id"), invocation.Arguments[0]); - Assert.Equal(5L, invocation.Arguments[1]); + Assert.Equal(5, invocation.Arguments[1]); Assert.Equal("Price", invocation.Arguments[2]); Assert.True(Assert.IsType(invocation.Arguments[3])); } @@ -428,7 +428,7 @@ public async Task GetColumnsAsync_ReturnsEmpty_WhenJsReturnsNothing() { var cut = RenderGrid(); - var columns = await cut.InvokeAsync(() => cut.Instance.GetColumnsAsync().AsTask()); + var columns = await cut.InvokeAsync(() => cut.Instance.GetColumnsAsync()); Assert.Empty(columns); } @@ -439,12 +439,12 @@ public async Task GetColumnsAsync_ReturnsColumns_FromJsResult() var cut = RenderGrid(); var expected = new[] { - new IgbColumnConfiguration { Field = "Name", Sortable = true }, - new IgbColumnConfiguration { Field = "Price", DataType = GridLiteColumnDataType.Number }, + new IgbGridLiteColumnConfiguration { Field = "Name", Sortable = true }, + new IgbGridLiteColumnConfiguration { Field = "Price", DataType = GridLiteColumnDataType.Number }, }; GridApi.Setup($"{Api}.getColumns", _ => true).SetResult(JsonSerializer.SerializeToElement(expected)); - var columns = await cut.InvokeAsync(() => cut.Instance.GetColumnsAsync().AsTask()); + var columns = await cut.InvokeAsync(() => cut.Instance.GetColumnsAsync()); var invocation = GridApi.VerifyInvoke($"{Api}.getColumns"); Assert.Equal(cut.Find("igc-grid-lite").GetAttribute("id"), invocation.Arguments[0]); diff --git a/tests/IgniteUI.Blazor.GridLite.Tests/ModelSerializationTests.cs b/tests/IgniteUI.Blazor.GridLite.Tests/ModelSerializationTests.cs index bf20bb7..f11c8fd 100644 --- a/tests/IgniteUI.Blazor.GridLite.Tests/ModelSerializationTests.cs +++ b/tests/IgniteUI.Blazor.GridLite.Tests/ModelSerializationTests.cs @@ -169,13 +169,13 @@ public void SortingOptions_SerializesMode(GridLiteSortingMode mode, string expec [Fact] public void ColumnConfiguration_SerializesWithCamelCaseKeys_OmittingDefaults() { - var json = SerializeToElement(new IgbColumnConfiguration + var json = SerializeToElement(new IgbGridLiteColumnConfiguration { Field = "Price", DataType = GridLiteColumnDataType.Number, Header = "Unit Price", Sortable = true, - }, Context.IgbColumnConfiguration); + }, Context.IgbGridLiteColumnConfiguration); Assert.Equal("Price", json.GetProperty("field").GetString()); Assert.Equal("number", json.GetProperty("dataType").GetString()); @@ -198,7 +198,7 @@ public void ColumnConfiguration_DeserializesFromJsPayload() "filterable":true,"filteringCaseSensitive":false} """; - var column = JsonSerializer.Deserialize(payload, Context.IgbColumnConfiguration); + var column = JsonSerializer.Deserialize(payload, Context.IgbGridLiteColumnConfiguration); Assert.NotNull(column); Assert.Equal("ProductName", column.Field);