Update igniteui-grid-lite from v0.0.1 to v0.3.1 #11
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates the Blazor wrapper to match breaking API changes in
igniteui-grid-litev0.3.1.Breaking Changes
Column Configuration (v0.2.0-v0.3.0)
Key→Field,Type→DataType,HeaderText→HeaderSortobject →Sortable(bool) +SortingCaseSensitive(bool?)Filterobject →Filterable(bool) +FilteringCaseSensitive(bool?)IgbColumnFilterConfigurationandIgbColumnSortConfigurationtypesSorting API (v0.1.0)
IgbGridLiteSortConfiguration→IgbGridLiteSortingOptions,IgbGridLiteSortExpression→IgbGridLiteSortingExpressionSortConfiguration→SortingOptions,SortExpressions→SortingExpressionsMultiple(bool) →Mode(string: "single" | "multiple")TriStateproperty (always enabled)Filter Expressions
Key→FieldJavaScript Integration
sortingOptions/sortingExpressionspropertiesupdateColumnsfunction (columns update declaratively viaupdateGrid)Migration Example
Before:
After:
See CHANGELOG.md for complete migration guide.
Original prompt
Summary
The Blazor wrapper is currently using
igniteui-grid-liteversion0.0.1. It needs to be updated to match the latest API changes from version0.3.1.Changes Required
Based on the CHANGELOG.md from
igniteui-grid-lite, the following breaking changes need to be applied:From 0.3.1
updateColumnsmethod - declarative columns can be updated directly nowFrom 0.3.0 - Column Property Renames
key→field- The field from the data that the column referencestype→dataType- The data type of the column's valuesheaderText→header- The header text of the columnFrom 0.2.0 - Sort/Filter Property Changes
sortproperty replaced with:sortable(boolean)sortingCaseSensitive(boolean)sortConfiguration(object withcompareroption)filterproperty replaced with:filterable(boolean)filteringCaseSensitive(boolean)ColumnFilterConfigurationtype (usefilteringCaseSensitiveboolean directly)From 0.1.0 - Sorting API Renames
GridSortConfigurationtype →GridLiteSortingOptionsIgcGridLite.sortConfigurationproperty →sortingOptionsIgcGridLite.sortExpressionsproperty →sortingExpressionsSortExpressiontype →SortingExpressionBaseSortExpressiontype →BaseSortingExpressionGridLiteSortingOptions.multipleboolean →modeproperty ('single'or'multiple')triStateproperty (tri-state sorting always enabled)Files to Update
src/IgniteUI.Blazor.GridLite/package.json
igniteui-grid-litedependency from~0.0.1to~0.3.1src/IgniteUI.Blazor.GridLite/Models/IgbColumnConfiguration.cs
Key→Field(with[JsonPropertyName("field")])Type→DataType(with[JsonPropertyName("dataType")])HeaderText→Header(with[JsonPropertyName("header")])Sortobject property with:Sortable(bool) with[JsonPropertyName("sortable")]SortingCaseSensitive(bool?) with[JsonPropertyName("sortingCaseSensitive")]Filterobject property with:Filterable(bool) with[JsonPropertyName("filterable")]FilteringCaseSensitive(bool?) with[JsonPropertyName("filteringCaseSensitive")]ToJsConfig()method to use new property namessrc/IgniteUI.Blazor.GridLite/Models/IgbGridLiteSortConfiguration.cs → Rename to IgbGridLiteSortingOptions.cs
IgbGridLiteSortConfiguration→IgbGridLiteSortingOptionsMultiple(bool) withMode(string) using[JsonPropertyName("mode")]- accepts "single" or "multiple"TriStateproperty entirelysrc/IgniteUI.Blazor.GridLite/Models/IgbGridLiteSortExpression.cs → Rename to IgbGridLiteSortingExpression.cs
IgbGridLiteSortExpression→IgbGridLiteSortingExpressionKey→Fieldwith[JsonPropertyName("field")]src/IgniteUI.Blazor.GridLite/IgbGridLite.razor.cs
SortConfiguration→SortingOptions(typeIgbGridLiteSortingOptions)SortExpressions→SortingExpressions(typeIEnumerable<IgbGridLiteSortingExpression>)SortAsyncmethods to useIgbGridLiteSortingExpressionsrc/IgniteUI.Blazor.GridLite/igc-grid-lite-entry.js
renderGridto usesortingOptionsinstead ofsortConfigurationsortingExpressionsinstead ofsortExpressionsupdateColumnsfunction (no longer needed)updateGridto use new property namesDelete files:
src/IgniteUI.Blazor.GridLite/Models/IgbColumnFilterConfiguration.cssrc/IgniteUI.Blazor.GridLite/Models/IgbColumnSortConfiguration.cssrc/IgniteUI.Blazor.GridLite/Models/IgbGridLiteFilterExpression.cs
Key→Fieldwith[JsonPropertyName("field")]demo/GridLite.DemoApp/Components/Pages/Home.razor
Field,DataType,Sortable,Filterable, etc.)IgbGridLiteSortConfiguration→IgbGridLiteSortingOptionsIgbGridLiteSortExpression→IgbGridLiteSortingExpressionMode = "multiple"instead ofMultiple = trueTriStateusageREADME.md
Add CHANGELOG.md documenting all breaking changes
Event Args Updates
Also update event args classes if they reference the old property names:
IgbGridLiteSortingEventArgs- ensure it uses new expression typesIgbGridLiteSortedEventArgs- ensure it uses new expression typesThis pull request was created from Copilot chat.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.