igniteui-cli 15.5.0 → 15.6.0
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 +86 -0
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-lite-testing/references/interop-contracts.md +220 -0
- 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/projects/_base/files/src/main.tsx +1 -0
- package/templates/react/igr-ts/projects/_base_with_home/files/src/app/home/style.module.css +3 -3
- 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/react/igr-ts/projects/side-nav/files/src/app/app.css +9 -9
- package/templates/react/igr-ts/projects/side-nav/files/src/app/home/style.module.css +7 -7
- package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/app.css +8 -8
- package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/components/Login.module.css +1 -69
- package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/components/Login.tsx +5 -5
- package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/components/LoginBar.module.css +5 -26
- package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/components/LoginDialog.module.css +0 -1
- package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/components/Register.module.css +1 -56
- package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/components/Register.tsx +2 -2
- package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/pages/Profile.module.css +11 -11
- package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/pages/RedirectFacebook.tsx +1 -1
- package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/pages/RedirectGoogle.tsx +1 -1
- package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/pages/RedirectMicrosoft.tsx +1 -1
- package/templates/react/igr-ts/projects/side-nav-mini/files/src/app/app.css +9 -9
- package/templates/react/igr-ts/projects/side-nav-mini/files/src/app/home/style.module.css +7 -7
- package/templates/react/igr-ts/projects/side-nav-mini-auth/files/src/app/app.css +7 -7
- package/templates/webcomponents/igc-ts/constants.d.ts +5 -5
- package/templates/webcomponents/igc-ts/constants.js +5 -5
- 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/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
|
@@ -1,144 +1,74 @@
|
|
|
1
|
-
# Data Display Components
|
|
1
|
+
# Data Display & Action Components
|
|
2
2
|
|
|
3
|
-
>
|
|
4
|
-
> For project setup and module registration - see [`setup.md`](./setup.md).
|
|
5
|
-
|
|
6
|
-
## Contents
|
|
7
|
-
|
|
8
|
-
- [Button & Button Group](#button--button-group)
|
|
9
|
-
- [Icon & Icon Button](#icon--icon-button)
|
|
10
|
-
- [Card](#card)
|
|
11
|
-
- [Carousel](#carousel)
|
|
12
|
-
- [List](#list)
|
|
13
|
-
- [Avatar](#avatar)
|
|
14
|
-
- [Badge](#badge)
|
|
15
|
-
- [Chip](#chip)
|
|
16
|
-
- [Circular Progress](#circular-progress)
|
|
17
|
-
- [Linear Progress](#linear-progress)
|
|
18
|
-
- [Dropdown](#dropdown)
|
|
19
|
-
- [Tooltip](#tooltip)
|
|
20
|
-
- [Ripple](#ripple)
|
|
21
|
-
- [Key Rules](#key-rules)
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
## Overview
|
|
26
|
-
This reference gives high-level guidance on data display and action components, their key features, and common API members. For detailed documentation, call `get_doc` from `igniteui-cli`; use `search_api` and `get_api_reference` for Blazor API details.
|
|
3
|
+
Module for every component below is `Igb<Name>Module`. `IgbButton` and `IgbIconButton` are separate modules; `IgbList`, `IgbListItem` and `IgbListHeader` each have their own; card sub-parts each have their own.
|
|
27
4
|
|
|
28
5
|
## Button & Button Group
|
|
29
6
|
|
|
30
|
-
```csharp
|
|
31
|
-
builder.Services.AddIgniteUIBlazor(typeof(IgbButtonModule), typeof(IgbButtonGroupModule));
|
|
32
|
-
```
|
|
33
|
-
|
|
34
7
|
```razor
|
|
35
|
-
|
|
36
|
-
<IgbButton Variant="
|
|
37
|
-
<IgbButton Variant="
|
|
38
|
-
<IgbButton Variant="@ButtonVariant.Flat">Flat</IgbButton>
|
|
8
|
+
<IgbButton Variant="ButtonVariant.Contained" @onclick="Save">Save</IgbButton>
|
|
9
|
+
<IgbButton Variant="ButtonVariant.Outlined" Disabled="true">Cancel</IgbButton>
|
|
10
|
+
<IgbButton Variant="ButtonVariant.Flat" Href="/docs" Target="ButtonBaseTarget.Blank">Docs</IgbButton>
|
|
39
11
|
|
|
40
|
-
|
|
41
|
-
<IgbButtonGroup Selection="@ButtonGroupSelection.Single">
|
|
12
|
+
<IgbButtonGroup Selection="ButtonGroupSelection.Single" Alignment="ContentOrientation.Horizontal">
|
|
42
13
|
<IgbToggleButton Value="left">Left</IgbToggleButton>
|
|
43
14
|
<IgbToggleButton Value="center" Selected="true">Center</IgbToggleButton>
|
|
44
15
|
<IgbToggleButton Value="right">Right</IgbToggleButton>
|
|
45
16
|
</IgbButtonGroup>
|
|
46
17
|
```
|
|
47
18
|
|
|
48
|
-
|
|
19
|
+
`ButtonVariant`: `Contained | Outlined | Flat | Fab`. Setting `Href` renders an anchor and enables `Target`, `Rel`, `Download`. Click handling uses Blazor's `@onclick`. `IgbButtonGroup` raises `Select` / `Deselect` (`IgbComponentValueChangedEventArgs`).
|
|
49
20
|
|
|
50
21
|
## Icon & Icon Button
|
|
51
22
|
|
|
52
|
-
```csharp
|
|
53
|
-
builder.Services.AddIgniteUIBlazor(typeof(IgbIconModule), typeof(IgbIconButtonModule));
|
|
54
|
-
```
|
|
55
|
-
|
|
56
23
|
```razor
|
|
57
24
|
<IgbIcon @ref="MyIcon" IconName="home" Collection="material" />
|
|
58
|
-
<IgbIconButton
|
|
25
|
+
<IgbIconButton IconName="menu" Collection="material" Variant="IconButtonVariant.Flat" Mirrored="false" />
|
|
59
26
|
|
|
60
27
|
@code {
|
|
61
|
-
IgbIcon MyIcon { get; set; }
|
|
62
|
-
IgbIconButton MenuBtn { get; set; }
|
|
28
|
+
IgbIcon MyIcon { get; set; } = default!;
|
|
63
29
|
|
|
64
30
|
protected override async Task OnAfterRenderAsync(bool firstRender)
|
|
65
31
|
{
|
|
66
|
-
if (firstRender && MyIcon
|
|
32
|
+
if (firstRender && MyIcon is not null)
|
|
67
33
|
{
|
|
68
34
|
await MyIcon.EnsureReady();
|
|
69
|
-
|
|
70
|
-
await MyIcon.
|
|
35
|
+
await MyIcon.RegisterIconFromTextAsync("home", "<svg>...</svg>", "material");
|
|
36
|
+
// or: await MyIcon.RegisterIconAsync("home", "/icons/home.svg", "material");
|
|
71
37
|
}
|
|
72
38
|
}
|
|
73
39
|
}
|
|
74
40
|
```
|
|
75
41
|
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
---
|
|
42
|
+
The parameter is **`IconName`**, not `Name` (`Name` is the framework element identity on every component). Icons are keyed by name + collection and must be registered before they render — always in `OnAfterRenderAsync(firstRender)` after `await EnsureReady()`. Reuse one collection name across the app.
|
|
79
43
|
|
|
80
44
|
## Card
|
|
81
45
|
|
|
82
|
-
```csharp
|
|
83
|
-
builder.Services.AddIgniteUIBlazor(typeof(IgbCardModule));
|
|
84
|
-
```
|
|
85
|
-
|
|
86
46
|
```razor
|
|
87
47
|
<IgbCard style="width: 350px;">
|
|
88
|
-
<IgbCardMedia>
|
|
89
|
-
<img src="photo.jpg" alt="Card image" />
|
|
90
|
-
</IgbCardMedia>
|
|
48
|
+
<IgbCardMedia><img src="photo.jpg" alt="Card image" /></IgbCardMedia>
|
|
91
49
|
<IgbCardHeader>
|
|
92
50
|
<h3 slot="title">Jane Doe</h3>
|
|
93
51
|
<span slot="subtitle">Photographer</span>
|
|
94
52
|
</IgbCardHeader>
|
|
95
|
-
<IgbCardContent>
|
|
96
|
-
<p>A short description of Jane Doe.</p>
|
|
97
|
-
</IgbCardContent>
|
|
53
|
+
<IgbCardContent><p>A short description.</p></IgbCardContent>
|
|
98
54
|
<IgbCardActions>
|
|
99
|
-
<IgbButton slot="start" Variant="
|
|
100
|
-
<IgbButton slot="
|
|
101
|
-
<IgbButton slot="end" Variant="@ButtonVariant.Contained">Buy Now</IgbButton>
|
|
55
|
+
<IgbButton slot="start" Variant="ButtonVariant.Flat">Like</IgbButton>
|
|
56
|
+
<IgbButton slot="end" Variant="ButtonVariant.Contained">Buy Now</IgbButton>
|
|
102
57
|
</IgbCardActions>
|
|
103
58
|
</IgbCard>
|
|
104
59
|
```
|
|
105
60
|
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
## Carousel
|
|
109
|
-
|
|
110
|
-
```csharp
|
|
111
|
-
builder.Services.AddIgniteUIBlazor(typeof(IgbCarouselModule));
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
```razor
|
|
115
|
-
<IgbCarousel>
|
|
116
|
-
<IgbCarouselSlide Active="true">
|
|
117
|
-
<img src="slide-1.jpg" alt="Slide 1" />
|
|
118
|
-
</IgbCarouselSlide>
|
|
119
|
-
<IgbCarouselSlide>
|
|
120
|
-
<img src="slide-2.jpg" alt="Slide 2" />
|
|
121
|
-
</IgbCarouselSlide>
|
|
122
|
-
</IgbCarousel>
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
Use Carousel for image/content slides, banners, onboarding panels, or media galleries. Check the `carousel` MCP doc for current slide APIs, navigation controls, indicators, autoplay, animation, and CSS parts.
|
|
126
|
-
|
|
127
|
-
---
|
|
61
|
+
`IgbCard` has no default width — always give it one.
|
|
128
62
|
|
|
129
63
|
## List
|
|
130
64
|
|
|
131
|
-
```csharp
|
|
132
|
-
builder.Services.AddIgniteUIBlazor(typeof(IgbListModule), typeof(IgbListItemModule), typeof(IgbListHeaderModule));
|
|
133
|
-
```
|
|
134
|
-
|
|
135
65
|
```razor
|
|
136
66
|
<IgbList>
|
|
137
67
|
<IgbListHeader>Contacts</IgbListHeader>
|
|
138
68
|
@foreach (var contact in Contacts)
|
|
139
69
|
{
|
|
140
70
|
<IgbListItem>
|
|
141
|
-
<IgbAvatar slot="start" Shape="
|
|
71
|
+
<IgbAvatar slot="start" Shape="AvatarShape.Circle" Initials="@contact.Initials" />
|
|
142
72
|
<span slot="title">@contact.Name</span>
|
|
143
73
|
<span slot="subtitle">@contact.Phone</span>
|
|
144
74
|
<IgbIconButton slot="end" IconName="delete" Collection="material" />
|
|
@@ -147,151 +77,88 @@ builder.Services.AddIgniteUIBlazor(typeof(IgbListModule), typeof(IgbListItemModu
|
|
|
147
77
|
</IgbList>
|
|
148
78
|
```
|
|
149
79
|
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
## Avatar
|
|
153
|
-
|
|
154
|
-
```csharp
|
|
155
|
-
builder.Services.AddIgniteUIBlazor(typeof(IgbAvatarModule));
|
|
156
|
-
```
|
|
157
|
-
|
|
158
|
-
```razor
|
|
159
|
-
<!-- Image avatar -->
|
|
160
|
-
<IgbAvatar Src="avatar.png" Alt="User photo" Shape="@AvatarShape.Circle" />
|
|
161
|
-
|
|
162
|
-
<!-- Initials avatar -->
|
|
163
|
-
<IgbAvatar Shape="@AvatarShape.Circle">AB</IgbAvatar>
|
|
164
|
-
|
|
165
|
-
<!-- Icon avatar -->
|
|
166
|
-
<IgbAvatar Shape="@AvatarShape.Square">
|
|
167
|
-
<IgbIcon IconName="person" Collection="material" />
|
|
168
|
-
</IgbAvatar>
|
|
169
|
-
```
|
|
170
|
-
|
|
171
|
-
---
|
|
80
|
+
`IgbListItem` slots: `start`, `title`, `subtitle`, `end`.
|
|
172
81
|
|
|
173
|
-
## Badge
|
|
174
|
-
|
|
175
|
-
```csharp
|
|
176
|
-
builder.Services.AddIgniteUIBlazor(typeof(IgbBadgeModule));
|
|
177
|
-
```
|
|
82
|
+
## Avatar, Badge, Chip
|
|
178
83
|
|
|
179
84
|
```razor
|
|
180
|
-
<
|
|
181
|
-
<
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
---
|
|
85
|
+
<IgbAvatar Src="avatar.png" Alt="User photo" Shape="AvatarShape.Circle" />
|
|
86
|
+
<IgbAvatar Shape="AvatarShape.Circle" Initials="AB" />
|
|
87
|
+
<IgbAvatar Shape="AvatarShape.Square"><IgbIcon IconName="person" Collection="material" /></IgbAvatar>
|
|
185
88
|
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
```csharp
|
|
189
|
-
builder.Services.AddIgniteUIBlazor(typeof(IgbChipModule));
|
|
190
|
-
```
|
|
89
|
+
<IgbBadge Variant="StyleVariant.Primary">5</IgbBadge>
|
|
90
|
+
<IgbBadge Variant="StyleVariant.Danger" Shape="BadgeShape.Square" Dot="true" />
|
|
191
91
|
|
|
192
|
-
|
|
193
|
-
<IgbChip Selectable="true" Removable="true" Remove="OnChipRemoved">
|
|
92
|
+
<IgbChip Selectable="true" Removable="true" Variant="StyleVariant.Info" Remove="OnChipRemoved">
|
|
194
93
|
<IgbIcon slot="start" IconName="star" Collection="material" />
|
|
195
94
|
Blazor
|
|
196
95
|
</IgbChip>
|
|
197
96
|
|
|
198
97
|
@code {
|
|
199
|
-
void OnChipRemoved(IgbComponentBoolValueChangedEventArgs e) {
|
|
98
|
+
void OnChipRemoved(IgbComponentBoolValueChangedEventArgs e) { }
|
|
200
99
|
}
|
|
201
100
|
```
|
|
202
101
|
|
|
203
|
-
|
|
102
|
+
`AvatarShape`: `Circle | Rounded | Square` — use `Shape`, there is no `RoundShape`. `StyleVariant` (shared by badge and chip): `Primary | Info | Success | Warning | Danger`. `IgbChip` also has `Selected` / `SelectedChanged` and a `Select` event.
|
|
204
103
|
|
|
205
|
-
##
|
|
104
|
+
## Progress
|
|
206
105
|
|
|
207
|
-
|
|
208
|
-
builder.Services.AddIgniteUIBlazor(typeof(IgbCircularProgressModule));
|
|
209
|
-
```
|
|
106
|
+
`IgbCircularProgress` and `IgbLinearProgress` share `Value`, `Max`, `Variant` (`StyleVariant`), `Indeterminate`, `HideLabel`, `LabelFormat`, `AnimationDuration`.
|
|
210
107
|
|
|
211
108
|
```razor
|
|
212
|
-
|
|
213
|
-
<IgbCircularProgress Value="65" Max="100">
|
|
214
|
-
<span slot="default">65%</span>
|
|
215
|
-
</IgbCircularProgress>
|
|
216
|
-
|
|
217
|
-
<!-- Indeterminate (spinner) -->
|
|
109
|
+
<IgbCircularProgress Value="65" Max="100"><span slot="default">65%</span></IgbCircularProgress>
|
|
218
110
|
<IgbCircularProgress Indeterminate="true" />
|
|
111
|
+
<IgbLinearProgress Value="42" Max="100" Striped="true" LabelAlign="LinearProgressLabelAlign.End" />
|
|
219
112
|
```
|
|
220
113
|
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
## Linear Progress
|
|
224
|
-
|
|
225
|
-
```csharp
|
|
226
|
-
builder.Services.AddIgniteUIBlazor(typeof(IgbLinearProgressModule));
|
|
227
|
-
```
|
|
228
|
-
|
|
229
|
-
```razor
|
|
230
|
-
<IgbLinearProgress Value="42" Max="100" Striped="true" />
|
|
231
|
-
<IgbLinearProgress Indeterminate="true" />
|
|
232
|
-
```
|
|
233
|
-
|
|
234
|
-
---
|
|
114
|
+
Use these for progress, not for data visualization — a static colored ring with a centered value is a donut chart.
|
|
235
115
|
|
|
236
116
|
## Dropdown
|
|
237
117
|
|
|
238
|
-
```csharp
|
|
239
|
-
builder.Services.AddIgniteUIBlazor(typeof(IgbDropdownModule));
|
|
240
|
-
```
|
|
241
|
-
|
|
242
118
|
```razor
|
|
243
|
-
<
|
|
244
|
-
<
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
</IgbDropdown>
|
|
251
|
-
</div>
|
|
252
|
-
|
|
119
|
+
<IgbDropdown Placement="PopoverPlacement.BottomStart" SameWidth="false">
|
|
120
|
+
<IgbButton slot="target">Options</IgbButton>
|
|
121
|
+
<IgbDropdownHeader>Actions</IgbDropdownHeader>
|
|
122
|
+
<IgbDropdownItem Value="edit">Edit</IgbDropdownItem>
|
|
123
|
+
<IgbDropdownItem Value="delete">Delete</IgbDropdownItem>
|
|
124
|
+
<IgbDropdownItem Value="archive" Disabled="true">Archive</IgbDropdownItem>
|
|
125
|
+
</IgbDropdown>
|
|
253
126
|
```
|
|
254
127
|
|
|
255
|
-
|
|
128
|
+
The trigger goes in `slot="target"`. `IgbDropdownGroup` groups items; `Placement`, `Flip`, `Distance`, `ScrollStrategy`, `SameWidth` control positioning; `ShowAsync()` / `HideAsync()` / `ToggleAsync()` drive it from code. For a form field that selects a value, use `IgbSelect` instead.
|
|
256
129
|
|
|
257
130
|
## Tooltip
|
|
258
131
|
|
|
259
|
-
```csharp
|
|
260
|
-
builder.Services.AddIgniteUIBlazor(typeof(IgbTooltipModule));
|
|
261
|
-
```
|
|
262
|
-
|
|
263
132
|
```razor
|
|
264
133
|
<IgbButton id="hover-button">Hover me</IgbButton>
|
|
265
|
-
<IgbTooltip Anchor="hover-button" Placement="
|
|
134
|
+
<IgbTooltip Anchor="hover-button" Placement="PopoverPlacement.Top" ShowDelay="200" WithArrow="true">
|
|
266
135
|
This is a tooltip
|
|
267
136
|
</IgbTooltip>
|
|
268
137
|
```
|
|
269
138
|
|
|
270
|
-
|
|
139
|
+
`Anchor` is the **id string** of the target element. `Message` sets plain text without child content; `ShowTriggers` / `HideTriggers` override the default hover/focus behavior; `Sticky` keeps it open until dismissed.
|
|
271
140
|
|
|
272
|
-
## Ripple
|
|
141
|
+
## Ripple, Highlight, Chat
|
|
273
142
|
|
|
274
|
-
```
|
|
275
|
-
|
|
276
|
-
```
|
|
143
|
+
```razor
|
|
144
|
+
<div style="position: relative; padding: 16px;">Click me<IgbRipple /></div>
|
|
277
145
|
|
|
278
|
-
|
|
146
|
+
<IgbHighlight SearchText="@query" CaseSensitive="false">@text</IgbHighlight>
|
|
279
147
|
|
|
280
|
-
|
|
281
|
-
<div style="position: relative; padding: 16px; cursor: pointer;">
|
|
282
|
-
Click me
|
|
283
|
-
<IgbRipple />
|
|
284
|
-
</div>
|
|
148
|
+
<IgbChat Options="ChatOptions" DraftMessage="Draft" MessageCreated="OnMessageCreated" />
|
|
285
149
|
```
|
|
286
150
|
|
|
287
|
-
|
|
151
|
+
- `IgbRipple` needs a `position: relative` parent; customize with the `--color` custom property.
|
|
152
|
+
- `IgbHighlight` marks occurrences of `SearchText` inside its content.
|
|
153
|
+
- `IgbChat` is a full chat surface configured through `IgbChatOptions` (messages, suggestions, renderers) with `MessageCreated`, `MessageReact`, `AttachmentClick`, `TypingChange`, `InputFocus`, `InputBlur`. Read its doc before building against it — the options object is large.
|
|
288
154
|
|
|
289
|
-
|
|
155
|
+
## Carousel
|
|
290
156
|
|
|
291
|
-
|
|
157
|
+
```razor
|
|
158
|
+
<IgbCarousel Interval="5000" DisableLoop="false" HideIndicators="false" Vertical="false">
|
|
159
|
+
<IgbCarouselSlide Active="true"><img src="slide-1.jpg" alt="Slide 1" /></IgbCarouselSlide>
|
|
160
|
+
<IgbCarouselSlide><img src="slide-2.jpg" alt="Slide 2" /></IgbCarouselSlide>
|
|
161
|
+
</IgbCarousel>
|
|
162
|
+
```
|
|
292
163
|
|
|
293
|
-
|
|
294
|
-
2. **Icons must be registered before they display.** Use `EnsureReady()` + `RegisterIconFromTextAsync()` in `OnAfterRenderAsync(bool firstRender)`.
|
|
295
|
-
3. **`IgbCard` does not set a default width.** Always set a width via inline style or CSS class.
|
|
296
|
-
4. **Prefer the Dropdown `target` slot for the trigger.** For an external trigger, follow the current `dropdown` MCP doc and call `Show()`, `Hide()`, or `Toggle()` on the dropdown reference.
|
|
297
|
-
5. **`IgbTooltip.Anchor` uses the target element ID string in the documented Blazor pattern.** Give the target an `id` and pass that same value to `Anchor`.
|
|
164
|
+
`Interval` enables autoplay, `AnimationType` picks the transition, `HideNavigation` / `HideIndicators` strip the chrome, `IndicatorsOrientation` and `MaximumIndicatorsCount` tune the indicator strip.
|
|
@@ -1,43 +1,32 @@
|
|
|
1
1
|
# Feedback & Overlay Components
|
|
2
2
|
|
|
3
|
-
>
|
|
4
|
-
> For project setup and module registration - see [`setup.md`](./setup.md).
|
|
3
|
+
Module for each is `Igb<Name>Module`. All four expose `Open`, `ShowAsync()`, `HideAsync()`, `ToggleAsync()` (each `Task<bool>`) and `Closing` / `Closed` (`IgbVoidEventArgs`). Drive them with `@ref` + the `Async` methods; the sync twins (`Show()`, `Hide()`) need `IJSInProcessRuntime` and throw on Blazor Server.
|
|
5
4
|
|
|
6
|
-
##
|
|
5
|
+
## Choosing one
|
|
7
6
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
-
|
|
13
|
-
|
|
14
|
-
---
|
|
15
|
-
|
|
16
|
-
## Overview
|
|
17
|
-
This reference gives high-level guidance on feedback and overlay components, their key features, and common API members. For detailed documentation, call `get_doc` from `igniteui-cli`; use `search_api` and `get_api_reference` for Blazor API details.
|
|
7
|
+
| Component | Modal? | Action button | Use for |
|
|
8
|
+
|---|---|---|---|
|
|
9
|
+
| `IgbDialog` | yes, blocks the page | footer buttons you supply | confirmations, forms, anything that must be answered |
|
|
10
|
+
| `IgbSnackbar` | no, floats | one, via `ActionText` + `Action` | brief message with an undo/retry affordance |
|
|
11
|
+
| `IgbToast` | no, floats | none | fire-and-forget status message |
|
|
12
|
+
| `IgbBanner` | no, inline — pushes content down | any, via `slot="actions"` | persistent low-urgency notice (offline, consent) |
|
|
18
13
|
|
|
19
14
|
## Dialog
|
|
20
15
|
|
|
21
|
-
```csharp
|
|
22
|
-
builder.Services.AddIgniteUIBlazor(typeof(IgbDialogModule));
|
|
23
|
-
```
|
|
24
|
-
|
|
25
16
|
```razor
|
|
26
|
-
<IgbButton @onclick="OpenDialog">
|
|
27
|
-
|
|
28
|
-
<IgbDialog @ref="ConfirmDialog"
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
<
|
|
33
|
-
<IgbButton slot="footer" Variant="@ButtonVariant.Flat" @onclick="CloseDialog">Cancel</IgbButton>
|
|
34
|
-
<IgbButton slot="footer" Variant="@ButtonVariant.Contained" @onclick="ConfirmDelete">Delete</IgbButton>
|
|
17
|
+
<IgbButton @onclick="OpenDialog">Delete</IgbButton>
|
|
18
|
+
|
|
19
|
+
<IgbDialog @ref="ConfirmDialog" Title="Delete Item"
|
|
20
|
+
KeepOpenOnEscape="false" CloseOnOutsideClick="false" HideDefaultAction="true">
|
|
21
|
+
<p>Are you sure? This action cannot be undone.</p>
|
|
22
|
+
<IgbButton slot="footer" Variant="ButtonVariant.Flat" @onclick="CloseDialog">Cancel</IgbButton>
|
|
23
|
+
<IgbButton slot="footer" Variant="ButtonVariant.Contained" @onclick="ConfirmDelete">Delete</IgbButton>
|
|
35
24
|
</IgbDialog>
|
|
36
25
|
|
|
37
26
|
@code {
|
|
38
|
-
|
|
27
|
+
IgbDialog ConfirmDialog { get; set; } = default!;
|
|
39
28
|
|
|
40
|
-
Task OpenDialog()
|
|
29
|
+
Task OpenDialog() => ConfirmDialog.ShowAsync();
|
|
41
30
|
Task CloseDialog() => ConfirmDialog.HideAsync();
|
|
42
31
|
|
|
43
32
|
async Task ConfirmDelete()
|
|
@@ -48,93 +37,48 @@ builder.Services.AddIgniteUIBlazor(typeof(IgbDialogModule));
|
|
|
48
37
|
}
|
|
49
38
|
```
|
|
50
39
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
40
|
+
- Footer buttons need `slot="footer"`; without it they render in the body.
|
|
41
|
+
- `KeepOpenOnEscape` defaults to `false` — Escape closes the dialog. Set it to `true` to force an explicit choice.
|
|
42
|
+
- `CloseOnOutsideClick` defaults to `false`; set it to `true` for light dismiss.
|
|
43
|
+
- `HideDefaultAction` removes the built-in OK button when you supply your own footer.
|
|
44
|
+
- `Title` sets the header; `ReturnValue` carries a result back after close.
|
|
54
45
|
|
|
55
|
-
|
|
56
|
-
builder.Services.AddIgniteUIBlazor(typeof(IgbSnackbarModule));
|
|
57
|
-
```
|
|
46
|
+
## Snackbar & Toast
|
|
58
47
|
|
|
59
48
|
```razor
|
|
60
|
-
<
|
|
61
|
-
|
|
62
|
-
<IgbSnackbar @ref="Snack"
|
|
63
|
-
DisplayTime="3000"
|
|
64
|
-
ActionText="Undo"
|
|
65
|
-
Action="OnUndo">
|
|
49
|
+
<IgbSnackbar @ref="Snack" DisplayTime="3000" ActionText="Undo" Action="OnUndo"
|
|
50
|
+
Position="AbsolutePosition.Bottom">
|
|
66
51
|
Changes saved successfully.
|
|
67
52
|
</IgbSnackbar>
|
|
68
53
|
|
|
69
|
-
@
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
async Task ShowMessage()
|
|
73
|
-
{
|
|
74
|
-
await Snack.ShowAsync();
|
|
75
|
-
// or use JS interop shortcut: id="snackbar" + onclick="snackbar.show()"
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
void OnUndo(IgbVoidEventArgs e) { /* undo logic */ }
|
|
79
|
-
}
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
> **TIP - JS interop shortcut:** Add `id="snackbar"` to `IgbSnackbar` and `onclick="snackbar.show()"` to the trigger button as a lightweight alternative when you don't need C# event handling.
|
|
83
|
-
|
|
84
|
-
---
|
|
85
|
-
|
|
86
|
-
## Toast
|
|
87
|
-
|
|
88
|
-
```csharp
|
|
89
|
-
builder.Services.AddIgniteUIBlazor(typeof(IgbToastModule));
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
```razor
|
|
93
|
-
<IgbButton @onclick="ShowToast">Show Toast</IgbButton>
|
|
94
|
-
|
|
95
|
-
<IgbToast @ref="ToastRef" DisplayTime="4000">
|
|
96
|
-
Operation completed successfully.
|
|
54
|
+
<IgbToast @ref="ToastRef" DisplayTime="4000" Position="AbsolutePosition.Top">
|
|
55
|
+
Operation completed.
|
|
97
56
|
</IgbToast>
|
|
98
57
|
|
|
99
58
|
@code {
|
|
100
|
-
|
|
101
|
-
|
|
59
|
+
IgbSnackbar Snack { get; set; } = default!;
|
|
60
|
+
IgbToast ToastRef { get; set; } = default!;
|
|
61
|
+
|
|
62
|
+
Task ShowMessage() => Snack.ShowAsync();
|
|
63
|
+
void OnUndo(IgbVoidEventArgs e) { /* undo logic */ }
|
|
102
64
|
}
|
|
103
65
|
```
|
|
104
66
|
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
---
|
|
67
|
+
Both inherit `DisplayTime` (ms), `KeepOpen`, `Position` (`AbsolutePosition`), and `Positioning`. `DisplayTime="0"` or `KeepOpen="true"` keeps the notification up until `HideAsync()`. Only `IgbSnackbar` has `ActionText` / `Action`.
|
|
108
68
|
|
|
109
69
|
## Banner
|
|
110
70
|
|
|
111
|
-
```csharp
|
|
112
|
-
builder.Services.AddIgniteUIBlazor(typeof(IgbBannerModule));
|
|
113
|
-
```
|
|
114
|
-
|
|
115
71
|
```razor
|
|
116
72
|
<IgbBanner @ref="BannerRef">
|
|
117
73
|
<IgbIcon slot="prefix" IconName="wifi_off" Collection="material" />
|
|
118
74
|
You are currently offline.
|
|
119
|
-
<IgbButton slot="actions" @onclick="
|
|
75
|
+
<IgbButton slot="actions" @onclick="Retry">Retry</IgbButton>
|
|
120
76
|
</IgbBanner>
|
|
121
77
|
|
|
122
|
-
<IgbButton @onclick="ShowBanner">Show Banner</IgbButton>
|
|
123
|
-
|
|
124
78
|
@code {
|
|
125
|
-
IgbBanner BannerRef { get; set; }
|
|
79
|
+
IgbBanner BannerRef { get; set; } = default!;
|
|
126
80
|
Task ShowBanner() => BannerRef.ShowAsync();
|
|
127
|
-
void RetryConnection() { /* retry logic */ }
|
|
128
81
|
}
|
|
129
82
|
```
|
|
130
83
|
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
## Key Rules
|
|
134
|
-
|
|
135
|
-
1. **Use `@ref` to obtain a component reference**, then call `ShowAsync()` / `HideAsync()` on it from C# code.
|
|
136
|
-
2. **`IgbDialog.KeepOpenOnEscape` is `false` by default** - meaning the dialog closes when the user presses ESC. Set it to `true` to prevent ESC from closing the dialog (forcing users to use your footer buttons).
|
|
137
|
-
3. **`IgbDialog.CloseOnOutsideClick` is `false` by default** - set it to `true` for light-dismiss dialogs.
|
|
138
|
-
4. **`IgbSnackbar.DisplayTime="0"` keeps it open until `HideAsync()` is called.** Use `KeepOpen` for the same effect.
|
|
139
|
-
5. **Footer buttons in `IgbDialog` must use `slot="footer"`.** Without the slot, they render in the body.
|
|
140
|
-
6. **`IgbBanner` is inline** (pushes content down) while `IgbDialog` is a modal overlay. Use banners for persistent, low-urgency messages and dialogs for confirmations or blocking actions.
|
|
84
|
+
Slots: `prefix` for an icon or illustration, `actions` for buttons, default for the message. The banner is in-flow, so it reflows the page rather than overlaying it.
|