igniteui-cli 15.7.0 → 15.8.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 +1 -1
- package/templates/blazor/igb/projects/ai-config/files/skills/README.md +1 -7
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/SKILL.md +8 -6
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/client-scripts.md +100 -0
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/data-display.md +25 -2
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/form-controls.md +20 -0
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/layout.md +15 -1
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/setup.md +13 -3
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-generate-from-image-design/SKILL.md +2 -2
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-generate-from-image-design/references/component-mapping.md +3 -0
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/SKILL.md +2 -2
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-theming/SKILL.md +1 -2
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-theming/references/common-patterns.md +0 -1
- package/templates/react/igr-ts/breadcrumbs/default/files/src/app/__path__/__filePrefix__.test.tsx +13 -0
- package/templates/react/igr-ts/breadcrumbs/default/files/src/app/__path__/__filePrefix__.tsx +20 -0
- package/templates/react/igr-ts/breadcrumbs/default/files/src/app/__path__/style.module.css +9 -0
- package/templates/react/igr-ts/breadcrumbs/default/index.d.ts +1 -0
- package/templates/react/igr-ts/breadcrumbs/default/index.js +18 -0
- package/templates/react/igr-ts/breadcrumbs/index.d.ts +1 -0
- package/templates/react/igr-ts/breadcrumbs/index.js +12 -0
- package/templates/react/igr-ts/bullet-graph/default/index.js +2 -1
- package/templates/react/igr-ts/category-chart/default/index.js +2 -1
- package/templates/react/igr-ts/chat/index.js +1 -1
- package/templates/react/igr-ts/color-picker/color-picker-alpha/files/src/app/__path__/__filePrefix__.test.tsx +13 -0
- package/templates/react/igr-ts/color-picker/color-picker-alpha/files/src/app/__path__/__filePrefix__.tsx +23 -0
- package/templates/react/igr-ts/color-picker/color-picker-alpha/files/src/app/__path__/style.module.css +9 -0
- package/templates/react/igr-ts/color-picker/color-picker-alpha/index.d.ts +1 -0
- package/templates/react/igr-ts/color-picker/color-picker-alpha/index.js +18 -0
- package/templates/react/igr-ts/color-picker/default/files/src/app/__path__/__filePrefix__.test.tsx +13 -0
- package/templates/react/igr-ts/color-picker/default/files/src/app/__path__/__filePrefix__.tsx +16 -0
- package/templates/react/igr-ts/color-picker/default/files/src/app/__path__/style.module.css +9 -0
- package/templates/react/igr-ts/color-picker/default/index.d.ts +1 -0
- package/templates/react/igr-ts/color-picker/default/index.js +18 -0
- package/templates/react/igr-ts/color-picker/index.d.ts +1 -0
- package/templates/react/igr-ts/color-picker/index.js +12 -0
- package/templates/react/igr-ts/constants.d.ts +4 -2
- package/templates/react/igr-ts/constants.js +5 -3
- package/templates/react/igr-ts/date-time-input/default/index.js +1 -1
- package/templates/react/igr-ts/date-time-input/index.js +1 -1
- package/templates/react/igr-ts/dialog/default/index.js +1 -1
- package/templates/react/igr-ts/dialog/index.js +1 -1
- package/templates/react/igr-ts/divider/default/index.js +1 -1
- package/templates/react/igr-ts/divider/index.js +1 -1
- package/templates/react/igr-ts/doughnut-chart/default/index.js +2 -1
- package/templates/react/igr-ts/financial-chart/default/index.js +2 -1
- package/templates/react/igr-ts/grid/basic/index.js +1 -1
- package/templates/react/igr-ts/groups.json +7 -8
- package/templates/react/igr-ts/hierarchical-grid/basic/index.js +1 -1
- package/templates/react/igr-ts/highlight/default/index.js +1 -1
- package/templates/react/igr-ts/highlight/index.js +1 -1
- package/templates/react/igr-ts/linear-gauge/default/index.js +2 -1
- package/templates/react/igr-ts/pie-chart/default/index.js +2 -1
- package/templates/react/igr-ts/pivot-grid/basic/index.js +1 -1
- package/templates/react/igr-ts/projects/_base/files/package.json +1 -1
- package/templates/react/igr-ts/projects/ai-config/files/skills/README.md +7 -7
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/SKILL.md +10 -9
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/{reference → references}/DATAVIZ.md +1 -1
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-customize-theme/SKILL.md +4 -3
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-generate-from-image-design/SKILL.md +5 -4
- package/templates/react/igr-ts/projects/ai-config/files/skills/{grid-lite-to-igr-grid-migration → igniteui-react-migrate-grid-lite-to-premium}/SKILL.md +3 -2
- package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-optimize-bundle-size/SKILL.md +4 -3
- package/templates/react/igr-ts/qr-code/default/files/src/app/__path__/__filePrefix__.test.tsx +13 -0
- package/templates/react/igr-ts/qr-code/default/files/src/app/__path__/__filePrefix__.tsx +14 -0
- package/templates/react/igr-ts/qr-code/default/files/src/app/__path__/style.module.css +9 -0
- package/templates/react/igr-ts/qr-code/default/index.d.ts +1 -0
- package/templates/react/igr-ts/qr-code/default/index.js +18 -0
- package/templates/react/igr-ts/qr-code/index.d.ts +1 -0
- package/templates/react/igr-ts/qr-code/index.js +12 -0
- package/templates/react/igr-ts/radial-gauge/default/index.js +2 -2
- package/templates/react/igr-ts/tree-grid/basic/index.js +1 -1
- package/templates/react/igr-ts/virtual-scroll/default/files/src/app/__path__/__filePrefix__.test.tsx +13 -0
- package/templates/react/igr-ts/virtual-scroll/default/files/src/app/__path__/__filePrefix__.tsx +34 -0
- package/templates/react/igr-ts/virtual-scroll/default/files/src/app/__path__/style.module.css +16 -0
- package/templates/react/igr-ts/virtual-scroll/default/index.d.ts +1 -0
- package/templates/react/igr-ts/virtual-scroll/default/index.js +18 -0
- package/templates/react/igr-ts/virtual-scroll/index.d.ts +1 -0
- package/templates/react/igr-ts/virtual-scroll/index.js +12 -0
- package/templates/webcomponents/igc-ts/breadcrumb/default/files/src/app/__path__/__filePrefix__.test.ts +9 -0
- package/templates/webcomponents/igc-ts/breadcrumb/default/files/src/app/__path__/__filePrefix__.ts +36 -0
- package/templates/webcomponents/igc-ts/breadcrumb/default/index.d.ts +1 -0
- package/templates/webcomponents/igc-ts/breadcrumb/default/index.js +16 -0
- package/templates/webcomponents/igc-ts/breadcrumb/index.d.ts +1 -0
- package/templates/webcomponents/igc-ts/breadcrumb/index.js +15 -0
- package/templates/webcomponents/igc-ts/divider/default/index.js +1 -1
- package/templates/webcomponents/igc-ts/divider/index.js +1 -1
- package/templates/webcomponents/igc-ts/groups.json +9 -10
- package/templates/webcomponents/igc-ts/highlight/default/index.js +1 -1
- package/templates/webcomponents/igc-ts/highlight/index.js +1 -1
- package/templates/webcomponents/igc-ts/projects/_base/files/package.json +1 -1
- package/templates/webcomponents/igc-ts/projects/_base_with_home/files/package.json +1 -1
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/README.md +4 -3
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-choose-components/SKILL.md +2 -1
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-customize-component-theme/SKILL.md +2 -1
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/SKILL.md +328 -0
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/asset-extraction.md +343 -0
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/design-provenance.md +199 -0
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/design-token-bridge.md +489 -0
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/figma-component-map.md +370 -0
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/figma-exploration.md +222 -0
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/mcp-setup.md +363 -0
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/project-setup.md +105 -0
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/theme-generation.md +180 -0
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/validation-patterns.md +370 -0
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-generate-from-image-design/SKILL.md +2 -1
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-generate-from-image-design/references/gotchas.md +3 -3
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-grids/SKILL.md +133 -0
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-integrate-with-framework/SKILL.md +2 -1
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-migrate-grid-lite-to-premium/SKILL.md +24 -6
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-optimize-bundle-size/SKILL.md +2 -1
- package/templates/webcomponents/igc-ts/virtual-scroll/default/index.js +1 -1
- package/templates/webcomponents/igc-ts/virtual-scroll/index.js +1 -1
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-lite-testing/SKILL.md +0 -86
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-lite-testing/references/interop-contracts.md +0 -220
- /package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/{reference → references}/COMPONENTS.md +0 -0
- /package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/{reference → references}/MCP.md +0 -0
- /package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/{reference → references}/TROUBLESHOOTING.md +0 -0
- /package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-components/{reference → references}/USAGE.md +0 -0
- /package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-customize-theme/{reference → references}/CSS-THEMING.md +0 -0
- /package/templates/react/igr-ts/projects/ai-config/files/skills/igniteui-react-generate-from-image-design/{reference → references}/gotchas.md +0 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "igniteui-cli",
|
|
3
|
-
"version": "15.
|
|
3
|
+
"version": "15.8.0",
|
|
4
4
|
"description": "CLI tool for creating Ignite UI projects",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"CLI",
|
|
@@ -66,9 +66,9 @@
|
|
|
66
66
|
"all": true
|
|
67
67
|
},
|
|
68
68
|
"dependencies": {
|
|
69
|
-
"@igniteui/angular-templates": "~22.
|
|
70
|
-
"@igniteui/cli-core": "~15.
|
|
71
|
-
"@igniteui/mcp-server": "~15.
|
|
69
|
+
"@igniteui/angular-templates": "~22.2.1580",
|
|
70
|
+
"@igniteui/cli-core": "~15.8.0",
|
|
71
|
+
"@igniteui/mcp-server": "~15.8.0",
|
|
72
72
|
"@inquirer/prompts": "^7.9.0",
|
|
73
73
|
"chalk": "^5.3.0",
|
|
74
74
|
"glob": "^11.0.0",
|
|
@@ -58,7 +58,7 @@ You are an expert in C#, Blazor, and scalable web application development. You w
|
|
|
58
58
|
## UI Components — Ignite UI for Blazor
|
|
59
59
|
|
|
60
60
|
- **Packages**: `IgniteUI.Blazor.Lite` for general-purpose components and `IgniteUI.Blazor.GridLite` for the lightweight grid (both MIT, NuGet.org); `IgniteUI.Blazor` — publicly available for evaluation as `IgniteUI.Blazor.Trial` — for feature-rich grids, charts, maps, gauges, and Dock Manager. If the project already references the full `IgniteUI.Blazor`, do not add Lite or GridLite unless the user explicitly chooses to switch package strategy. If no Ignite UI package is present, add the one that matches the chosen strategy.
|
|
61
|
-
- **Setup**: `builder.Services.AddIgniteUIBlazor()` in `Program.cs`, `@using IgniteUI.Blazor.Controls` in `_Imports.razor`, one theme stylesheet
|
|
61
|
+
- **Setup**: `builder.Services.AddIgniteUIBlazor()` in `Program.cs`, `@using IgniteUI.Blazor.Controls` in `_Imports.razor`, and one theme stylesheet in the host page. `IgniteUI.Blazor.Lite` loads its scripts itself (JS initializer); the full `IgniteUI.Blazor`/`.Trial` also needs `_content/IgniteUI.Blazor/app.bundle.js` before the Blazor script in Blazor Web Apps (so the library's client resources initialize correctly there) — never wrapped in `@Assets[...]`.
|
|
62
62
|
- **Do not write Ignite UI component, property, or event names from memory** — the Blazor API differs from the Angular, React, and Web Components products. Use the `skills/` reference files and the `igniteui-cli` MCP server.
|
|
63
63
|
- Prefer the `Async` form of component methods (`ShowAsync()`, not `Show()`); the sync twins require an in-process JS runtime and throw on Blazor Server.
|
|
64
64
|
- Style components with `--ig-*` design tokens on `igc-*` selectors, adding `::deep` in `.razor.css` files. Scope a theme to a page region with `IgbThemeProvider`.
|
|
@@ -10,17 +10,11 @@ Each skill is a `SKILL.md` routing hub with `references/` sub-files. The agent r
|
|
|
10
10
|
|
|
11
11
|
| Skill | Covers |
|
|
12
12
|
|---|---|
|
|
13
|
-
| [`igniteui-blazor-components`](./igniteui-blazor-components/SKILL.md) | Every non-grid component: setup, form controls, layout and navigation, data display, overlays, Tile/Dock Manager,
|
|
13
|
+
| [`igniteui-blazor-components`](./igniteui-blazor-components/SKILL.md) | Every non-grid component: setup, form controls, layout and navigation, data display, overlays, Tile/Dock Manager, charts, gauges, maps, sparklines, and client-side `*Script` templates and handlers |
|
|
14
14
|
| [`igniteui-blazor-grids`](./igniteui-blazor-grids/SKILL.md) | `IgbGridLite`, `IgbGrid`, `IgbTreeGrid`, `IgbHierarchicalGrid`, `IgbPivotGrid` — columns, editing, features, paging and remote data, sizing, state, migration |
|
|
15
15
|
| [`igniteui-blazor-theming`](./igniteui-blazor-theming/SKILL.md) | Built-in themes, `IgbThemeProvider`, palettes, component design tokens, CSS parts, dark mode, layout tokens |
|
|
16
16
|
| [`igniteui-blazor-generate-from-image-design`](./igniteui-blazor-generate-from-image-design/SKILL.md) | End-to-end workflow for implementing a view from a design image; composes the three skills above |
|
|
17
17
|
|
|
18
|
-
## Skill for working *on* this repository
|
|
19
|
-
|
|
20
|
-
| Skill | Covers |
|
|
21
|
-
|---|---|
|
|
22
|
-
| [`igniteui-blazor-lite-testing`](./igniteui-blazor-lite-testing/SKILL.md) | The bUnit unit suite and Playwright integration suite under `tests/`, and how to author interop wire contracts |
|
|
23
|
-
|
|
24
18
|
## MCP servers
|
|
25
19
|
|
|
26
20
|
| Server | Purpose | Key tools |
|
package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/SKILL.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
license: MIT
|
|
3
3
|
name: igniteui-blazor-components
|
|
4
|
-
description: "Ignite UI for Blazor non-grid components: project setup and module registration; form controls (input, textarea, combo, select, date/time pickers, calendar, checkbox, radio, switch, slider, rating, mask input); layout and navigation (tabs, stepper, accordion, expansion panel, nav drawer, navbar, tree, splitter, divider); data display (list, card, carousel, avatar, badge, chip, icon, progress, dropdown, tooltip, chat); overlays (dialog, snackbar, toast, banner); Dock Manager and Tile Manager; and visualizations (charts, gauges, maps, sparklines).
|
|
4
|
+
description: "Covers Ignite UI for Blazor non-grid components: project setup and module registration; form controls (input, textarea, combo, select, date/time pickers, calendar, checkbox, radio, switch, slider, rating, mask input, color picker); layout and navigation (tabs, stepper, accordion, expansion panel, nav drawer, navbar, breadcrumbs, tree, splitter, divider); data display (list, card, carousel, avatar, badge, chip, icon, progress, dropdown, tooltip, chat, QR code); overlays (dialog, snackbar, toast, banner); Dock Manager and Tile Manager; and visualizations (charts, gauges, maps, sparklines). WHEN TO USE: setting up Ignite UI for Blazor, or configuring, binding, or calling any Ignite UI Blazor component that is not a data grid, including client-side *Script templates and handlers. WHEN NOT TO USE: data grids and tables (use igniteui-blazor-grids), themes, palettes, design tokens, or component CSS (use igniteui-blazor-theming), or building a view from a design image (use igniteui-blazor-generate-from-image-design)."
|
|
5
5
|
user-invocable: true
|
|
6
6
|
---
|
|
7
7
|
|
|
@@ -20,12 +20,13 @@ user-invocable: true
|
|
|
20
20
|
| Task | Read |
|
|
21
21
|
|---|---|
|
|
22
22
|
| NuGet install, `Program.cs`, `_Imports.razor`, theme CSS + script tags, project types (Server / WASM / Web App / MAUI), render modes | [`references/setup.md`](./references/setup.md) |
|
|
23
|
-
| Input, Textarea, Combo, Select, Date Picker, Date Range Picker, Calendar, Date Time Input, Mask Input, Checkbox, Radio, Switch, Slider, Range Slider, Rating, value binding | [`references/form-controls.md`](./references/form-controls.md) |
|
|
24
|
-
| Tabs, Stepper, Accordion, Expansion Panel, Nav Drawer, Navbar, Tree, Splitter, Divider | [`references/layout.md`](./references/layout.md) |
|
|
25
|
-
| List, Card, Carousel, Avatar, Badge, Chip, Icon, Icon Button, Button, Button Group, Circular/Linear Progress, Dropdown, Tooltip, Ripple, Chat, Highlight | [`references/data-display.md`](./references/data-display.md) |
|
|
23
|
+
| Input, Textarea, Combo, Select, Date Picker, Date Range Picker, Calendar, Date Time Input, Mask Input, Checkbox, Radio, Switch, Slider, Range Slider, Rating, Color Picker, value binding | [`references/form-controls.md`](./references/form-controls.md) |
|
|
24
|
+
| Tabs, Stepper, Accordion, Expansion Panel, Nav Drawer, Navbar, Breadcrumbs, Tree, Splitter, Divider | [`references/layout.md`](./references/layout.md) |
|
|
25
|
+
| List, Card, Carousel, Avatar, Badge, Chip, Icon, Icon Button, Button, Button Group, Circular/Linear Progress, Dropdown, Tooltip, QR Code, Ripple, Chat, Highlight | [`references/data-display.md`](./references/data-display.md) |
|
|
26
26
|
| Dialog, Snackbar, Toast, Banner | [`references/feedback.md`](./references/feedback.md) |
|
|
27
27
|
| Dock Manager, Tile Manager | [`references/layout-manager.md`](./references/layout-manager.md) |
|
|
28
28
|
| Category / Data / Financial / Pie / Donut charts, Sparkline, Treemap, Geographic Map, Gauges, Dashboard Tile, chart features | [`references/charts.md`](./references/charts.md) |
|
|
29
|
+
| `*Script` parameters: client-side templates, JS event handlers, `registerScript`, `api.js` | [`references/client-scripts.md`](./references/client-scripts.md) |
|
|
29
30
|
|
|
30
31
|
## Packages
|
|
31
32
|
|
|
@@ -40,14 +41,15 @@ All four use the `IgniteUI.Blazor.Controls` namespace and serve static assets fr
|
|
|
40
41
|
|
|
41
42
|
## Rules that apply to every component
|
|
42
43
|
|
|
43
|
-
- **Registration.** `builder.Services.AddIgniteUIBlazor()` in `Program.cs` is required. Passing `typeof(Igb<Name>Module)` arguments eagerly pre-loads exactly those modules; with no arguments every module is available.
|
|
44
|
-
- **Runtime script.** `<script src="_content/IgniteUI.Blazor/app.bundle.js"></script>`
|
|
44
|
+
- **Registration.** `builder.Services.AddIgniteUIBlazor()` in `Program.cs` is required. Passing `typeof(Igb<Name>Module)` arguments eagerly pre-loads exactly those modules; with no arguments every module is available. Components request their own module on first render, so the explicit list is a bundle-size optimization — except for the full product's feature modules that add behavior to a component instead of defining one (`IgbDataChartInteractivityModule`, `IgbDataChartAnnotationModule`, the `*FullModule` bundles): nothing requests those on render, so they must be listed.
|
|
45
|
+
- **Runtime script.** `IgniteUI.Blazor.Lite` loads its component bundle itself (JS initializer, every hosting model). The full `IgniteUI.Blazor`/`IgniteUI.Blazor.Trial` needs `<script src="_content/IgniteUI.Blazor/app.bundle.js"></script>` before the Blazor framework script in **Blazor Web Apps** so the library's client resources initialize correctly. Never wrap it in `@Assets[...]` (fingerprinting it renders the app blank).
|
|
45
46
|
- **Theme CSS.** Exactly one theme stylesheet, e.g. `_content/IgniteUI.Blazor/themes/light/bootstrap.css`.
|
|
46
47
|
- **Slots.** Composition uses named slots (`slot="start"`, `slot="title"`, `slot="footer"`, …), not wrapper components. Use `IgbIcon` inside slots — a font-icon `<span>` is `display: inline` and drifts to the top of the slot's flex box.
|
|
47
48
|
- **`@ref`.** Declare a field of the component type and use `@ref` for programmatic calls (`await dialog.ShowAsync()`). The reference is `null` until after first render. Some components need `await component.EnsureReady()` before their async methods in `OnAfterRenderAsync(firstRender)` — icon registration especially.
|
|
48
49
|
- **Parameters are PascalCase** (`ChartType`, `DataSource`), never Angular-style `[chartType]`.
|
|
49
50
|
- **`Name` is not an HTML name attribute.** On every Ignite UI component `Name` is the framework's element identity used for lookups. Do not use it to group radios or to name a form field.
|
|
50
51
|
- **Forms.** There is no universal form-integration pattern; several components (`IgbCombo`, `IgbRadio`) do not participate in a plain HTML `<form>`. Bind explicitly with `@bind-Value` / `@bind-Checked` and check the component's doc before assuming form behavior.
|
|
52
|
+
- **`*Script` parameters** take the *name* of a JavaScript function registered through `_content/IgniteUI.Blazor/api.js` (Lite) or the `igRegisterScript` window global (full product), not code. Use them for client-side templates (rendered per item in the browser, no server round trip). For events prefer the C# event; the script variant is for synchronous cancellation or purely client-side reactions. See [`client-scripts.md`](./references/client-scripts.md).
|
|
51
53
|
- **Dynamic `class` values** must be a single C# expression (`class="@ChipClass(item)"`). Mixing literal text with `@(...)` in one attribute raises **RZ9986**.
|
|
52
54
|
|
|
53
55
|
## MCP server (optional)
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# Client Scripts — `*Script` Parameters
|
|
2
|
+
|
|
3
|
+
Every component parameter ending in `Script` takes the **name** of a JavaScript function registered on the client, not code. Two kinds exist:
|
|
4
|
+
|
|
5
|
+
**Package scope.** The `api.js` module ships with `IgniteUI.Blazor.Lite`. The full product (`IgniteUI.Blazor` / `IgniteUI.Blazor.Trial`, grids, charts, Dock Manager) does not ship it yet: register there through the `igRegisterScript(name, fn, shouldCall)` window global, which its `app.bundle.js` script tag installs. Its `shouldCall` defaults to `true`, so pass `false` for handlers and templates.
|
|
6
|
+
|
|
7
|
+
| Kind | Examples | Function receives | Returns |
|
|
8
|
+
|---|---|---|---|
|
|
9
|
+
| Template | `ItemTemplateScript`, `GroupHeaderTemplateScript`, `MessageHeaderScript`, … | a context object | an `html` template result, a string, a primitive — anything lit can render |
|
|
10
|
+
| Event handler | `ChangeScript`, `ClosingScript`, `FocusScript`, … — one per C# event | the DOM `CustomEvent` | nothing |
|
|
11
|
+
|
|
12
|
+
## Registering
|
|
13
|
+
|
|
14
|
+
```html
|
|
15
|
+
<script type="module" src="my-scripts.js"></script>
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
```js
|
|
19
|
+
// wwwroot/my-scripts.js
|
|
20
|
+
import { registerScript, html } from './_content/IgniteUI.Blazor/api.js';
|
|
21
|
+
|
|
22
|
+
registerScript('CityItem', ({ item }) => html`<b>${item.Name}</b> <small>${item.Country}</small>`);
|
|
23
|
+
|
|
24
|
+
registerScript('OnDialogClosing', (evt) => {
|
|
25
|
+
if (!confirm('Discard changes?')) {
|
|
26
|
+
evt.preventDefault();
|
|
27
|
+
}
|
|
28
|
+
});
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
- The specifier is relative to the importing script's own URL: `./_content/…` from a script at the wwwroot root, `../_content/…` from a subfolder. A classic script's `import()` resolves it against the document base.
|
|
32
|
+
- **Register at the top level of a `type="module"` script, or any time before Blazor starts.** Module scripts run once the page is parsed, while Blazor still has to fetch the component bundle before it can render, so registrations from a page-level module script are in place in time. If a registration ever lands after a component rendered, the library logs a console warning naming the script (late registration is not retried yet). For a hard guarantee, register from the app's own JS initializer (`beforeWebStart`).
|
|
33
|
+
- The registered function is the script. For the few parameters that take a *value* rather than a function (e.g. `DataScript`), pass `true` as the third argument (`shouldCall`): the function is then called once when the parameter resolves and its result is used. The deprecated `igRegisterScript` global defaults that argument to `true` instead.
|
|
34
|
+
- Other exports: `removeScript(name)`, and `html` — the lit-html template tag, the same instance the components render with. Typings ship at `_content/IgniteUI.Blazor/api.d.ts`.
|
|
35
|
+
- From a classic (non-module) script use a dynamic import (no top-level `await` there): `import('./_content/IgniteUI.Blazor/api.js').then(({ registerScript, html }) => { /* register */ });`
|
|
36
|
+
- The `igRegisterScript` / `igRemoveScript` / `igTemplating.html` window globals still work with the same signatures once the library has loaded, but are deprecated and warn in the console. A classic script that calls them while the page parses (before Blazor starts) needs the `<script src="_content/IgniteUI.Blazor/app.bundle.js">` tag, which queues those calls until `api.js` loads; without the tag, move the call to a module script.
|
|
37
|
+
|
|
38
|
+
## Templates
|
|
39
|
+
|
|
40
|
+
A template function receives one context object and returns an `html` template result, a string, a primitive value — anything lit can render. `html` is only needed for markup; plain text can be returned directly, and an empty string renders nothing.
|
|
41
|
+
|
|
42
|
+
The context mirrors the component's .NET template context: the same data is exposed under the same names — the item for a list item, the message for a chat message — so start from the component's C# template context type when writing one.
|
|
43
|
+
|
|
44
|
+
```razor
|
|
45
|
+
<IgbCombo T="City" Data="Cities" ValueKey="Id" DisplayKey="Name" GroupKey="Country"
|
|
46
|
+
ItemTemplateScript="CityItem" GroupHeaderTemplateScript="CountryHeader" />
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
```js
|
|
50
|
+
registerScript('CityItem', ({ item }) => html`
|
|
51
|
+
<b>${item.Name}</b>
|
|
52
|
+
<small>${item.Country}</small>
|
|
53
|
+
`);
|
|
54
|
+
|
|
55
|
+
registerScript('CountryHeader', ({ item }) => `🌍 ${item.Country}`);
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
```razor
|
|
59
|
+
<IgbChat Options="ChatOptions" />
|
|
60
|
+
|
|
61
|
+
@code {
|
|
62
|
+
private IgbChatOptions ChatOptions = new()
|
|
63
|
+
{
|
|
64
|
+
CurrentUserId = "user",
|
|
65
|
+
Renderers = new IgbChatRenderers { MessageHeaderScript = "AgentHeader" }
|
|
66
|
+
};
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
```js
|
|
71
|
+
registerScript('AgentHeader', ({ message }) => {
|
|
72
|
+
if (message.sender === 'user') {
|
|
73
|
+
return '';
|
|
74
|
+
}
|
|
75
|
+
return html`
|
|
76
|
+
<div style="display: flex; align-items: center; gap: 8px;">
|
|
77
|
+
<igc-avatar shape="circle" src="/agent.jpg"></igc-avatar>
|
|
78
|
+
<b>Support Agent</b>
|
|
79
|
+
</div>
|
|
80
|
+
`;
|
|
81
|
+
});
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
`html` is the Lit HTML template tag: `${}` interpolates values, `@click=${fn}` binds listeners, and so on. Ignite UI web components (`<igc-avatar>`, `<igc-icon-button>`, …) work inside a template as long as the custom element is defined: registering the module (`AddIgniteUIBlazor(typeof(IgbAvatarModule), …)` in `Program.cs`) defines it, as does using the corresponding Blazor component anywhere in the app. Without either, `<igc-avatar>` is an undefined element and renders nothing.
|
|
85
|
+
|
|
86
|
+
## Event handler scripts
|
|
87
|
+
|
|
88
|
+
```razor
|
|
89
|
+
<IgbDialog ClosingScript="OnDialogClosing">…</IgbDialog>
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
```js
|
|
93
|
+
registerScript('OnDialogClosing', (evt) => {
|
|
94
|
+
if (!confirm('Discard changes?')) {
|
|
95
|
+
evt.preventDefault(); // igcClosing is cancelable
|
|
96
|
+
}
|
|
97
|
+
});
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
The function is attached as a listener for the matching `igc*` DOM event on the component's element. `evt.detail` holds the event arguments where the event has any; cancelable events (`Opening`/`Closing` on dialogs, dropdowns and the like, `ActiveStepChanging` on the stepper, tree expand/collapse and selection changes, `Change` on some inputs) are cancelled with `evt.preventDefault()`.
|
|
@@ -93,13 +93,14 @@ The parameter is **`IconName`**, not `Name` (`Name` is the framework element ide
|
|
|
93
93
|
<IgbIcon slot="start" IconName="star" Collection="material" />
|
|
94
94
|
Blazor
|
|
95
95
|
</IgbChip>
|
|
96
|
+
<IgbChip Outlined="true" Variant="StyleVariant.Primary">Outlined</IgbChip>
|
|
96
97
|
|
|
97
98
|
@code {
|
|
98
|
-
void OnChipRemoved(
|
|
99
|
+
void OnChipRemoved(IgbVoidEventArgs e) { }
|
|
99
100
|
}
|
|
100
101
|
```
|
|
101
102
|
|
|
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.
|
|
103
|
+
`AvatarShape`: `Circle | Rounded | Square` — use `Shape`, there is no `RoundShape`. `StyleVariant` (shared by badge and chip): `Primary | Info | Success | Warning | Danger`. `IgbChip` also has `Outlined`, `Selected` / `SelectedChanged` and a `Select` event.
|
|
103
104
|
|
|
104
105
|
## Progress
|
|
105
106
|
|
|
@@ -138,6 +139,28 @@ The trigger goes in `slot="target"`. `IgbDropdownGroup` groups items; `Placement
|
|
|
138
139
|
|
|
139
140
|
`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.
|
|
140
141
|
|
|
142
|
+
## QR Code
|
|
143
|
+
|
|
144
|
+
```razor
|
|
145
|
+
<IgbQrCode Value="https://www.infragistics.com" Size="192" />
|
|
146
|
+
|
|
147
|
+
<IgbQrCode Value="https://www.infragistics.com" Size="256"
|
|
148
|
+
ErrorLevel="QrErrorCorrectionLevel.Quartile"
|
|
149
|
+
DotStyle="QrDotStyle.Rounded" SquareStyle="QrCornerSquareStyle.Rounded"
|
|
150
|
+
LogoSrc="images/logo.svg" LogoSize="0.6" />
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
Renders the `Value` string (URL, text, any payload) as a scannable SVG. `Version` (1-40) is chosen automatically when unset; `ErrorLevel` (`Low | Medium | Quartile | High`) defaults to `Medium` and should be raised explicitly when a larger logo needs more error correction. `Size` is the rendered pixel size and `Margin` the quiet zone in modules; `LogoSrc`, `LogoSize` and `LogoMargin` place a centered logo. Color it with the `--ig-qr-code-background`, `--ig-qr-code-dark-color`, `--ig-qr-code-corner-square-color` and `--ig-qr-code-corner-dot-color` custom properties.
|
|
154
|
+
|
|
155
|
+
`ToImageAsync(IgbQrCodeExportOptions)` exports the code as an image file (`Format`: `Svg | Png | Jpeg | Webp`, default `Png`; `Scale` multiplies `Size`; `FileName` defaults to `qr-code`). The exported file stays on the client and is always handed to the user through the browser save dialog — there is no way to read the file bytes back into .NET. The export fails when the component has no `Value`.
|
|
156
|
+
|
|
157
|
+
```razor
|
|
158
|
+
<IgbQrCode @ref="Qr" Value="https://www.infragistics.com" Size="192" />
|
|
159
|
+
<IgbButton @onclick='() => Qr!.ToImageAsync(new IgbQrCodeExportOptions { Format = QrCodeExportFormat.Png, Scale = 2 })'>Download</IgbButton>
|
|
160
|
+
|
|
161
|
+
@code { IgbQrCode? Qr; }
|
|
162
|
+
```
|
|
163
|
+
|
|
141
164
|
## Ripple, Highlight, Chat
|
|
142
165
|
|
|
143
166
|
```razor
|
|
@@ -124,6 +124,26 @@ Radios are grouped by being children of `IgbRadioGroup`, and the selected option
|
|
|
124
124
|
|
|
125
125
|
`Min`, `Max`, `Step`, `LowerBound`, `UpperBound`, `PrimaryTicks`, `SecondaryTicks`, `DiscreteTrack` and the label/tooltip options come from the shared slider base and apply to both sliders. `IgbRangeSlider` uses `Lower` / `Upper` instead of `Value`. `IgbRating.Value` and `IgbSlider.Value` are `double`.
|
|
126
126
|
|
|
127
|
+
## Color Picker
|
|
128
|
+
|
|
129
|
+
```razor
|
|
130
|
+
<IgbColorPicker @bind-Value="Background" Label="Background" />
|
|
131
|
+
|
|
132
|
+
<IgbColorPicker @bind-Value="Accent" Label="Accent"
|
|
133
|
+
Mode="ColorPickerMode.Input" Format="ColorFormat.Rgb"
|
|
134
|
+
ShowAlpha="true" Swatches="Palette" />
|
|
135
|
+
|
|
136
|
+
@code {
|
|
137
|
+
string? Background { get; set; } = "#875fc4";
|
|
138
|
+
string? Accent { get; set; }
|
|
139
|
+
static readonly string[] Palette = ["#e91e63", "#3f51b5", "#009688"];
|
|
140
|
+
}
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
An HSV canvas with hue and alpha sliders, an editable color string, preset swatches, and the native EyeDropper where the browser has one. `Value` is a CSS color string (hex, `rgb(a)`, `hsl(a)`, or a named color); an empty or invalid string clears it. `Format` (`Hex | Rgb | Hsl`) changes only the notation, not the color, and `HideFormats` drops the format switcher. `Mode` is `Default` (trigger button) or `Input` (editable text field with a swatch prefix).
|
|
144
|
+
|
|
145
|
+
`Input` fires on every color change while `Change` fires on commit and drives `@bind-Value`; `Opening` / `Opened` / `Closing` / `Closed` track the picker surface. `Required`, `Disabled`, `Invalid` plus `CheckValidityAsync()` / `ReportValidityAsync()` / `SetCustomValidityAsync(message)` behave as on the other form controls.
|
|
146
|
+
|
|
127
147
|
## Binding and validation
|
|
128
148
|
|
|
129
149
|
```razor
|
|
@@ -92,6 +92,20 @@ Tab headers come from the `Label` string or from children in the `label` slot; e
|
|
|
92
92
|
|
|
93
93
|
Purely slot-driven: `start`, default (title), `end`. Icons must be registered before they display — see [`data-display.md`](./data-display.md).
|
|
94
94
|
|
|
95
|
+
## Breadcrumbs
|
|
96
|
+
|
|
97
|
+
```razor
|
|
98
|
+
<nav aria-label="Breadcrumb">
|
|
99
|
+
<IgbBreadcrumbs Separator="chevron_right">
|
|
100
|
+
<IgbBreadcrumb><a href="/">Home</a></IgbBreadcrumb>
|
|
101
|
+
<IgbBreadcrumb><a href="/products">Products</a></IgbBreadcrumb>
|
|
102
|
+
<IgbBreadcrumb Current="true"><a href="/products/laptop">Laptop</a></IgbBreadcrumb>
|
|
103
|
+
</IgbBreadcrumbs>
|
|
104
|
+
</nav>
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
`IgbBreadcrumbs` is the ARIA `list`; wrap it in `<nav aria-label="...">` — the label belongs on the landmark, not on the list. `Separator` is an icon name from the built-in `default` collection (`tree_expand` when unset, e.g. `chevron_right`, `arrow_next`), and no icon registration is needed for those. Each `IgbBreadcrumb` takes its content, usually an anchor, in the default slot, plus `prefix` / `suffix` slots and a `separator` slot that replaces the icon after that one item. `Current` sets `aria-current="page"`; `Disabled` sets `aria-disabled` and takes the slotted link out of the tab sequence. There are no events — handle navigation on the anchors.
|
|
108
|
+
|
|
95
109
|
## Navigation Drawer
|
|
96
110
|
|
|
97
111
|
```razor
|
|
@@ -182,5 +196,5 @@ Width comes from the `--menu-full-width` custom property (default `15rem`); the
|
|
|
182
196
|
<IgbDivider LineType="DividerType.Solid" Middle="true" />
|
|
183
197
|
```
|
|
184
198
|
|
|
185
|
-
`IgbSplitter`: `Orientation`, `StartSize` / `EndSize`, `StartMinSize` / `StartMaxSize` / `EndMinSize` / `EndMaxSize`, `DisableResize`, `DisableCollapse`, `HideDragHandle`, `HideCollapseButtons`, `ToggleAsync(PanePosition)`.
|
|
199
|
+
`IgbSplitter`: `Orientation`, `StartSize` / `EndSize`, `StartMinSize` / `StartMaxSize` / `EndMinSize` / `EndMaxSize` (all CSS lengths — `280px`, `30%`), `StartCollapsed` / `EndCollapsed`, `DisableResize`, `DisableCollapse`, `HideDragHandle`, `HideCollapseButtons`, `ToggleAsync(PanePosition)`. `LayoutChanged` fires after a user resize or collapse with a full snapshot (`StartSize`, `EndSize`, `StartCollapsed`, `EndCollapsed`); `ResizeStart` / `Resizing` / `ResizeEnd` report pixel sizes during a drag.
|
|
186
200
|
`IgbDivider`: `Vertical`, `Middle`, `LineType`.
|
|
@@ -35,7 +35,7 @@ builder.Services.AddIgniteUIBlazor(
|
|
|
35
35
|
typeof(IgbInputModule), typeof(IgbComboModule), typeof(IgbDialogModule));
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
Module names always follow `Igb{ComponentName}Module`.
|
|
38
|
+
Module names always follow `Igb{ComponentName}Module`. A component requests its own module on first render, so the explicit list trims the initial payload rather than gating rendering. The exception is the full product's feature modules, which add behavior to a component instead of defining one (`IgbDataChartInteractivityModule`, `IgbDataChartAnnotationModule`) and the `*FullModule` bundles that include them: nothing requests those on render, so they must be listed.
|
|
39
39
|
|
|
40
40
|
**Blazor Web App:** call `AddIgniteUIBlazor()` in **both** the server and the client `Program.cs`.
|
|
41
41
|
|
|
@@ -62,14 +62,24 @@ Add it to both `_Imports.razor` files in split Blazor Web App solutions.
|
|
|
62
62
|
|
|
63
63
|
Host page is `wwwroot/index.html` (WASM/MAUI), `Pages/_Host.cshtml` (Server), or `Components/App.razor` (Web App).
|
|
64
64
|
|
|
65
|
+
For `IgniteUI.Blazor.Lite` the theme stylesheet is the only required tag — without it components render unstyled. The full product also needs a script tag in Blazor Web Apps so the library's client resources initialize correctly (below).
|
|
66
|
+
|
|
65
67
|
```html
|
|
66
68
|
<link href="_content/IgniteUI.Blazor/themes/light/bootstrap.css" rel="stylesheet" />
|
|
67
69
|
...
|
|
68
|
-
<script src="_content/IgniteUI.Blazor/app.bundle.js"></script>
|
|
69
70
|
<script src="_framework/blazor.web.js"></script> <!-- or blazor.server.js / blazor.webassembly.js / blazor.webview.js -->
|
|
70
71
|
```
|
|
71
72
|
|
|
72
|
-
|
|
73
|
+
**`IgniteUI.Blazor.Lite` (≥ 0.1.0) loads its component bundle itself** — a JS initializer runs during Blazor startup on every hosting model: Blazor Server, standalone WASM, Blazor Web App (`blazor.web.js`, any render mode), and BlazorWebView/Hybrid.
|
|
74
|
+
|
|
75
|
+
**The full product (`IgniteUI.Blazor` / `IgniteUI.Blazor.Trial`) currently needs the tag in Blazor Web Apps** so its client resources initialize correctly. There the tag must come **before** the Blazor framework script; classic Blazor Server and standalone WASM apps on the full product may omit it.
|
|
76
|
+
|
|
77
|
+
```html
|
|
78
|
+
<script src="_content/IgniteUI.Blazor/app.bundle.js"></script> <!-- full product, Blazor Web App only -->
|
|
79
|
+
<script src="_framework/blazor.web.js"></script>
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
On the full product, **never wrap that tag in `@Assets[...]`** — fingerprinting it breaks loading and the app renders blank ([#233](https://github.com/IgniteUI/igniteui-blazor/issues/233)). On `IgniteUI.Blazor.Lite`, an existing tag — fingerprinted or not — is a harmless no-op kept for compatibility.
|
|
73
83
|
|
|
74
84
|
Theme files under `_content/IgniteUI.Blazor/themes/` are `{light|dark}/{bootstrap|material|fluent|indigo}.css` — link exactly one.
|
|
75
85
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
license: MIT
|
|
3
3
|
name: igniteui-blazor-generate-from-image-design
|
|
4
|
-
description: "
|
|
4
|
+
description: "Implements a Blazor view from a design image, screenshot, mockup, or wireframe using Ignite UI for Blazor components: analyzes the image, maps regions to components, generates a matching theme, builds the view with mock data, and refines it until it matches. WHEN TO USE: a design image is provided with a request to implement this design, build this UI, convert this mockup, or create a page from this image in an Ignite UI Blazor project. WHEN NOT TO USE: no image is provided and the user needs a single component (use igniteui-blazor-components) or a grid (use igniteui-blazor-grids), or the task is only theming or restyling existing views (use igniteui-blazor-theming)."
|
|
5
5
|
user-invocable: true
|
|
6
6
|
---
|
|
7
7
|
|
|
@@ -45,7 +45,7 @@ Start every region with the most appropriate Ignite UI component. Fall back to p
|
|
|
45
45
|
|
|
46
46
|
There are no separate DV packages. If a required package is missing from the project, identify the right package and version and **ask before editing the `.csproj`**.
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
Call `builder.Services.AddIgniteUIBlazor()` in `Program.cs`. Components request their own module on first render, so listing `typeof(Igb<Name>Module)` arguments only pre-loads them. The exception is the full `IgniteUI.Blazor`/`.Trial`'s feature modules, which add behavior to a component instead of defining one (`IgbDataChartInteractivityModule`, `IgbDataChartAnnotationModule`) and the `*FullModule` bundles that include them: nothing requests those on render, so they must be listed. Add `@using IgniteUI.Blazor.Controls` to `_Imports.razor`, and confirm the theme stylesheet is in the host page (on `IgniteUI.Blazor`/`.Trial` in a Blazor Web App, also the `_content/IgniteUI.Blazor/app.bundle.js` script tag before the Blazor script — so the library's client resources initialize correctly; `IgniteUI.Blazor.Lite` needs no tag) — see the components skill's [`setup.md`](../igniteui-blazor-components/references/setup.md).
|
|
49
49
|
|
|
50
50
|
## Step 3 — Theme
|
|
51
51
|
|
|
@@ -8,6 +8,7 @@ A selection reference, not an API reference. Confirm exact parameters with `get_
|
|
|
8
8
|
|---|---|---|
|
|
9
9
|
| Top horizontal bar with brand, actions | `IgbNavbar` | slots `start` / default / `end`; use a plain `<header>` if the slot structure fights the design |
|
|
10
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
|
+
| Breadcrumb trail (Home › Section › Page) | `IgbBreadcrumbs` + `IgbBreadcrumb` | wrap in `<nav aria-label>`; anchors as item content; `Current` on the last item; `Separator` icon name |
|
|
11
12
|
| Tab strip switching content | `IgbTabs` + `IgbTab` | header via `Label` or the `label` slot; there is no `IgbTabPanel` |
|
|
12
13
|
| Collapsible sections | `IgbExpansionPanel`, or `IgbAccordion` when only one opens at a time | |
|
|
13
14
|
| Step-by-step wizard | `IgbStepper` + `IgbStep` | `Orientation`, `Linear` |
|
|
@@ -33,6 +34,7 @@ A selection reference, not an API reference. Confirm exact parameters with `get_
|
|
|
33
34
|
| Carousel / slideshow | `IgbCarousel` + `IgbCarouselSlide` | `Interval`, `AnimationType` |
|
|
34
35
|
| Highlighted search matches in text | `IgbHighlight` | `SearchText`, `CaseSensitive` |
|
|
35
36
|
| Chat / conversation surface | `IgbChat` | configured through `IgbChatOptions` |
|
|
37
|
+
| QR code | `IgbQrCode` | `Value` (encoded payload), `Size`, `ErrorLevel`, `DotStyle`, `LogoSrc` |
|
|
36
38
|
|
|
37
39
|
Use `IgbList` when its row anatomy and keyboard behavior fit; native `<ul>/<li>` when they do not.
|
|
38
40
|
|
|
@@ -65,6 +67,7 @@ Only pick a grid when the content is genuinely tabular. A list of records with r
|
|
|
65
67
|
| Radio options | `IgbRadioGroup` + `IgbRadio` | `@bind-Value` on the **group**; do not use `Name` to group |
|
|
66
68
|
| Slider / range slider | `IgbSlider` / `IgbRangeSlider` | range uses `Lower` / `Upper` |
|
|
67
69
|
| Star rating | `IgbRating` | |
|
|
70
|
+
| Color picker / color swatch input | `IgbColorPicker` | `@bind-Value` (CSS color string), `Mode` (`Default` trigger / `Input` field), `Format`, `ShowAlpha`, `Swatches` |
|
|
68
71
|
| Primary action button | `IgbButton` | `Variant`: `Contained`/`Outlined`/`Flat`/`Fab` |
|
|
69
72
|
| Segmented / toggle control | `IgbButtonGroup` + `IgbToggleButton` | |
|
|
70
73
|
| Icon-only button | `IgbIconButton` | |
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
license: MIT
|
|
3
3
|
name: igniteui-blazor-grids
|
|
4
|
-
description: "
|
|
4
|
+
description: "Covers all Ignite UI for Blazor data grids (Grid Lite, Flat Grid, Tree Grid, Hierarchical Grid, Pivot Grid): setup, columns and templates, sorting, filtering, selection, cell and row editing, grouping, summaries, toolbar, Excel/CSV export, paging, remote and server-side data, virtualization, sizing, state persistence, and migrating Grid Lite to IgbGrid. WHEN TO USE: grids, tables, tabular data, cell editing, row selection, column pinning or hiding, grouped rows, pivot tables, tree or hierarchical data, master-detail views, grid export, or choosing a grid type. WHEN NOT TO USE: non-grid components such as lists, the tree view, or charts (use igniteui-blazor-components), grid colors, themes, or design tokens (use igniteui-blazor-theming), or building a whole view from a design image (use igniteui-blazor-generate-from-image-design)."
|
|
5
5
|
user-invocable: true
|
|
6
6
|
---
|
|
7
7
|
|
|
@@ -61,7 +61,7 @@ Grids are **not** included in `IgniteUI.Blazor.Lite`.
|
|
|
61
61
|
| Using directive | `@using IgniteUI.Blazor.Controls` in `_Imports.razor` |
|
|
62
62
|
| CSS — full grids | **both** `_content/IgniteUI.Blazor/themes/light/bootstrap.css` **and** `_content/IgniteUI.Blazor/themes/grid/light/bootstrap.css` |
|
|
63
63
|
| CSS — Grid Lite | `_content/IgniteUI.Blazor.GridLite/css/themes/light/bootstrap.css` only — not the two above |
|
|
64
|
-
| Script | `_content/IgniteUI.Blazor/app.bundle.js` before the Blazor framework script |
|
|
64
|
+
| Script | None for `IgniteUI.Blazor.GridLite`; full grids (`IgniteUI.Blazor`/`.Trial`) need `_content/IgniteUI.Blazor/app.bundle.js` before the Blazor framework script in Blazor Web Apps (so the library's client resources initialize correctly there) — never wrapped in `@Assets[...]` |
|
|
65
65
|
|
|
66
66
|
The grid-specific stylesheet is easy to miss and is required whenever any full-featured grid is on the page. Full setup detail lives in the components skill's [`setup.md`](../igniteui-blazor-components/references/setup.md).
|
|
67
67
|
|
package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-theming/SKILL.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
license: MIT
|
|
3
3
|
name: igniteui-blazor-theming
|
|
4
|
-
description: "
|
|
4
|
+
description: "Covers theming and visual customization for Ignite UI for Blazor: choosing and switching the built-in Bootstrap, Material, Fluent and Indigo themes in light or dark, scoping a theme to part of the page with IgbThemeProvider, generating palettes and component design tokens with the igniteui-theming MCP server, overriding CSS custom properties, CSS shadow parts, dark mode, and global roundness, spacing and size tokens. WHEN TO USE: changing the look and feel of Ignite UI Blazor components, applying a color scheme or brand palette, switching themes at runtime, or writing component CSS in app.css or .razor.css files. WHEN NOT TO USE: component configuration, parameters, or events, or styling charts, maps, and gauges, which have no design tokens (use igniteui-blazor-components), grid data features (use igniteui-blazor-grids), or building a whole view from a design image (use igniteui-blazor-generate-from-image-design, which applies this skill)."
|
|
5
5
|
user-invocable: true
|
|
6
6
|
---
|
|
7
7
|
|
|
@@ -33,7 +33,6 @@ Link exactly **one** stylesheet in the host page; loading two conflicts.
|
|
|
33
33
|
```html
|
|
34
34
|
<link href="_content/IgniteUI.Blazor/themes/light/bootstrap.css" rel="stylesheet" />
|
|
35
35
|
<link href="css/app.css" rel="stylesheet" /> <!-- your overrides, after -->
|
|
36
|
-
<script src="_content/IgniteUI.Blazor/app.bundle.js"></script>
|
|
37
36
|
```
|
|
38
37
|
|
|
39
38
|
Paths are `_content/IgniteUI.Blazor/themes/{light|dark}/{bootstrap|material|fluent|indigo}.css`. Any full-featured grid needs the grid stylesheet in the same variant as well (`themes/grid/light/bootstrap.css`); `IgbGridLite` uses its own package path instead.
|
|
@@ -7,7 +7,6 @@ Eight stylesheets under `_content/IgniteUI.Blazor/themes/`: `{light|dark}/{boots
|
|
|
7
7
|
```html
|
|
8
8
|
<link href="_content/IgniteUI.Blazor/themes/light/bootstrap.css" rel="stylesheet" />
|
|
9
9
|
<link href="css/app.css" rel="stylesheet" />
|
|
10
|
-
<script src="_content/IgniteUI.Blazor/app.bundle.js"></script>
|
|
11
10
|
```
|
|
12
11
|
|
|
13
12
|
.NET 9+ Web App projects can use the fingerprinted asset collection:
|
package/templates/react/igr-ts/breadcrumbs/default/files/src/app/__path__/__filePrefix__.test.tsx
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { beforeAll, expect, test } from 'vitest';
|
|
2
|
+
import { render } from '@testing-library/react';
|
|
3
|
+
import $(ClassName) from './$(path)';
|
|
4
|
+
import { setupTestMocks } from '../../setupTests';
|
|
5
|
+
|
|
6
|
+
beforeAll(() => {
|
|
7
|
+
setupTestMocks();
|
|
8
|
+
})
|
|
9
|
+
|
|
10
|
+
test('renders $(ClassName) component', () => {
|
|
11
|
+
const wrapper = render(<$(ClassName) />);
|
|
12
|
+
expect(wrapper).toBeTruthy();
|
|
13
|
+
});
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import style from './style.module.css';
|
|
2
|
+
import { IgrBreadcrumbs, IgrBreadcrumb } from 'igniteui-react';
|
|
3
|
+
import 'igniteui-webcomponents/themes/light/bootstrap.css';
|
|
4
|
+
|
|
5
|
+
export default function $(ClassName)() {
|
|
6
|
+
return (
|
|
7
|
+
<div>
|
|
8
|
+
<h1 className={style.title}>Breadcrumbs</h1>
|
|
9
|
+
<div className={style.container}>
|
|
10
|
+
<nav aria-label="Breadcrumb">
|
|
11
|
+
<IgrBreadcrumbs>
|
|
12
|
+
<IgrBreadcrumb><a href="#">Home</a></IgrBreadcrumb>
|
|
13
|
+
<IgrBreadcrumb><a href="#">Products</a></IgrBreadcrumb>
|
|
14
|
+
<IgrBreadcrumb current={true}><a href="#">Ignite UI for React</a></IgrBreadcrumb>
|
|
15
|
+
</IgrBreadcrumbs>
|
|
16
|
+
</nav>
|
|
17
|
+
</div>
|
|
18
|
+
</div>
|
|
19
|
+
);
|
|
20
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const IgniteUIForReactTemplate_1 = require("../../../../../lib/templates/IgniteUIForReactTemplate");
|
|
4
|
+
const constants_1 = require("../../constants");
|
|
5
|
+
class IgrBreadcrumbsTemplate extends IgniteUIForReactTemplate_1.IgniteUIForReactTemplate {
|
|
6
|
+
constructor() {
|
|
7
|
+
super(__dirname);
|
|
8
|
+
this.components = ["Breadcrumbs"];
|
|
9
|
+
this.controlGroup = "Menus";
|
|
10
|
+
this.listInComponentTemplates = true;
|
|
11
|
+
this.id = "breadcrumbs";
|
|
12
|
+
this.projectType = "igr-ts";
|
|
13
|
+
this.name = "Breadcrumbs";
|
|
14
|
+
this.description = "basic IgrBreadcrumbs";
|
|
15
|
+
this.packages = [constants_1.IGNITEUI_REACT_PACKAGE];
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
module.exports = new IgrBreadcrumbsTemplate();
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const cli_core_1 = require("@igniteui/cli-core");
|
|
4
|
+
class IgrBreadcrumbsComponent extends cli_core_1.BaseComponent {
|
|
5
|
+
constructor() {
|
|
6
|
+
super(__dirname);
|
|
7
|
+
this.name = "Breadcrumbs";
|
|
8
|
+
this.group = "Menus";
|
|
9
|
+
this.description = `shows the current page location within a navigational hierarchy`;
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
module.exports = new IgrBreadcrumbsComponent();
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
const IgniteUIForReactTemplate_1 = require("../../../../../lib/templates/IgniteUIForReactTemplate");
|
|
4
|
+
const constants_1 = require("../../constants");
|
|
4
5
|
class IgrTsBulletGraphTemplate extends IgniteUIForReactTemplate_1.IgniteUIForReactTemplate {
|
|
5
6
|
constructor() {
|
|
6
7
|
super(__dirname);
|
|
@@ -11,7 +12,7 @@ class IgrTsBulletGraphTemplate extends IgniteUIForReactTemplate_1.IgniteUIForRea
|
|
|
11
12
|
this.projectType = "igr-ts";
|
|
12
13
|
this.name = "Bullet Graph";
|
|
13
14
|
this.description = `allows for a linear and concise view of measures compared against a scale.`;
|
|
14
|
-
this.packages = [
|
|
15
|
+
this.packages = [constants_1.IGNITEUI_REACT_GAUGES_PACKAGE];
|
|
15
16
|
}
|
|
16
17
|
}
|
|
17
18
|
module.exports = new IgrTsBulletGraphTemplate();
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
const IgniteUIForReactTemplate_1 = require("../../../../../lib/templates/IgniteUIForReactTemplate");
|
|
4
|
+
const constants_1 = require("../../constants");
|
|
4
5
|
class IgrTsCategoryChartTemplate extends IgniteUIForReactTemplate_1.IgniteUIForReactTemplate {
|
|
5
6
|
constructor() {
|
|
6
7
|
super(__dirname);
|
|
@@ -12,7 +13,7 @@ class IgrTsCategoryChartTemplate extends IgniteUIForReactTemplate_1.IgniteUIForR
|
|
|
12
13
|
this.name = "Category Chart";
|
|
13
14
|
this.description = `makes visualizing category data easy. Simplifies the complexities
|
|
14
15
|
of the data visualization domain into manageable API`;
|
|
15
|
-
this.packages = [
|
|
16
|
+
this.packages = [constants_1.IGNITEUI_REACT_CHARTS_PACKAGE];
|
|
16
17
|
}
|
|
17
18
|
}
|
|
18
19
|
module.exports = new IgrTsCategoryChartTemplate();
|
|
@@ -5,7 +5,7 @@ class IgrChatComponent extends cli_core_1.BaseComponent {
|
|
|
5
5
|
constructor() {
|
|
6
6
|
super(__dirname);
|
|
7
7
|
this.name = "Chat";
|
|
8
|
-
this.group = "
|
|
8
|
+
this.group = "Interactions";
|
|
9
9
|
this.description = `a chat UI component for displaying messages, attachments and input interaction`;
|
|
10
10
|
}
|
|
11
11
|
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { beforeAll, expect, test } from 'vitest';
|
|
2
|
+
import { render } from '@testing-library/react';
|
|
3
|
+
import $(ClassName) from './$(path)';
|
|
4
|
+
import { setupTestMocks } from '../../setupTests';
|
|
5
|
+
|
|
6
|
+
beforeAll(() => {
|
|
7
|
+
setupTestMocks();
|
|
8
|
+
})
|
|
9
|
+
|
|
10
|
+
test('renders $(ClassName) component', () => {
|
|
11
|
+
const wrapper = render(<$(ClassName) />);
|
|
12
|
+
expect(wrapper).toBeTruthy();
|
|
13
|
+
});
|