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.
Files changed (76) hide show
  1. package/package.json +4 -4
  2. package/templates/blazor/igb/projects/ai-config/files/skills/AGENTS.md +6 -3
  3. package/templates/blazor/igb/projects/ai-config/files/skills/README.md +30 -45
  4. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/SKILL.md +48 -96
  5. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/charts.md +61 -238
  6. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/data-display.md +60 -193
  7. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/feedback.md +36 -92
  8. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/form-controls.md +66 -224
  9. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/layout-manager.md +39 -88
  10. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/layout.md +75 -152
  11. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/setup.md +40 -149
  12. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-generate-from-image-design/SKILL.md +58 -243
  13. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-generate-from-image-design/references/component-mapping.md +89 -280
  14. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-generate-from-image-design/references/gotchas.md +143 -431
  15. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/SKILL.md +91 -157
  16. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/data-operations.md +50 -228
  17. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/editing.md +61 -222
  18. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/features.md +67 -360
  19. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/grid-migration.md +55 -236
  20. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/paging-remote.md +53 -202
  21. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/sizing.md +31 -232
  22. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/state.md +27 -119
  23. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/structure.md +88 -363
  24. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/types.md +87 -415
  25. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-lite-testing/SKILL.md +86 -0
  26. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-lite-testing/references/interop-contracts.md +220 -0
  27. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-theming/SKILL.md +83 -211
  28. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-theming/references/common-patterns.md +93 -184
  29. package/templates/react/igr-ts/projects/_base/files/src/main.tsx +1 -0
  30. package/templates/react/igr-ts/projects/_base_with_home/files/src/app/home/style.module.css +3 -3
  31. package/templates/react/igr-ts/projects/ai-config/files/skills/README.md +30 -83
  32. package/templates/react/igr-ts/projects/ai-config/files/skills/grid-lite-to-igr-grid-migration/SKILL.md +98 -191
  33. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/SKILL.md +38 -147
  34. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/COMPONENTS.md +65 -0
  35. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/DATAVIZ.md +90 -0
  36. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/MCP.md +43 -0
  37. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/TROUBLESHOOTING.md +17 -145
  38. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/USAGE.md +85 -0
  39. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-customize-theme/SKILL.md +83 -135
  40. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-customize-theme/reference/CSS-THEMING.md +51 -218
  41. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-generate-from-image-design/SKILL.md +58 -187
  42. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-generate-from-image-design/reference/gotchas.md +55 -154
  43. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-optimize-bundle-size/SKILL.md +48 -401
  44. package/templates/react/igr-ts/projects/side-nav/files/src/app/app.css +9 -9
  45. package/templates/react/igr-ts/projects/side-nav/files/src/app/home/style.module.css +7 -7
  46. package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/app.css +8 -8
  47. package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/components/Login.module.css +1 -69
  48. package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/components/Login.tsx +5 -5
  49. package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/components/LoginBar.module.css +5 -26
  50. package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/components/LoginDialog.module.css +0 -1
  51. package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/components/Register.module.css +1 -56
  52. package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/components/Register.tsx +2 -2
  53. package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/pages/Profile.module.css +11 -11
  54. package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/pages/RedirectFacebook.tsx +1 -1
  55. package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/pages/RedirectGoogle.tsx +1 -1
  56. package/templates/react/igr-ts/projects/side-nav-auth/files/src/app/authentication/pages/RedirectMicrosoft.tsx +1 -1
  57. package/templates/react/igr-ts/projects/side-nav-mini/files/src/app/app.css +9 -9
  58. package/templates/react/igr-ts/projects/side-nav-mini/files/src/app/home/style.module.css +7 -7
  59. package/templates/react/igr-ts/projects/side-nav-mini-auth/files/src/app/app.css +7 -7
  60. package/templates/webcomponents/igc-ts/constants.d.ts +5 -5
  61. package/templates/webcomponents/igc-ts/constants.js +5 -5
  62. package/templates/webcomponents/igc-ts/projects/_base/files/package.json +1 -1
  63. package/templates/webcomponents/igc-ts/projects/_base_with_home/files/package.json +6 -6
  64. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/mcp-setup.md +0 -78
  65. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/mcp-setup.md +0 -78
  66. package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-theming/references/mcp-setup.md +0 -81
  67. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/CHARTS-GRIDS.md +0 -398
  68. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/COMPONENT-CATALOGUE.md +0 -161
  69. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/EVENT-HANDLING.md +0 -72
  70. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/INSTALLATION.md +0 -139
  71. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/JSX-PATTERNS.md +0 -187
  72. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/MCP-SERVER.md +0 -77
  73. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/reference/REFS-FORMS.md +0 -232
  74. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-customize-theme/reference/MCP-SERVER.md +0 -67
  75. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-customize-theme/reference/TROUBLESHOOTING.md +0 -35
  76. package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-generate-from-image-design/reference/component-mapping.md +0 -132
