igniteui-cli 15.5.1 → 15.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +4 -4
- package/templates/blazor/igb/projects/ai-config/files/skills/AGENTS.md +6 -3
- package/templates/blazor/igb/projects/ai-config/files/skills/README.md +30 -45
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/SKILL.md +48 -96
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/charts.md +61 -238
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/data-display.md +60 -193
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/feedback.md +36 -92
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/form-controls.md +66 -224
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/layout-manager.md +39 -88
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/layout.md +75 -152
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/setup.md +40 -149
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-generate-from-image-design/SKILL.md +58 -243
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-generate-from-image-design/references/component-mapping.md +89 -280
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-generate-from-image-design/references/gotchas.md +143 -431
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/SKILL.md +91 -157
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/data-operations.md +50 -228
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/editing.md +61 -222
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/features.md +67 -360
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/grid-migration.md +55 -236
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/paging-remote.md +53 -202
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/sizing.md +31 -232
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/state.md +27 -119
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/structure.md +88 -363
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/types.md +87 -415
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-lite-testing/SKILL.md +8 -4
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-lite-testing/references/interop-contracts.md +42 -6
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-theming/SKILL.md +83 -211
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-theming/references/common-patterns.md +93 -184
- package/templates/react/igr-ts/avatar/default/files/src/app/__path__/__filePrefix__.tsx +3 -3
- package/templates/react/igr-ts/avatar/default/files/src/app/__path__/style.module.css +9 -0
- package/templates/react/igr-ts/button/default/files/src/app/__path__/__filePrefix__.tsx +1 -1
- package/templates/react/igr-ts/button/default/files/src/app/__path__/style.module.css +3 -0
- package/templates/react/igr-ts/icon/default/files/src/app/__path__/__filePrefix__.tsx +2 -2
- package/templates/react/igr-ts/icon/default/files/src/app/__path__/style.module.css +3 -0
- package/templates/react/igr-ts/icon-button/default/files/src/app/__path__/__filePrefix__.tsx +1 -1
- package/templates/react/igr-ts/icon-button/default/files/src/app/__path__/style.module.css +3 -0
- package/templates/react/igr-ts/pivot-grid/basic/files/src/app/__path__/__filePrefix__.tsx +3 -4
- package/templates/react/igr-ts/projects/_base/files/package.json +1 -0
- package/templates/react/igr-ts/projects/ai-config/files/skills/README.md +30 -83
- package/templates/react/igr-ts/projects/ai-config/files/skills/grid-lite-to-igr-grid-migration/SKILL.md +98 -191
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/SKILL.md +38 -147
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/COMPONENTS.md +65 -0
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/DATAVIZ.md +90 -0
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/MCP.md +43 -0
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/TROUBLESHOOTING.md +17 -145
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/USAGE.md +85 -0
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-customize-theme/SKILL.md +83 -135
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-customize-theme/reference/CSS-THEMING.md +51 -218
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-generate-from-image-design/SKILL.md +58 -187
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-generate-from-image-design/reference/gotchas.md +55 -154
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-optimize-bundle-size/SKILL.md +48 -401
- package/templates/webcomponents/igc-ts/avatar/default/files/src/app/__path__/__filePrefix__.ts +7 -2
- package/templates/webcomponents/igc-ts/button/default/files/src/app/__path__/__filePrefix__.ts +8 -3
- package/templates/webcomponents/igc-ts/card/default/files/src/app/__path__/__filePrefix__.ts +3 -1
- package/templates/webcomponents/igc-ts/constants.d.ts +5 -5
- package/templates/webcomponents/igc-ts/constants.js +5 -5
- package/templates/webcomponents/igc-ts/date-time-input/default/files/src/app/__path__/__filePrefix__.ts +8 -2
- package/templates/webcomponents/igc-ts/icon/default/files/src/app/__path__/__filePrefix__.ts +7 -3
- package/templates/webcomponents/igc-ts/icon-button/default/files/src/app/__path__/__filePrefix__.ts +8 -2
- package/templates/webcomponents/igc-ts/projects/_base/files/package.json +1 -1
- package/templates/webcomponents/igc-ts/projects/_base_with_home/files/package.json +6 -6
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/README.md +1 -0
- package/templates/webcomponents/igc-ts/projects/side-nav-auth/files/src/app/authentication/login-bar/login-bar.ts +1 -1
- package/templates/webcomponents/igc-ts/tabs/default/files/src/app/__path__/__filePrefix__.ts +21 -15
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/mcp-setup.md +0 -78
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/mcp-setup.md +0 -78
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-theming/references/mcp-setup.md +0 -81
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/CHARTS-GRIDS.md +0 -398
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/COMPONENT-CATALOGUE.md +0 -161
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/EVENT-HANDLING.md +0 -72
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/INSTALLATION.md +0 -139
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/JSX-PATTERNS.md +0 -187
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/MCP-SERVER.md +0 -77
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/REFS-FORMS.md +0 -232
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-customize-theme/reference/MCP-SERVER.md +0 -67
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-customize-theme/reference/TROUBLESHOOTING.md +0 -35
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-generate-from-image-design/reference/component-mapping.md +0 -132
- /package/templates/webcomponents/igc-ts/tabs/default/files/src/app/__path__/{__filePrefix__.test → __filePrefix__.test.ts} +0 -0
|
@@ -1,525 +1,197 @@
|
|
|
1
|
-
# Grid Types
|
|
1
|
+
# Grid Types — Grid Lite, Tree Grid, Hierarchical Grid, Pivot Grid
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
> For `IgbGrid` setup and column configuration — see [`structure.md`](./structure.md).
|
|
5
|
-
|
|
6
|
-
## Contents
|
|
7
|
-
|
|
8
|
-
- [Grid Lite (`IgbGridLite`)](#grid-lite-igbgridlite)
|
|
9
|
-
- [Tree Grid (`IgbTreeGrid`)](#tree-grid-igbtreegrid)
|
|
10
|
-
- [Hierarchical Grid (`IgbHierarchicalGrid`)](#hierarchical-grid-igbhierarchicalgrid)
|
|
11
|
-
- [Pivot Grid (`IgbPivotGrid`)](#pivot-grid-igbpivotgrid)
|
|
12
|
-
- [Key Rules by Grid Type](#key-rules-by-grid-type)
|
|
13
|
-
|
|
14
|
-
---
|
|
3
|
+
`IgbGrid` setup and columns are in [`structure.md`](./structure.md); everything here is what differs.
|
|
15
4
|
|
|
16
5
|
## Grid Lite (`IgbGridLite`)
|
|
17
6
|
|
|
18
|
-
Lightweight
|
|
19
|
-
|
|
20
|
-
> **No editing, selection, or paging.** Upgrade to `IgbGrid` when those features are needed.
|
|
21
|
-
|
|
22
|
-
### Registration
|
|
7
|
+
Lightweight read-only grid with sorting, filtering, column resizing/hiding, and virtualization. MIT-licensed, in its own `IgniteUI.Blazor.GridLite` package — **not** bundled with `IgniteUI.Blazor`. No editing, selection, or paging; when those are needed, migrate to `IgbGrid` ([`grid-migration.md`](./grid-migration.md)).
|
|
23
8
|
|
|
24
9
|
```csharp
|
|
25
|
-
//
|
|
10
|
+
// dotnet add package IgniteUI.Blazor.GridLite
|
|
26
11
|
builder.Services.AddIgniteUIBlazor(typeof(IgbGridLiteModule));
|
|
27
12
|
```
|
|
28
13
|
|
|
29
|
-
Add the Grid Lite CSS in `index.html`:
|
|
30
|
-
|
|
31
14
|
```html
|
|
32
15
|
<link href="_content/IgniteUI.Blazor.GridLite/css/themes/light/bootstrap.css" rel="stylesheet" />
|
|
33
16
|
```
|
|
34
17
|
|
|
35
|
-
### Basic usage
|
|
36
|
-
|
|
37
|
-
Columns are declared as child elements (`<IgbGridLiteColumn>`), not via a `Columns` parameter:
|
|
38
|
-
|
|
39
|
-
```razor
|
|
40
|
-
<IgbGridLite TItem="Employee" Data="@employees">
|
|
41
|
-
<IgbGridLiteColumn Field="@nameof(Employee.Name)" Header="Name" DataType="GridLiteColumnDataType.String" Sortable Filterable Resizable />
|
|
42
|
-
<IgbGridLiteColumn Field="@nameof(Employee.Department)" Header="Department" Sortable />
|
|
43
|
-
<IgbGridLiteColumn Field="@nameof(Employee.Salary)" Header="Salary" DataType="GridLiteColumnDataType.Number" Sortable />
|
|
44
|
-
<IgbGridLiteColumn Field="@nameof(Employee.HireDate)" Header="Hire Date" DataType="GridLiteColumnDataType.Date" Sortable />
|
|
45
|
-
</IgbGridLite>
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
### Column properties
|
|
49
|
-
|
|
50
|
-
| Property | Description |
|
|
51
|
-
|---|---|
|
|
52
|
-
| `Field` | Property name on the data item |
|
|
53
|
-
| `Header` | Column header text |
|
|
54
|
-
| `DataType` | `GridLiteColumnDataType.String/Number/Boolean/Date` |
|
|
55
|
-
| `Width` | Column width (e.g., `"150px"`) |
|
|
56
|
-
| `Sortable` | Enables sorting on this column |
|
|
57
|
-
| `SortingCaseSensitive` | Case-sensitive sorting (use alongside `Sortable`) |
|
|
58
|
-
| `Filterable` | Enables filtering on this column |
|
|
59
|
-
| `FilteringCaseSensitive` | Case-sensitive filtering (use alongside `Filterable`) |
|
|
60
|
-
| `Resizable` | Allows column resize |
|
|
61
|
-
| `Hidden` | Hides the column |
|
|
62
|
-
|
|
63
|
-
> **`Key` vs `Field`:** Use `Field` on column definitions. In sort/filter expression objects (`IgbGridLiteSortingExpression`, `IgbGridLiteFilterExpression`), use `Key` to identify the field.
|
|
64
|
-
|
|
65
|
-
### Grid-level sorting options
|
|
66
|
-
|
|
67
18
|
```razor
|
|
68
|
-
<IgbGridLite TItem="
|
|
69
|
-
|
|
70
|
-
|
|
19
|
+
<IgbGridLite TItem="Employee" Data="@employees" SortingOptions="@sortingOptions"
|
|
20
|
+
Sorting="@HandleSorting" Sorted="@HandleSorted"
|
|
21
|
+
Filtering="@HandleFiltering" Filtered="@HandleFiltered">
|
|
22
|
+
<IgbGridLiteColumn Field="@nameof(Employee.Name)" Header="Name"
|
|
23
|
+
DataType="GridLiteColumnDataType.String" Sortable Filterable Resizable />
|
|
24
|
+
<IgbGridLiteColumn Field="@nameof(Employee.Salary)" Header="Salary"
|
|
25
|
+
DataType="GridLiteColumnDataType.Number" Sortable />
|
|
26
|
+
@if (showHireDate)
|
|
27
|
+
{
|
|
28
|
+
<IgbGridLiteColumn Field="@nameof(Employee.HireDate)" Header="Hire Date"
|
|
29
|
+
DataType="GridLiteColumnDataType.Date" Sortable />
|
|
30
|
+
}
|
|
71
31
|
</IgbGridLite>
|
|
72
32
|
|
|
73
33
|
@code {
|
|
74
34
|
private IgbGridLiteSortingOptions sortingOptions = new()
|
|
75
35
|
{
|
|
76
|
-
Mode = GridLiteSortingMode.Multiple
|
|
36
|
+
Mode = GridLiteSortingMode.Multiple // default Single
|
|
77
37
|
};
|
|
38
|
+
private bool showHireDate = true;
|
|
78
39
|
}
|
|
79
40
|
```
|
|
80
41
|
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
### Dynamic columns
|
|
84
|
-
|
|
85
|
-
Use `@if` conditional rendering. There is no `UpdateColumnsAsync()` method:
|
|
86
|
-
|
|
87
|
-
```razor
|
|
88
|
-
<IgbGridLite TItem="ProductInfo" Data="@products">
|
|
89
|
-
<IgbGridLiteColumn Field="Name" Header="Name" Sortable />
|
|
90
|
-
@if (showRating)
|
|
91
|
-
{
|
|
92
|
-
<IgbGridLiteColumn Field="Rating" Header="Rating" DataType="GridLiteColumnDataType.Number" />
|
|
93
|
-
}
|
|
94
|
-
</IgbGridLite>
|
|
95
|
-
|
|
96
|
-
@code {
|
|
97
|
-
private bool showRating = true;
|
|
98
|
-
private void ToggleRating() => showRating = !showRating;
|
|
99
|
-
}
|
|
100
|
-
```
|
|
101
|
-
|
|
102
|
-
### Sorting and filtering events
|
|
42
|
+
Column parameters: `Field`, `Header`, `DataType` (`String | Number | Boolean | Date`), `Width`, `Sortable`, `SortingCaseSensitive`, `Filterable`, `FilteringCaseSensitive`, `Resizable`, `Hidden`.
|
|
103
43
|
|
|
104
|
-
|
|
105
|
-
<IgbGridLite TItem="ProductInfo" Data="@products"
|
|
106
|
-
Sorting="@HandleSorting"
|
|
107
|
-
Sorted="@HandleSorted"
|
|
108
|
-
Filtering="@HandleFiltering"
|
|
109
|
-
Filtered="@HandleFiltered">
|
|
110
|
-
<IgbGridLiteColumn Field="Name" Header="Name" Sortable Filterable />
|
|
111
|
-
</IgbGridLite>
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
### Grid Lite key rules
|
|
115
|
-
|
|
116
|
-
1. **Declarative columns** - use `<IgbGridLiteColumn>` child elements. The old `Columns` parameter + `List<IgbColumnConfiguration>` is removed.
|
|
117
|
-
2. **Column properties**: `Key` → `Field`, `Type` → `DataType`, `HeaderText` → `Header`.
|
|
118
|
-
3. **Sort/filter attributes**: `Sort = true` → `Sortable`; `Filter = true` → `Filterable`.
|
|
119
|
-
4. **Grid-level sorting**: `SortConfiguration` → `SortingOptions`; `IgbGridLiteSortConfiguration` → `IgbGridLiteSortingOptions`; `Multiple = true/false` → `Mode = GridLiteSortingMode.Multiple/Single`.
|
|
120
|
-
5. **Dynamic columns via `@if`** - `UpdateColumnsAsync()` is removed.
|
|
121
|
-
6. **Own package and CSS** - install `IgniteUI.Blazor.GridLite` and include its CSS theme separately.
|
|
122
|
-
7. **Upgrade path** - when Grid Lite's capabilities are insufficient, upgrade to `IgbGrid`.
|
|
44
|
+
Grid Lite specifics that trip people up:
|
|
123
45
|
|
|
124
|
-
|
|
46
|
+
- Columns are **declarative children** (`IgbGridLiteColumn`). The old `Columns` parameter taking `List<IgbColumnConfiguration>` is gone.
|
|
47
|
+
- Renames from the old API: `Key` → `Field`, `Type` → `DataType`, `HeaderText` → `Header`, `Sort` → `Sortable`, `Filter` → `Filterable`, `SortConfiguration` → `SortingOptions`, `IgbGridLiteSortConfiguration` → `IgbGridLiteSortingOptions`, `Multiple = true/false` → `Mode = GridLiteSortingMode.Multiple/Single`.
|
|
48
|
+
- **`Field` on columns, `Key` in expressions.** `IgbGridLiteSortingExpression` and `IgbGridLiteFilterExpression` identify the field with `Key`.
|
|
49
|
+
- Change the column set with `@if` — there is no `UpdateColumnsAsync()`.
|
|
50
|
+
- Tri-state sorting (asc → desc → none) is always on and cannot be disabled.
|
|
51
|
+
- Remote operations go through `DataPipelineConfiguration`, not events + noop strategies.
|
|
125
52
|
|
|
126
53
|
## Tree Grid (`IgbTreeGrid`)
|
|
127
54
|
|
|
128
|
-
|
|
55
|
+
Self-referencing parent-child data in a single schema. Register `IgbTreeGridModule`.
|
|
129
56
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
```csharp
|
|
133
|
-
builder.Services.AddIgniteUIBlazor(typeof(IgbTreeGridModule));
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
### Option A - Foreign Key (flat data with parent-child relationship)
|
|
57
|
+
Choose **one** shape — never both:
|
|
137
58
|
|
|
138
59
|
```razor
|
|
60
|
+
@* A: flat data with a parent reference *@
|
|
139
61
|
<IgbTreeGrid Data="employees" PrimaryKey="Id" ForeignKey="ManagerId"
|
|
140
62
|
AutoGenerate="false" Width="100%" Height="600px">
|
|
141
|
-
<IgbColumn Field="Id" Header="ID" DataType="GridColumnDataType.Number" />
|
|
142
63
|
<IgbColumn Field="Name" Header="Employee" DataType="GridColumnDataType.String" />
|
|
143
64
|
<IgbColumn Field="Title" Header="Title" DataType="GridColumnDataType.String" />
|
|
144
|
-
<IgbColumn Field="HireDate" Header="Hire Date" DataType="GridColumnDataType.Date" />
|
|
145
65
|
</IgbTreeGrid>
|
|
146
66
|
|
|
147
|
-
|
|
148
|
-
private List<Employee> employees = new()
|
|
149
|
-
{
|
|
150
|
-
// flat list: root rows have null ManagerId
|
|
151
|
-
new(1, "Casey Houston", "VP", null, new DateTime(2017, 1, 15)),
|
|
152
|
-
new(2, "Gilberto Todd", "Director", 1, new DateTime(2018, 3, 20)),
|
|
153
|
-
// ...
|
|
154
|
-
};
|
|
155
|
-
|
|
156
|
-
record Employee(int Id, string Name, string Title, int? ManagerId, DateTime HireDate);
|
|
157
|
-
}
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
The `ForeignKey` property identifies which field references the parent's `PrimaryKey`. Rows with `null` (or 0/default) in the foreign key are root-level.
|
|
161
|
-
|
|
162
|
-
### Option B - Child Collection (nested data)
|
|
163
|
-
|
|
164
|
-
```razor
|
|
67
|
+
@* B: nested child collections *@
|
|
165
68
|
<IgbTreeGrid Data="fileSystem" PrimaryKey="Id" ChildDataKey="Children"
|
|
166
|
-
AutoGenerate="false" Width="100%" Height="500px">
|
|
69
|
+
ExpansionDepth="1" AutoGenerate="false" Width="100%" Height="500px">
|
|
167
70
|
<IgbColumn Field="Name" Header="Name" DataType="GridColumnDataType.String" />
|
|
168
71
|
<IgbColumn Field="Size" Header="Size (KB)" DataType="GridColumnDataType.Number" />
|
|
169
|
-
<IgbColumn Field="Type" Header="Type" DataType="GridColumnDataType.String" />
|
|
170
72
|
</IgbTreeGrid>
|
|
171
73
|
|
|
172
74
|
@code {
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
new FileNode { Id = 1, Name = "Documents", Type = "Folder", Size = 0,
|
|
176
|
-
Children = new() {
|
|
177
|
-
new FileNode { Id = 2, Name = "Resume.pdf", Type = "PDF", Size = 250 }
|
|
178
|
-
}
|
|
179
|
-
},
|
|
180
|
-
// ...
|
|
181
|
-
};
|
|
75
|
+
// A: root rows have null (or 0/default) in the foreign key
|
|
76
|
+
record Employee(int Id, string Name, string Title, int? ManagerId, DateTime HireDate);
|
|
182
77
|
|
|
183
|
-
|
|
78
|
+
// B: ChildDataKey names the collection property on each row
|
|
79
|
+
class FileNode
|
|
184
80
|
{
|
|
185
81
|
public int Id { get; set; }
|
|
186
82
|
public string Name { get; set; } = "";
|
|
187
|
-
public string Type { get; set; } = "";
|
|
188
83
|
public int Size { get; set; }
|
|
189
84
|
public List<FileNode> Children { get; set; } = new();
|
|
190
85
|
}
|
|
191
86
|
}
|
|
192
87
|
```
|
|
193
88
|
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
### Cascade selection
|
|
197
|
-
|
|
198
|
-
When using `RowSelection="GridSelectionMode.MultipleCascade"`, selecting a parent automatically selects all its descendants:
|
|
199
|
-
|
|
200
|
-
```razor
|
|
201
|
-
<IgbTreeGrid Data="data" PrimaryKey="Id" ForeignKey="ParentId"
|
|
202
|
-
RowSelection="GridSelectionMode.MultipleCascade">
|
|
203
|
-
...
|
|
204
|
-
</IgbTreeGrid>
|
|
205
|
-
```
|
|
206
|
-
|
|
207
|
-
### Expansion depth
|
|
208
|
-
|
|
209
|
-
Control how many levels are expanded by default:
|
|
210
|
-
|
|
211
|
-
```razor
|
|
212
|
-
<IgbTreeGrid Data="data" PrimaryKey="Id" ChildDataKey="Children"
|
|
213
|
-
ExpansionDepth="1">
|
|
214
|
-
...
|
|
215
|
-
</IgbTreeGrid>
|
|
216
|
-
```
|
|
217
|
-
|
|
218
|
-
`ExpansionDepth="0"` collapses all; `ExpansionDepth="1"` shows the first level expanded.
|
|
219
|
-
|
|
220
|
-
### Load on Demand
|
|
221
|
-
|
|
222
|
-
> **Note:** Load-on-demand in the Blazor Tree Grid is handled via **JavaScript interop** only. There is no pure-C# `LoadChildrenOnDemand` callback. Use `HasChildrenKey` to indicate which rows have children, and register a JS handler via `LoadChildrenOnDemandScript` to fetch and supply child data when a row is expanded.
|
|
223
|
-
|
|
224
|
-
### Tree Grid key parameters
|
|
225
|
-
|
|
226
|
-
| Parameter | Type | Description |
|
|
89
|
+
| Parameter | Type | Purpose |
|
|
227
90
|
|---|---|---|
|
|
228
|
-
| `PrimaryKey` | `string` |
|
|
229
|
-
| `ForeignKey` | `string` | Parent reference field
|
|
230
|
-
| `ChildDataKey` | `string` | Child collection property
|
|
231
|
-
| `HasChildrenKey` | `string` | Boolean field for load-on-demand |
|
|
232
|
-
| `ExpansionDepth` | `double` |
|
|
233
|
-
| `
|
|
234
|
-
| `CascadeOnDelete` | `bool` | Whether deleting a parent also deletes its children |
|
|
235
|
-
|
|
236
|
-
---
|
|
91
|
+
| `PrimaryKey` | `string` | Required |
|
|
92
|
+
| `ForeignKey` | `string` | Parent reference field — flat data |
|
|
93
|
+
| `ChildDataKey` | `string` | Child collection property — nested data |
|
|
94
|
+
| `HasChildrenKey` | `string` | Boolean field marking expandable rows, for load-on-demand |
|
|
95
|
+
| `ExpansionDepth` | `double` | Levels expanded initially; `0` collapses all |
|
|
96
|
+
| `CascadeOnDelete` | `bool` | Deleting a parent deletes its descendants |
|
|
237
97
|
|
|
238
|
-
|
|
98
|
+
`RowSelection="GridSelectionMode.MultipleCascade"` selects all descendants with the parent. Filtering is recursive — matching rows are kept along with their ancestors, so the tree stays navigable.
|
|
239
99
|
|
|
240
|
-
|
|
100
|
+
**Load on demand is JS-interop only.** There is no C# callback: set `HasChildrenKey` and register a handler through `LoadChildrenOnDemandScript` to supply children when a row expands.
|
|
241
101
|
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
```csharp
|
|
245
|
-
builder.Services.AddIgniteUIBlazor(typeof(IgbHierarchicalGridModule));
|
|
246
|
-
```
|
|
102
|
+
## Hierarchical Grid (`IgbHierarchicalGrid`)
|
|
247
103
|
|
|
248
|
-
|
|
104
|
+
Multi-schema parent-child, where each level has its own columns. Register `IgbHierarchicalGridModule`.
|
|
249
105
|
|
|
250
106
|
```razor
|
|
251
|
-
<IgbHierarchicalGrid Data="customers" PrimaryKey="CustomerId"
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
<IgbColumn Field="CompanyName" Header="Company"
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
107
|
+
<IgbHierarchicalGrid Data="customers" PrimaryKey="CustomerId" AutoGenerate="false"
|
|
108
|
+
Width="100%" Height="600px"
|
|
109
|
+
RowSelection="GridSelectionMode.Multiple" AllowFiltering="true">
|
|
110
|
+
<IgbColumn Field="CompanyName" Header="Company" Sortable="true" Filterable="true" />
|
|
111
|
+
|
|
112
|
+
<IgbRowIsland ChildDataKey="Orders" PrimaryKey="OrderId" AutoGenerate="false"
|
|
113
|
+
RowSelection="GridSelectionMode.Single"
|
|
114
|
+
AllowFiltering="true" FilterMode="FilterMode.ExcelStyleFilter"
|
|
115
|
+
GridCreated="OnChildGridCreated">
|
|
259
116
|
<IgbColumn Field="OrderDate" Header="Date" DataType="GridColumnDataType.Date" />
|
|
260
|
-
<IgbColumn Field="
|
|
117
|
+
<IgbColumn Field="Total" HasSummary="true" DataType="GridColumnDataType.Currency" />
|
|
261
118
|
|
|
262
119
|
<IgbRowIsland ChildDataKey="OrderDetails" PrimaryKey="DetailId" AutoGenerate="false">
|
|
263
|
-
<IgbColumn Field="
|
|
264
|
-
<IgbColumn Field="ProductName" Header="Product" DataType="GridColumnDataType.String" />
|
|
120
|
+
<IgbColumn Field="ProductName" Header="Product" />
|
|
265
121
|
<IgbColumn Field="Quantity" Header="Qty" DataType="GridColumnDataType.Number" />
|
|
266
|
-
<IgbColumn Field="UnitPrice" Header="Price" DataType="GridColumnDataType.Currency" />
|
|
267
122
|
</IgbRowIsland>
|
|
268
123
|
</IgbRowIsland>
|
|
269
124
|
</IgbHierarchicalGrid>
|
|
270
125
|
|
|
271
|
-
@code {
|
|
272
|
-
private List<Customer> customers = new();
|
|
273
|
-
|
|
274
|
-
protected override void OnInitialized()
|
|
275
|
-
{
|
|
276
|
-
customers = CustomerService.GetCustomersWithOrders();
|
|
277
|
-
}
|
|
278
|
-
|
|
279
|
-
public class Customer
|
|
280
|
-
{
|
|
281
|
-
public int CustomerId { get; set; }
|
|
282
|
-
public string CompanyName { get; set; } = "";
|
|
283
|
-
public string ContactName { get; set; } = "";
|
|
284
|
-
public List<Order> Orders { get; set; } = new();
|
|
285
|
-
}
|
|
286
|
-
|
|
287
|
-
public class Order
|
|
288
|
-
{
|
|
289
|
-
public int OrderId { get; set; }
|
|
290
|
-
public DateTime OrderDate { get; set; }
|
|
291
|
-
public string ShipCountry { get; set; } = "";
|
|
292
|
-
public List<OrderDetail> OrderDetails { get; set; } = new();
|
|
293
|
-
}
|
|
294
|
-
|
|
295
|
-
public class OrderDetail
|
|
296
|
-
{
|
|
297
|
-
public int DetailId { get; set; }
|
|
298
|
-
public string ProductName { get; set; } = "";
|
|
299
|
-
public int Quantity { get; set; }
|
|
300
|
-
public decimal UnitPrice { get; set; }
|
|
301
|
-
}
|
|
302
|
-
}
|
|
303
|
-
```
|
|
304
|
-
|
|
305
|
-
### How `IgbRowIsland` works
|
|
306
|
-
|
|
307
|
-
- The `ChildDataKey` property matches the collection property name on the parent data object (e.g., `ChildDataKey="Orders"` matches `Customer.Orders`).
|
|
308
|
-
- Each `IgbRowIsland` is a **template** - it defines columns and features for all child grids at that level.
|
|
309
|
-
- Row islands can be nested to any depth.
|
|
310
|
-
- Each child grid instance is independent - it has its own sorting, filtering, selection, and paging state.
|
|
311
|
-
|
|
312
|
-
### Independent feature configuration per level
|
|
313
|
-
|
|
314
|
-
```razor
|
|
315
|
-
<IgbHierarchicalGrid Data="customers" PrimaryKey="CustomerId"
|
|
316
|
-
RowSelection="GridSelectionMode.Multiple"
|
|
317
|
-
AllowFiltering="true">
|
|
318
|
-
<IgbColumn Field="CompanyName" Sortable="true" Filterable="true" />
|
|
319
|
-
|
|
320
|
-
<IgbRowIsland ChildDataKey="Orders" PrimaryKey="OrderId"
|
|
321
|
-
RowSelection="GridSelectionMode.Single"
|
|
322
|
-
AllowFiltering="true"
|
|
323
|
-
FilterMode="FilterMode.ExcelStyleFilter">
|
|
324
|
-
<IgbColumn Field="OrderDate" Sortable="true" Filterable="true" />
|
|
325
|
-
<IgbColumn Field="Total" HasSummary="true" />
|
|
326
|
-
</IgbRowIsland>
|
|
327
|
-
</IgbHierarchicalGrid>
|
|
328
|
-
```
|
|
329
|
-
|
|
330
|
-
### Accessing child grid instances
|
|
331
|
-
|
|
332
|
-
When a user expands a row, a child grid instance is created. Access it via the `GridCreated` event:
|
|
333
|
-
|
|
334
|
-
```razor
|
|
335
|
-
<IgbHierarchicalGrid Data="customers" PrimaryKey="CustomerId">
|
|
336
|
-
<IgbColumn Field="CompanyName" />
|
|
337
|
-
<IgbRowIsland ChildDataKey="Orders" PrimaryKey="OrderId"
|
|
338
|
-
GridCreated="OnChildGridCreated">
|
|
339
|
-
<IgbColumn Field="OrderId" />
|
|
340
|
-
<IgbColumn Field="Total" />
|
|
341
|
-
</IgbRowIsland>
|
|
342
|
-
</IgbHierarchicalGrid>
|
|
343
|
-
|
|
344
126
|
@code {
|
|
345
127
|
private void OnChildGridCreated(IgbGridCreatedEventArgs args)
|
|
346
128
|
{
|
|
347
|
-
var childGrid = args.Detail.Grid;
|
|
348
|
-
var rowIsland = args.Detail.Owner;
|
|
129
|
+
var childGrid = args.Detail.Grid; // the created child grid instance
|
|
130
|
+
var rowIsland = args.Detail.Owner; // the IgbRowIsland template
|
|
349
131
|
}
|
|
350
132
|
}
|
|
351
133
|
```
|
|
352
134
|
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
| `PrimaryKey` | `string` | Unique identifier for each level |
|
|
359
|
-
| `AutoGenerate` | `bool` | Auto-generate columns for each level |
|
|
360
|
-
|
|
361
|
-
### IgbRowIsland key parameters
|
|
362
|
-
|
|
363
|
-
| Parameter | Type | Description |
|
|
364
|
-
|---|---|---|
|
|
365
|
-
| `ChildDataKey` | `string` | Property name of the child collection on the parent object |
|
|
366
|
-
| `PrimaryKey` | `string` | Unique identifier for this level |
|
|
367
|
-
| `AutoGenerate` | `bool` | Auto-generate columns |
|
|
368
|
-
| `GridCreated` | `EventCallback<IgbGridCreatedEventArgs>` | Fires when a child grid is created on expand |
|
|
369
|
-
| `GridInitialized` | `EventCallback<IgbGridCreatedEventArgs>` | Fires when a child grid is initialized |
|
|
370
|
-
|
|
371
|
-
All standard grid features (sorting, filtering, editing, selection, toolbar) are available on `IgbRowIsland` - they apply to every child grid instance created from that template.
|
|
372
|
-
|
|
373
|
-
---
|
|
135
|
+
- `IgbRowIsland.ChildDataKey` must match the parent class's collection property name **exactly**, case included.
|
|
136
|
+
- A row island is a **template**: it configures every child grid created at that level. Islands nest to any depth.
|
|
137
|
+
- Each child grid instance keeps its own sorting, filtering, selection, and paging state, and none of it is affected by the root grid's state.
|
|
138
|
+
- Child grids do not exist until their row is expanded — reach them through `GridCreated` / `GridInitialized`, never by assumption.
|
|
139
|
+
- All standard grid features are available on `IgbRowIsland`.
|
|
374
140
|
|
|
375
141
|
## Pivot Grid (`IgbPivotGrid`)
|
|
376
142
|
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
### Registration
|
|
380
|
-
|
|
381
|
-
```csharp
|
|
382
|
-
builder.Services.AddIgniteUIBlazor(typeof(IgbPivotGridModule));
|
|
383
|
-
```
|
|
384
|
-
|
|
385
|
-
### Basic usage
|
|
143
|
+
Pivot-table analytics. Register `IgbPivotGridModule`. **Read-only** — no cell, row, or batch editing, and no row/cell/column selection or paging. Show the source data in a separate `IgbGrid` if it must be edited.
|
|
386
144
|
|
|
387
145
|
```razor
|
|
388
|
-
<
|
|
389
|
-
|
|
146
|
+
<div style="display: flex; gap: 16px;">
|
|
147
|
+
<IgbPivotDataSelector Grid="pivotGrid" />
|
|
148
|
+
<IgbPivotGrid @ref="pivotGrid" Data="salesData" PivotConfiguration="pivotConfig"
|
|
149
|
+
Width="100%" Height="600px" />
|
|
150
|
+
</div>
|
|
390
151
|
|
|
391
152
|
@code {
|
|
392
|
-
private
|
|
153
|
+
private IgbPivotGrid pivotGrid = default!;
|
|
393
154
|
private IgbPivotConfiguration pivotConfig = default!;
|
|
394
155
|
|
|
395
156
|
protected override void OnInitialized()
|
|
396
157
|
{
|
|
397
|
-
salesData = SalesService.GetSalesData();
|
|
398
|
-
|
|
399
158
|
pivotConfig = new IgbPivotConfiguration
|
|
400
159
|
{
|
|
401
160
|
Rows = new IgbPivotDimension[]
|
|
402
161
|
{
|
|
403
|
-
new
|
|
404
|
-
new
|
|
162
|
+
new() { MemberName = "Country", Enabled = true },
|
|
163
|
+
new() { MemberName = "City", Enabled = true }
|
|
405
164
|
},
|
|
406
165
|
Columns = new IgbPivotDimension[]
|
|
407
166
|
{
|
|
408
|
-
new
|
|
167
|
+
new() { MemberName = "Year", Enabled = true }
|
|
409
168
|
},
|
|
410
169
|
Values = new IgbPivotValue[]
|
|
411
170
|
{
|
|
412
|
-
new
|
|
171
|
+
new()
|
|
413
172
|
{
|
|
414
173
|
Member = "Revenue",
|
|
415
|
-
Aggregate = new IgbPivotAggregator
|
|
174
|
+
Aggregate = new IgbPivotAggregator
|
|
175
|
+
{
|
|
176
|
+
AggregatorName = PivotAggregationType.SUM,
|
|
177
|
+
Key = "SUM",
|
|
178
|
+
Label = "Sum of Revenue"
|
|
179
|
+
},
|
|
416
180
|
Enabled = true
|
|
417
181
|
}
|
|
418
182
|
},
|
|
419
183
|
Filters = new IgbPivotDimension[]
|
|
420
184
|
{
|
|
421
|
-
new
|
|
185
|
+
new() { MemberName = "ProductCategory", Enabled = true }
|
|
422
186
|
}
|
|
423
187
|
};
|
|
424
188
|
}
|
|
425
|
-
|
|
426
|
-
public class SalesRecord
|
|
427
|
-
{
|
|
428
|
-
public string Country { get; set; } = "";
|
|
429
|
-
public string City { get; set; } = "";
|
|
430
|
-
public int Year { get; set; }
|
|
431
|
-
public string ProductCategory { get; set; } = "";
|
|
432
|
-
public decimal Revenue { get; set; }
|
|
433
|
-
public int UnitsSold { get; set; }
|
|
434
|
-
}
|
|
435
189
|
}
|
|
436
190
|
```
|
|
437
191
|
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
| `Rows` | `IgbPivotDimension[]` | Dimensions placed on rows |
|
|
443
|
-
| `Columns` | `IgbPivotDimension[]` | Dimensions placed on columns |
|
|
444
|
-
| `Values` | `IgbPivotValue[]` | Measures/aggregations |
|
|
445
|
-
| `Filters` | `IgbPivotDimension[]` | Dimensions used as filters (shown in filter chip area) |
|
|
446
|
-
|
|
447
|
-
### IgbPivotDimension
|
|
448
|
-
|
|
449
|
-
| Property | Type | Description |
|
|
450
|
-
|---|---|---|
|
|
451
|
-
| `MemberName` | `string` | Data property name |
|
|
452
|
-
| `Enabled` | `bool` | Whether this dimension is active |
|
|
453
|
-
| `DisplayName` | `string` | Custom display label |
|
|
454
|
-
| `ChildLevel` | `IgbPivotDimension` | Nested hierarchy dimension |
|
|
455
|
-
| `SortDirection` | `SortingDirection` | Sort direction for this dimension |
|
|
456
|
-
|
|
457
|
-
### IgbPivotValue
|
|
458
|
-
|
|
459
|
-
| Property | Type | Description |
|
|
460
|
-
|---|---|---|
|
|
461
|
-
| `Member` | `string` | Data property to aggregate |
|
|
462
|
-
| `Aggregate` | `IgbPivotAggregator` | Aggregation function |
|
|
463
|
-
| `Enabled` | `bool` | Whether this value is active |
|
|
464
|
-
| `DisplayName` | `string` | Custom display label |
|
|
465
|
-
| `FormatterScript` | `string` | JS interop formatter function name (register via `igRegisterScript`) |
|
|
466
|
-
|
|
467
|
-
### Built-in aggregation types
|
|
468
|
-
|
|
469
|
-
| `PivotAggregationType` | Description |
|
|
470
|
-
|---|---|
|
|
471
|
-
| `SUM` | Sum of values |
|
|
472
|
-
| `COUNT` | Count of records |
|
|
473
|
-
| `MIN` | Minimum value |
|
|
474
|
-
| `MAX` | Maximum value |
|
|
475
|
-
| `AVG` | Average value |
|
|
476
|
-
| `EARLIEST` | Earliest date/time value |
|
|
477
|
-
| `LATEST` | Latest date/time value |
|
|
478
|
-
|
|
479
|
-
### Pivot Data Selector
|
|
480
|
-
|
|
481
|
-
Add a panel that lets users drag dimensions and values interactively:
|
|
482
|
-
|
|
483
|
-
```razor
|
|
484
|
-
<div style="display: flex; gap: 16px;">
|
|
485
|
-
<IgbPivotDataSelector @ref="selector" Grid="pivotGrid" />
|
|
486
|
-
<IgbPivotGrid @ref="pivotGrid" Data="salesData" PivotConfiguration="pivotConfig"
|
|
487
|
-
Width="100%" Height="600px" />
|
|
488
|
-
</div>
|
|
489
|
-
|
|
490
|
-
@code {
|
|
491
|
-
private IgbPivotGrid pivotGrid = default!;
|
|
492
|
-
private IgbPivotDataSelector selector = default!;
|
|
493
|
-
}
|
|
494
|
-
```
|
|
495
|
-
|
|
496
|
-
### Pivot Grid is read-only
|
|
497
|
-
|
|
498
|
-
The Pivot Grid does not support cell editing, row editing, or batch editing. It is a read-only analytical view. If users need to edit the source data, display it in a separate `IgbGrid`.
|
|
499
|
-
|
|
500
|
-
---
|
|
501
|
-
|
|
502
|
-
## Key Rules by Grid Type
|
|
503
|
-
|
|
504
|
-
### Tree Grid rules
|
|
505
|
-
|
|
506
|
-
1. Use **either** `ForeignKey` (flat data) **or** `ChildDataKey` (nested data), never both.
|
|
507
|
-
2. `PrimaryKey` is required.
|
|
508
|
-
3. Root rows have `null`/`0`/default in the foreign key field, or are the top-level objects in a nested collection.
|
|
509
|
-
4. `MultipleCascade` selection cascades to all descendants.
|
|
510
|
-
5. Load-on-demand requires `HasChildrenKey` and a JS interop handler via `LoadChildrenOnDemandScript`.
|
|
511
|
-
|
|
512
|
-
### Hierarchical Grid rules
|
|
513
|
-
|
|
514
|
-
1. `IgbRowIsland.ChildDataKey` must exactly match the collection property name on the parent data class (case-sensitive).
|
|
515
|
-
2. Each level is independent - it has its own columns, sorting, filtering, and editing state.
|
|
516
|
-
3. Access child grid instances via `GridCreated`, never assume a child grid exists before expansion.
|
|
517
|
-
4. Nesting depth is unlimited - nest `IgbRowIsland` within `IgbRowIsland`.
|
|
518
|
-
|
|
519
|
-
### Pivot Grid rules
|
|
192
|
+
`IgbPivotConfiguration` holds `Rows`, `Columns`, `Values`, `Filters`.
|
|
193
|
+
`IgbPivotDimension`: `MemberName`, `Enabled`, `DisplayName`, `ChildLevel` (nested hierarchy), `SortDirection`.
|
|
194
|
+
`IgbPivotValue`: `Member`, `Aggregate`, `Enabled`, `DisplayName`, `FormatterScript` (a JS function registered via `igRegisterScript`).
|
|
195
|
+
`PivotAggregationType`: `SUM`, `COUNT`, `MIN`, `MAX`, `AVG`, `EARLIEST`, `LATEST`.
|
|
520
196
|
|
|
521
|
-
|
|
522
|
-
2. Configure dimensions and values via `IgbPivotConfiguration` in C#.
|
|
523
|
-
3. Sorting/filtering in the pivot is dimension-based, not column-based.
|
|
524
|
-
4. Use `IgbPivotDataSelector` for an interactive drag-and-drop UI.
|
|
525
|
-
5. Row selection, cell selection, and column selection are not supported.
|
|
197
|
+
Sorting and filtering are dimension-based and configured through `IgbPivotConfiguration` — not through `SortAsync` / `FilterAsync`. `IgbPivotDataSelector` adds the drag-and-drop panel for reshaping at runtime.
|