@@ -1,291 +1,100 @@
1
- # Ignite UI Blazor Component Mapping Reference
1
+ # Visual Pattern → Ignite UI Blazor Component
2
2
 
3
- ## Table of Contents
4
- - [Dashboard & Layout Components](#dashboard--layout-components)
5
- - [Chart Components](#chart-components)
6
- - [Data Display Components](#data-display-components)
7
- - [Form & Input Components](#form--input-components)
8
- - [Calendar & Scheduling Components](#calendar--scheduling-components)
9
- - [Feedback & Overlay Components](#feedback--overlay-components)
10
- - [Map Components](#map-components)
11
- - [Gauge Components](#gauge-components)
12
- - [Package Requirements](#package-requirements)
13
- - [Import & Registration Patterns](#import--registration-patterns)
3
+ A selection reference, not an API reference. Confirm exact parameters with `get_doc` or the [`igniteui-blazor-components`](../../igniteui-blazor-components/SKILL.md) reference files before writing markup.
14
4
 
15
- ---
5
+ ## Structure & navigation
16
6
 
17
- ## Dashboard & Layout Components
18
-
19
- | UI Pattern | Ignite UI Blazor Component | Key Properties |
20
- |---|---|---|
21
- | Top navigation bar | `IgbNavbar` | `slot="start"` for leading actions, default content for title/brand text, `slot="end"` for trailing actions |
22
- | Side navigation | `IgbNavDrawer` | `Open`, `Position`, `IgbNavDrawerItem`, `IgbNavDrawerHeaderItem`, `mini` slot for icon-only collapsed content |
23
- | Content cards/panels | `IgbCard` | `IgbCardHeader`, `IgbCardContent`, `IgbCardMedia`, `IgbCardActions` |
24
- | Tabbed content | `IgbTabs` | `IgbTab`, `IgbTabPanel`, `Panel` on tab matching panel `Id`; use `Change`/`Select` for controlled selection |
25
- | Accordion sections | `IgbAccordion` | `IgbExpansionPanel` children |
26
- | Tile dashboard | `IgbTileManager` | `ColumnCount`, `Gap`, `MinColumnWidth`, `MinRowHeight`, `DragMode`, `ResizeMode` |
27
- | IDE-like dockable pane layout | `IgbDockManager` | `IgbDockManagerLayout`, pane types: `IgbSplitPane`, `IgbTabGroupPane`, `IgbContentPane`; supports floating, pinning, serialization |
28
- | Repeated rows with icon/text/action | `IgbList` + `IgbListItem` | `slot="start"`, `slot="title"`, `slot="subtitle"`, `slot="end"` |
29
- | Spreadsheet-like editable or sortable table | `IgbGrid` | Full-featured data grid |
30
- | Hierarchical or tree-structured table | `IgbTreeGrid` | `PrimaryKey`, `ForeignKey`, `ChildDataKey` |
31
- | Content blocks / summary cards | `IgbCard` | Use `IgbCardHeader`, `IgbCardContent`, `IgbCardActions` slots with custom projected content. Use plain `<div>` containers for flat or highly custom tiles |
32
- | Any text input field | `IgbInput` | Use when the input anatomy matches the screenshot, including search fields and inline editors |
33
- | Dropdown or select | `IgbSelect` | Use when the screenshot clearly shows select/dropdown behavior |
34
- | Form fields with labels and inputs | `IgbInput`, `IgbSelect`, `IgbCombo` | Text, select, combo, and date inputs |
35
- | Multi-step form / wizard | `IgbStepper` | Use when a sequence of steps is visually present |
36
- | Filter chips / tag inputs | `IgbChip` | Use when chip anatomy matches status badges, filter tags, or removable labels |
37
- | Calendar or date picker as a primary view element | `IgbCalendar`, `IgbDatePicker` | Use when scheduling or date selection is the core UI |
38
- | Top icon/action bar | `IgbNavbar` with projected icon buttons | Use when a navbar structure matches the screenshot; use plain icon buttons or custom containers when that is a closer fit |
39
-
40
- Decision rules:
41
-
42
- - Use `IgbNavbar` for a top horizontal bar when its slot structure and behavior match the screenshot. Use custom projected content and CSS flex overrides to achieve multi-zone layouts inside it. Use a plain `<header>` element when that is a closer structural fit.
43
- - Use `IgbNavDrawer` for a sidebar or side-navigation panel when drawer structure and behavior match the screenshot. Configure `Open`, `Position`, and the `mini` slot according to whether the design shows expanded, temporary, or icon-only navigation. Use a plain `<aside>` when a static custom sidebar matches the screenshot better.
44
- - Use `IgbTabs` for a horizontal tab strip when the screenshot clearly shows tabbed state switching.
45
-
46
- Component decision matrix (by visual pattern, domain-neutral):
47
-
48
- | Visual Pattern | Recommended Component | Notes |
49
- |---|---|---|
50
- | Sidebar with icon rows | `IgbNavDrawer` | `IgbNavDrawerItem` children; use `mini` slot for collapsed icon-only rows |
51
- | Top bar with brand/search/actions | `IgbNavbar` | Project icon buttons into action slots |
52
- | Card grid / tile layout | `IgbTileManager` or `IgbCard` in CSS Grid | `IgbTileManager` for drag/resize; plain CSS Grid + `IgbCard` for static layouts |
53
- | KPI summary row | Plain HTML in CSS Grid | Bind Ignite UI primitives (icons, badges, progress) inside semantic containers |
54
- | Collapsible section | `IgbExpansionPanel` or `IgbAccordion` | `IgbAccordion` when design shows only-one-open behavior |
55
- | Tab strip | `IgbTabs` | Use `IgbTab` + `IgbTabPanel` pairs |
56
- | Step-by-step wizard | `IgbStepper` | Horizontal or vertical orientation based on layout |
57
- | Data table | `IgbGrid` / `IgbTreeGrid` | Use only when content is truly tabular |
58
- | IDE pane layout | `IgbDockManager` | Use when the design shows multi-pane, draggable/floating dock areas |
59
-
60
- ---
61
-
62
- ## Chart Components
63
-
64
- | UI Pattern | Ignite UI Blazor Component | Key Properties |
65
- |---|---|---|
66
- | Area chart | `IgbCategoryChart` | `ChartType="CategoryChartType.Area"`, `MarkerTypes`, `DataSource` |
67
- | Line chart | `IgbCategoryChart` | `ChartType="CategoryChartType.Line"`, `MarkerTypes`, `DataSource` |
68
- | Column chart | `IgbCategoryChart` | `ChartType="CategoryChartType.Column"`, `DataSource` |
69
- | Sparkline (mini chart) | `IgbSparkline` | `DisplayType`, `ValueMemberPath`, `DataSource` |
70
- | Pie chart | `IgbPieChart` | `ValueMemberPath`, `LabelMemberPath`, `DataSource` |
71
- | Donut chart | `IgbDoughnutChart` + `IgbRingSeries` | `ValueMemberPath`, `LabelMemberPath`, `DataSource` |
72
- | Financial chart | `IgbFinancialChart` | `ChartType`, OHLC member paths, `DataSource` |
73
- | Complex multi-series | `IgbDataChart` | Multiple `IgbSeries` + `IgbAxis` children |
74
- | Hierarchical part-to-whole (weighted tree) | `IgbTreemap` | `DataSource`, `LabelMemberPath`, `ValueMemberPath` |
75
- | Auto-generated dashboard widget from data | `IgbDashboardTile` | Verify supported chart modes and binding shape with `get_doc` before use |
76
-
77
- Decision rules:
78
-
79
- - Financial or OHLC screenshot: prefer `IgbFinancialChart`
80
- - Simple or moderate trend panel: prefer `IgbCategoryChart`; move to `IgbDataChart` when you need lower-level per-series control
81
- - Highly custom sparkline or microchart: use `IgbSparkline` or a custom fallback if the built-in anatomy is not a close visual match
82
- - Part-to-whole: prefer `IgbPieChart` for a solid pie chart or `IgbDoughnutChart` with `IgbRingSeries` for a donut chart
83
-
84
- ---
85
-
86
- ## Data Display Components
87
-
88
- | UI Pattern | Ignite UI Blazor Component | Key Properties |
7
+ | What the image shows | Component | Notes |
89
8
  |---|---|---|
90
- | Item list | `IgbList` + `IgbListItem` | `slot="start"` (avatar/icon), `slot="title"`, `slot="subtitle"`, `slot="end"` |
91
- | User avatar | `IgbAvatar` | `Shape` (`AvatarShape.Circle`, `AvatarShape.Rounded`, `AvatarShape.Square`), `Initials`, `Src`, `Alt` |
92
- | Status badge | `IgbBadge` | Content for visible text/count, `Variant`, `Shape`, `Dot`, `Outlined` |
93
- | Icons | `IgbIcon` | `Collection`, `IconName`; register custom icons before use |
94
- | Progress bar | `IgbLinearProgress` | `Value`, `Max` |
95
- | Circular progress | `IgbCircularProgress` | `Value`, `Max` |
96
- | Flat data grid | `IgbGrid` | Full-featured data grid with sorting, filtering, editing |
97
- | Hierarchical/tree data grid | `IgbTreeGrid` | `PrimaryKey`, `ForeignKey`, `ChildDataKey` |
98
- | Filter/tag chips | `IgbChip` | `Removable`, `Selectable` |
99
- | Tree view | `IgbTree` + `IgbTreeItem` | `Label`, `Expanded`, `Selection` mode |
100
- | Content card | `IgbCard` | `IgbCardHeader`, `IgbCardMedia`, `IgbCardContent`, `IgbCardActions` |
101
- | Carousel | `IgbCarousel` | Slide-based navigation |
102
- | Action button | `IgbButton` | `Variant` (`ButtonVariant.Contained` / `Outlined` / `Flat` / `Fab`), `Disabled`, `DisplayType`, `Href` |
103
- | Toggle button group | `IgbButtonGroup` + `IgbToggleButton` | `Selection` (`ButtonGroupSelection.Single` / `Multiple`), `Alignment` |
104
- | Icon-only button | `IgbIconButton` | `IconName`, `Collection`, `Variant` (`IconButtonVariant.Flat` / `Outlined` / `Contained`) |
105
- | Contextual dropdown / action menu | `IgbDropdown` | `IgbDropdownItem`, `IgbDropdownHeader`, `Placement`, `Change` event; trigger via `slot="target"` or `@ref` |
106
- | Informational tooltip on hover | `IgbTooltip` | `Anchor` (target element ID), `Placement`, `ShowDelay`, `HideDelay` |
107
- | Click / touch ripple effect | `IgbRipple` | Nested inside any container; customize color via `--color` CSS property |
108
- | Master-detail grid with nested child grids | `IgbHierarchicalGrid` | `IgbRowIsland` children; each row can expand to a full child grid |
109
- | Read-only simple list grid | `IgbGridLite` | OSS (`IgniteUI.Blazor.GridLite` package); no editing, no complex features |
110
-
111
- Decision rules:
112
-
113
- - Use `IgbList` for repeated-row content lists when its row structure and interaction model match the screenshot. The component adds accessible keyboard navigation, item structure, and theming when those benefits fit the design. Use native `<ul>/<li>` or custom containers when they are a closer visual fit.
114
- - Choose `IgbGrid` only when the image is truly tabular (flat rows and columns, spreadsheet-style).
115
- - Choose `IgbTreeGrid` when rows have parent-child or hierarchical structure within a single grid surface.
116
- - Choose `IgbHierarchicalGrid` when rows expand to reveal a complete nested child grid (master-detail).
117
- - Choose `IgbGridLite` for read-only display-only grids where editing and advanced features are not needed.
118
- - Use `IgbChip` when chip anatomy matches the screenshot's status badges, tags, or label pills. Use custom badge or pill markup when a simpler or more exact visual match is needed.
119
- - Use `IgbButton` / `IgbButtonGroup` for primary call-to-action areas. Use `IgbIconButton` when only an icon is shown with no text label.
120
- - Use `IgbDropdown` for contextual action menus that open on a trigger. Prefer `IgbSelect` when the dropdown is a form field for selecting a value.
121
- - Use `IgbTooltip` for brief informational text that appears on hover. Use `IgbSnackbar` or `IgbBanner` (see Feedback section) for persistent or actionable notifications.
122
-
123
- ---
124
-
125
- ## Form & Input Components
126
-
127
- | UI Pattern | Ignite UI Blazor Component | Key Properties |
128
- |---|---|---|
129
- | Text input / search field | `IgbInput` | `Type`, `Label`, `Placeholder`, `@bind-Value` |
130
- | Select / dropdown | `IgbSelect` | `IgbSelectItem` children, `@bind-Value` |
131
- | Multi-select combo | `IgbCombo` | `Data`, `DisplayKey`, `ValueKey`, `T`, `@bind-Value` |
132
- | Date picker | `IgbDatePicker` | `@bind-Value`, `DisplayFormat` |
133
- | Calendar | `IgbCalendar` | `Selection`, `@bind-Value` |
134
- | Checkbox | `IgbCheckbox` | `@bind-Checked` |
135
- | Radio button | `IgbRadio` / `IgbRadioGroup` | `@bind-Value` on group |
136
- | Switch / toggle | `IgbSwitch` | `@bind-Checked` |
137
- | Slider | `IgbSlider` / `IgbRangeSlider` | `@bind-Value`, `Min`, `Max`, `Step` |
138
- | Rating | `IgbRating` | `@bind-Value`, `Max` |
139
- | Stepper / wizard | `IgbStepper` | `IgbStep` children, `Orientation` |
140
- | Date / time inline input | `IgbDateTimeInput` | `@bind-Value`, `InputFormat`, `DisplayFormat`, `SpinLoop`, `Min`, `Max` |
141
- | Masked text input (phone, postal, etc.) | `IgbMaskInput` | `Mask` pattern (`0`=digit, `L`=letter, `A`=alphanumeric), `Prompt`, `ValueMode` |
142
-
143
- ---
144
-
145
- ## Calendar & Scheduling Components
146
-
147
- | UI Pattern | Ignite UI Blazor Component | Key Properties |
9
+ | Top horizontal bar with brand, actions | `IgbNavbar` | slots `start` / default / `end`; use a plain `<header>` if the slot structure fights the design |
10
+ | Sidebar / side navigation | `IgbNavDrawer` + `IgbNavDrawerItem` | **`Position="NavDrawerPosition.Relative"` for a pinned in-flow sidebar**; `slot="mini"` for an icon-only collapsed rail; plain `<aside>` for a fully static custom sidebar |
11
+ | Tab strip switching content | `IgbTabs` + `IgbTab` | header via `Label` or the `label` slot; there is no `IgbTabPanel` |
12
+ | Collapsible sections | `IgbExpansionPanel`, or `IgbAccordion` when only one opens at a time | |
13
+ | Step-by-step wizard | `IgbStepper` + `IgbStep` | `Orientation`, `Linear` |
14
+ | Resizable two-pane split | `IgbSplitter` | `slot="start"` / `slot="end"`, `StartSize`, min/max sizes |
15
+ | Section separator line | `IgbDivider` | `Vertical`, `Middle`, `LineType` |
16
+ | Draggable/resizable widget dashboard | `IgbTileManager` + `IgbTile` | `ColumnCount`, `Gap`, `ColSpan`/`RowSpan`, `DragMode`, `ResizeMode` |
17
+ | Static card grid | `IgbCard` inside CSS Grid | use `IgbTileManager` only when tiles actually drag or resize |
18
+ | IDE-style dockable/floating panes | `IgbDockManager` | licensed package only; needs an explicit height |
19
+
20
+ ## Content & data display
21
+
22
+ | What the image shows | Component | Notes |
148
23
  |---|---|---|
149
- | Calendar view | `IgbCalendar` | `Selection`, `@bind-Value` |
150
- | Date picker in form | `IgbDatePicker` | `@bind-Value`, `DisplayFormat` |
151
- | Date range selection | `IgbDateRangePicker` | `@bind-Value` |
24
+ | Repeated rows: icon/avatar + text + trailing action | `IgbList` + `IgbListItem` | slots `start`, `title`, `subtitle`, `end` |
25
+ | Content / summary card | `IgbCard` | `IgbCardMedia`, `IgbCardHeader`, `IgbCardContent`, `IgbCardActions`; no default width |
26
+ | KPI / stat tile row | plain HTML in CSS Grid | compose Ignite UI primitives (icon, badge, progress) inside your own containers |
27
+ | Avatar | `IgbAvatar` | `Shape` (`Circle`/`Rounded`/`Square`), `Initials`, `Src` |
28
+ | Status badge / count | `IgbBadge` | `Variant` (`StyleVariant`), `Shape`, `Dot`, `Outlined` |
29
+ | Filter tag, removable pill | `IgbChip` | `Removable`, `Selectable`, `Variant` |
30
+ | Icon | `IgbIcon` | `IconName` + `Collection`; register before first render |
31
+ | Progress bar / ring | `IgbLinearProgress` / `IgbCircularProgress` | `Value`, `Max`, `Indeterminate` — not for data viz |
32
+ | Tree view | `IgbTree` + `IgbTreeItem` | `Label`, `Expanded`, `Selection` |
33
+ | Carousel / slideshow | `IgbCarousel` + `IgbCarouselSlide` | `Interval`, `AnimationType` |
34
+ | Highlighted search matches in text | `IgbHighlight` | `SearchText`, `CaseSensitive` |
35
+ | Chat / conversation surface | `IgbChat` | configured through `IgbChatOptions` |
36
+
37
+ Use `IgbList` when its row anatomy and keyboard behavior fit; native `<ul>/<li>` when they do not.
38
+
39
+ ## Tables
40
+
41
+ | What the image shows | Component |
42
+ |---|---|
43
+ | Flat spreadsheet-style rows and columns | `IgbGrid` |
44
+ | Read-only table, no editing or selection | `IgbGridLite` (OSS, own package) |
45
+ | Rows expanding to child rows in the same schema | `IgbTreeGrid` |
46
+ | Rows expanding to a complete nested child grid | `IgbHierarchicalGrid` + `IgbRowIsland` |
47
+ | Pivot table with draggable dimensions | `IgbPivotGrid` |
152
48
 
153
- ---
49
+ Only pick a grid when the content is genuinely tabular. A list of records with rich per-row layout is a list, not a grid.
154
50
 
155
- ## Feedback & Overlay Components
51
+ ## Forms & input
156
52
 
157
- | UI Pattern | Ignite UI Blazor Component | Key Properties |
53
+ | What the image shows | Component | Notes |
158
54
  |---|---|---|
159
- | Modal confirmation / form dialog | `IgbDialog` | `Title`, `Open`, `KeepOpenOnEscape`, `CloseOnOutsideClick`, `slot="footer"` for action buttons; `ShowAsync()`, `HideAsync()` |
160
- | Brief notification with optional action | `IgbSnackbar` | `DisplayTime` (ms; 0 = keep open), `KeepOpen`, `ActionText`, `ShowAsync()`, `HideAsync()` |
161
- | Auto-dismissing status notification | `IgbToast` | `DisplayTime` (ms), `KeepOpen`, `ShowAsync()`, `HideAsync()` |
162
- | Persistent inline alert / status message | `IgbBanner` | `slot="illustration"` (icon/image), `slot="actions"` (buttons); inline, non-modal; `ShowAsync()`, `HideAsync()`, `ToggleAsync()` |
163
-
164
- Decision rules:
165
-
166
- - Use `IgbDialog` for blocking, confirmable actions (e.g., delete confirmation, form in overlay). It is a modal overlay that pauses interaction with the rest of the page.
167
- - Use `IgbSnackbar` when a brief message with an optional action button is needed (e.g., "Undo"). It auto-dismisses after `DisplayTime`.
168
- - Use `IgbToast` for simple auto-dismissing status messages with no action button. Prefer `IgbSnackbar` when an action is required.
169
- - Use `IgbBanner` for persistent, low-urgency messages that push page content down (e.g., offline indicator, cookie consent). Unlike `IgbDialog`, it is inline and non-modal.
170
-
171
- ---
172
-
173
- ## Map Components
174
-
175
- | UI Pattern | Ignite UI Blazor Component | Key Properties |
55
+ | Text field, search box, inline editor | `IgbInput` | `Label`, `Placeholder`, `Outlined`, `@bind-Value` |
56
+ | Multi-line text | `IgbTextarea` | `Rows`, `Resize` |
57
+ | Dropdown selecting a value | `IgbSelect` + `IgbSelectItem` | |
58
+ | Searchable / multi-select picker | `IgbCombo` | generic parameter is `T`; `Data`, `DisplayKey`, `ValueKey` |
59
+ | Contextual action menu | `IgbDropdown` | trigger in `slot="target"` — not for form values |
60
+ | Date picker | `IgbDatePicker` (`DateTime?`) | |
61
+ | Date range | `IgbDateRangePicker` | |
62
+ | Always-visible calendar | `IgbCalendar` (`DateTime`, non-nullable) | `Selection`, `VisibleMonths` |
63
+ | Masked entry (phone, postal) | `IgbMaskInput` | `Mask`: `0` digit, `L` letter, `A` alphanumeric |
64
+ | Checkbox / switch | `IgbCheckbox` / `IgbSwitch` | `@bind-Checked` |
65
+ | Radio options | `IgbRadioGroup` + `IgbRadio` | `@bind-Value` on the **group**; do not use `Name` to group |
66
+ | Slider / range slider | `IgbSlider` / `IgbRangeSlider` | range uses `Lower` / `Upper` |
67
+ | Star rating | `IgbRating` | |
68
+ | Primary action button | `IgbButton` | `Variant`: `Contained`/`Outlined`/`Flat`/`Fab` |
69
+ | Segmented / toggle control | `IgbButtonGroup` + `IgbToggleButton` | |
70
+ | Icon-only button | `IgbIconButton` | |
71
+ | Hover hint | `IgbTooltip` | `Anchor` is the target element's **id string** |
72
+
73
+ ## Charts, maps, gauges
74
+
75
+ Licensed or trial package only.
76
+
77
+ | What the image shows | Component | Key parameters |
176
78
  |---|---|---|
177
- | World / region map | `IgbGeographicMap` | `Zoomable`, `BackgroundContent` |
178
- | Map markers (points) | `IgbGeographicSymbolSeries` | `LatitudeMemberPath`, `LongitudeMemberPath`, `MarkerType`, `MarkerBrush` |
179
- | Bubble overlay | `IgbGeographicProportionalSymbolSeries` | Sized markers based on data value |
180
- | Shape regions (polygons) | `IgbGeographicShapeSeries` | Polygon rendering |
181
- | Polyline paths | `IgbGeographicPolylineSeries` | Route/path rendering |
182
-
183
- ---
184
-
185
- ## Gauge Components
186
-
187
- | UI Pattern | Ignite UI Blazor Component | Key Properties |
188
- |---|---|---|
189
- | Linear gauge | `IgbLinearGauge` | `Value`, `MinimumValue`, `MaximumValue`, `NeedleBrush` |
190
- | Radial gauge | `IgbRadialGauge` | `Value`, `MinimumValue`, `MaximumValue` |
191
- | Bullet graph | `IgbBulletGraph` | `Value`, `TargetValue`, `MinimumValue`, `MaximumValue` |
192
-
193
- ---
194
-
195
- ## Package Requirements
196
-
197
- Ignite UI Blazor package selection depends on the component family. Use `IgniteUI.Blazor.Lite` for general purpose components and `IgniteUI.Blazor.GridLite` the light-weight grid, and `IgniteUI.Blazor` (trial version available publicly as `IgniteUI.Blazor.Trial`) for specialized feature-rich grids and charts.
198
-
199
- | NuGet Package | Description |
200
- |---|---|
201
- | `IgniteUI.Blazor.Lite` | Open-source / MIT core UI components such as layout, navigation, forms, lists, cards, feedback, and common inputs |
202
- | `IgniteUI.Blazor.GridLite` | Open-source / MIT `IgbGridLite` package for lightweight data grid scenarios |
203
- | `IgniteUI.Blazor.Trial` | Full component suite with trial watermark - same capabilities as `IgniteUI.Blazor`, publicly available on NuGet.org for evaluation |
204
- | `IgniteUI.Blazor` | Licensed full component suite including premium grids, charts, maps, gauges, Dock Manager, and core UI components |
205
-
206
- | Capability | Package Required |
79
+ | Line / area / column trend | `IgbCategoryChart` | `ChartType`, `DataSource`, `Brushes`; match `Spline`/`SplineArea` to smooth curves |
80
+ | Multiple series types, custom axes, horizontal bars | `IgbDataChart` | series + axis children matched by `Name` |
81
+ | Candlestick / OHLC | `IgbFinancialChart` | needs Open/High/Low/Close fields |
82
+ | Pie | `IgbPieChart` | `ValueMemberPath`, `LabelMemberPath` |
83
+ | Donut, or a colored ring with a centered value | `IgbDoughnutChart` + `IgbRingSeries` | `InnerExtent` on the **chart** |
84
+ | Inline micro-chart | `IgbSparkline` | `DisplayType`; no smooth curves — use a small `IgbCategoryChart` for those |
85
+ | Weighted hierarchy blocks | `IgbTreemap` | |
86
+ | Map with markers / regions / routes | `IgbGeographicMap` + a geographic series | series are child components |
87
+ | Needle on a scale | `IgbRadialGauge` / `IgbLinearGauge` | |
88
+ | Value vs target bar | `IgbBulletGraph` | |
89
+ | Auto-generated dashboard visual | `IgbDashboardTile` | verify binding shape first |
90
+
91
+ Read [`gotchas.md`](./gotchas.md) before writing any chart markup — the chart section there covers the mistakes that produce a compiling but visibly wrong result.
92
+
93
+ ## Overlays & feedback
94
+
95
+ | What the image shows | Component |
207
96
  |---|---|
208
- | Core UI components (list, avatar, navbar, drawer, card, badge, progress, icon, etc.) | `IgniteUI.Blazor.Lite` or `IgniteUI.Blazor` / `IgniteUI.Blazor.Trial` |
209
- | Charts / sparklines | `IgniteUI.Blazor` or `IgniteUI.Blazor.Trial` only |
210
- | Maps | `IgniteUI.Blazor` or `IgniteUI.Blazor.Trial` only |
211
- | Gauges / bullet graphs | `IgniteUI.Blazor` or `IgniteUI.Blazor.Trial` only |
212
- | Full data grids (`IgbGrid`, `IgbTreeGrid`, `IgbHierarchicalGrid`, `IgbPivotGrid`) | `IgniteUI.Blazor` or `IgniteUI.Blazor.Trial` only |
213
- | Grid Lite (`IgbGridLite`) | `IgniteUI.Blazor.GridLite` or `IgniteUI.Blazor` / `IgniteUI.Blazor.Trial` |
214
- | Tile Manager | `IgniteUI.Blazor.Lite` or `IgniteUI.Blazor` / `IgniteUI.Blazor.Trial` |
215
- | Dock Manager | `IgniteUI.Blazor` or `IgniteUI.Blazor.Trial` only |
216
-
217
- ---
218
-
219
- ## Import & Registration Patterns
220
-
221
- ### 1. NuGet package reference (`.csproj`)
222
-
223
- ```xml
224
- <!-- Licensed full suite -->
225
- <PackageReference Include="IgniteUI.Blazor" Version="<resolved-version>" />
226
-
227
- <!-- Trial full suite (watermarked, public NuGet.org) -->
228
- <PackageReference Include="IgniteUI.Blazor.Trial" Version="<resolved-version>" />
229
-
230
- <!-- OSS core UI components -->
231
- <PackageReference Include="IgniteUI.Blazor.Lite" Version="<resolved-version>" />
232
-
233
- <!-- OSS Grid Lite -->
234
- <PackageReference Include="IgniteUI.Blazor.GridLite" Version="<resolved-version>" />
235
- ```
236
-
237
- Choose the package that matches the component requirements above. Do not add all three by default.
238
-
239
- ### 2. Service registration (`Program.cs`)
240
-
241
- Every `Igb*` component requires its corresponding `IgbXxxModule` to be registered:
242
-
243
- ```csharp
244
- using IgniteUI.Blazor.Controls;
245
-
246
- builder.Services.AddIgniteUIBlazor(
247
- typeof(IgbNavbarModule),
248
- typeof(IgbNavDrawerModule),
249
- typeof(IgbListModule),
250
- typeof(IgbCardModule),
251
- typeof(IgbAvatarModule),
252
- typeof(IgbBadgeModule),
253
- typeof(IgbCategoryChartModule),
254
- typeof(IgbGridModule)
255
- // ... add every IgbXxxModule your page uses
256
- );
257
- ```
258
-
259
- > **If you forget to register a module, the component will silently fail to render.** Always double-check that every `Igb*` component used in Razor has its module registered in `Program.cs`.
260
-
261
- ### 3. Using directive (`_Imports.razor`)
262
-
263
- ```razor
264
- @using IgniteUI.Blazor.Controls
265
- ```
266
-
267
- ### 4. CSS theme (`wwwroot/index.html` or `App.razor`)
268
-
269
- ```html
270
- <link href="_content/IgniteUI.Blazor/themes/light/bootstrap.css" rel="stylesheet" />
271
- ```
272
-
273
- > **If the generated view includes any full-featured grid** (`IgbGrid`, `IgbTreeGrid`, `IgbHierarchicalGrid`, `IgbPivotGrid`), also add the grid-specific stylesheet immediately after:
274
- > ```html
275
- > <link href="_content/IgniteUI.Blazor/themes/grid/light/bootstrap.css" rel="stylesheet" />
276
- > ```
277
- >
278
- > **If the generated view includes `IgbGridLite`**, replace both links above with the single Grid Lite stylesheet (from the `IgniteUI.Blazor.GridLite` package):
279
- > ```html
280
- > <link href="_content/IgniteUI.Blazor.GridLite/css/themes/light/bootstrap.css" rel="stylesheet" />
281
- > ```
282
-
283
- ### 5. JS interop script (`wwwroot/index.html` or `App.razor`)
284
-
285
- ```html
286
- <script src="_content/IgniteUI.Blazor/app.bundle.js"></script>
287
- ```
288
-
289
- ---
290
-
291
- Treat this file as a component selection reference, not as authoritative API guidance for a specific version. Confirm exact parameters and behavior from `get_doc` results and the current workspace's reference files (`igniteui-blazor-components` skill).
97
+ | Modal confirmation or form overlay | `IgbDialog` — buttons in `slot="footer"` |
98
+ | Brief floating message with an action | `IgbSnackbar` — `ActionText` + `Action` |
99
+ | Brief floating message, no action | `IgbToast` |
100
+ | Persistent inline notice that pushes content down | `IgbBanner` — `slot="actions"` |