igniteui-cli 15.8.0 → 15.8.2
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/igniteui-blazor-components/references/client-scripts.md +7 -7
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/form-controls.md +65 -18
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/setup.md +1 -1
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-generate-from-image-design/references/component-mapping.md +5 -5
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-generate-from-image-design/references/gotchas.md +23 -4
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/editing.md +4 -3
- package/templates/react/igr-ts/constants.d.ts +1 -1
- package/templates/react/igr-ts/constants.js +1 -1
- package/templates/webcomponents/igc-ts/constants.d.ts +1 -1
- package/templates/webcomponents/igc-ts/constants.js +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 +15 -15
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-choose-components/SKILL.md +36 -36
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-choose-components/reference/mcp-setup.md +8 -6
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-customize-component-theme/SKILL.md +62 -60
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-customize-component-theme/references/mcp-setup.md +8 -6
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/SKILL.md +107 -94
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/asset-extraction.md +32 -32
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/design-provenance.md +32 -30
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/design-token-bridge.md +84 -71
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/figma-component-map.md +45 -44
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/figma-exploration.md +57 -51
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/mcp-setup.md +23 -23
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/project-setup.md +28 -26
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/theme-generation.md +45 -35
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/validation-patterns.md +38 -29
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-generate-from-image-design/SKILL.md +63 -63
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-generate-from-image-design/references/component-mapping.md +12 -12
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-generate-from-image-design/references/gotchas.md +24 -24
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-grids/SKILL.md +23 -23
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-integrate-with-framework/SKILL.md +23 -23
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-integrate-with-framework/references/angular.md +10 -10
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-integrate-with-framework/references/react.md +9 -9
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-integrate-with-framework/references/vanilla-js.md +9 -9
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-integrate-with-framework/references/vue.md +11 -11
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-migrate-grid-lite-to-premium/SKILL.md +18 -18
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-optimize-bundle-size/SKILL.md +78 -48
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
> **Part of the [`igniteui-wc-figma-to-app`](../SKILL.md) skill.**
|
|
4
4
|
>
|
|
5
|
-
> Use this file in Phase 5 for the measurement-driven validation loop. Read
|
|
5
|
+
> Use this file in Phase 5 for the measurement-driven validation loop. Read all of it before you call a Playwright tool.
|
|
6
6
|
|
|
7
7
|
---
|
|
8
8
|
|
|
9
9
|
## Core Philosophy
|
|
10
10
|
|
|
11
|
-
**Measure
|
|
11
|
+
**Measure. Do not estimate by eye.** The goal is design fidelity (does this match the Figma spec?), not visual regression (did this change since last week?). Screenshots show the general appearance. `playwright_browser_evaluate` gives the numbers. Use the numbers to make corrections.
|
|
12
12
|
|
|
13
|
-
**The Web Components
|
|
13
|
+
**The Web Components difference:** almost all of the elements that you measure are inside a shadow root. `document.querySelector('igc-card .title')` returns `null`. The element is not missing: the selector cannot cross the shadow boundary. Each snippet below is shadow-aware and includes the helpers that it uses. Use these snippets instead of ad-hoc selectors. A view that is a Lit component has its own shadow root, so use a `host >>> selector` path to get its content (for example, `app-dashboard >>> .kpi-card`).
|
|
14
14
|
|
|
15
15
|
---
|
|
16
16
|
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
|
|
43
43
|
### 1. Viewport reset after resize
|
|
44
44
|
|
|
45
|
-
After `playwright_browser_resize`, the browser
|
|
45
|
+
After `playwright_browser_resize`, the browser can navigate to `about:blank`. Then the next screenshots and measurements come back empty.
|
|
46
46
|
|
|
47
47
|
```
|
|
48
48
|
playwright_browser_resize({ width: 1440, height: 900 })
|
|
@@ -52,7 +52,7 @@ playwright_browser_navigate({ url: "http://localhost:5173/dashboard" })
|
|
|
52
52
|
|
|
53
53
|
### 2. `playwright_browser_evaluate` uses `function`, not `script`
|
|
54
54
|
|
|
55
|
-
|
|
55
|
+
If you pass `script`, the call fails with *"Invalid input: expected string, received undefined"*.
|
|
56
56
|
|
|
57
57
|
```
|
|
58
58
|
// WRONG
|
|
@@ -64,7 +64,7 @@ playwright_browser_evaluate({ function: "() => document.title" })
|
|
|
64
64
|
|
|
65
65
|
### 3. Measuring before the components have upgraded
|
|
66
66
|
|
|
67
|
-
Custom elements upgrade asynchronously, and Lit renders on a microtask.
|
|
67
|
+
Custom elements upgrade asynchronously, and Lit renders on a microtask. If you measure too early, you get pre-upgrade box metrics (frequently `height: 0`). Wait for the registered elements to render. The snippet waits only for tags that are already defined, for a maximum of 3 seconds. Thus an unregistered tag cannot block the snippet. The snippet returns unregistered tags in `undefinedTags`:
|
|
68
68
|
|
|
69
69
|
```
|
|
70
70
|
playwright_browser_evaluate({
|
|
@@ -74,7 +74,7 @@ playwright_browser_evaluate({
|
|
|
74
74
|
|
|
75
75
|
### 4. An unregistered element fails silently
|
|
76
76
|
|
|
77
|
-
A missing `defineComponents(...)`
|
|
77
|
+
A missing `defineComponents(...)` call gives **no console error**. The tag renders as an empty inline box. Run the registration audit before you look for CSS problems.
|
|
78
78
|
|
|
79
79
|
### 5. Dev server must be running
|
|
80
80
|
|
|
@@ -83,13 +83,13 @@ playwright_browser_navigate({ url: "http://localhost:5173" })
|
|
|
83
83
|
playwright_browser_console_messages()
|
|
84
84
|
```
|
|
85
85
|
|
|
86
|
-
`ERR_CONNECTION_REFUSED` or a blank page means the Vite dev server is not running
|
|
86
|
+
`ERR_CONNECTION_REFUSED` or a blank page means that the Vite dev server is not running. Ask the user to run `npm start`. Check the port: the Vite default is **5173**.
|
|
87
87
|
|
|
88
88
|
---
|
|
89
89
|
|
|
90
90
|
## The Deep-Query Helper
|
|
91
91
|
|
|
92
|
-
|
|
92
|
+
All measurement snippets below use this helper. It walks shadow roots, so a selector such as `igc-card >>> [part="header"]` resolves.
|
|
93
93
|
|
|
94
94
|
```javascript
|
|
95
95
|
// Every snippet below already inlines the helpers it uses. Paste these into new snippets.
|
|
@@ -111,7 +111,7 @@ const deepQueryAll = (sel, root = document) => {
|
|
|
111
111
|
};
|
|
112
112
|
```
|
|
113
113
|
|
|
114
|
-
|
|
114
|
+
For box metrics (width, height, position, margin), measure the **host element** (`igc-card`) when possible. Pierce the shadow root only for internal details that the design specifies (header height, row padding). When you must pierce, target documented `::part(...)` names from `get_doc`, never internal class names.
|
|
115
115
|
|
|
116
116
|
---
|
|
117
117
|
|
|
@@ -127,7 +127,7 @@ playwright_browser_evaluate({
|
|
|
127
127
|
})
|
|
128
128
|
```
|
|
129
129
|
|
|
130
|
-
Assert
|
|
130
|
+
Assert that `undefinedTags` is empty. Assert that `theme` and `variant` match the design system and variant that you resolved in Phase 3. An empty `theme` means that no theme CSS is loaded. In that case, components fall back to `bootstrap` / `light` without a warning.
|
|
131
131
|
|
|
132
132
|
### Measure a single element (shadow-aware)
|
|
133
133
|
|
|
@@ -137,7 +137,7 @@ playwright_browser_evaluate({
|
|
|
137
137
|
})
|
|
138
138
|
```
|
|
139
139
|
|
|
140
|
-
> A host element with `display: inline` (the Lit default) reports a misleading box. If width or height
|
|
140
|
+
> A host element with `display: inline` (the Lit default) reports a misleading box. If the width or height looks incorrect, look for a missing `:host { display: block }` before you examine the padding.
|
|
141
141
|
|
|
142
142
|
### Surfaces audit (mandatory — every page, every Phase 1g surface)
|
|
143
143
|
|
|
@@ -150,7 +150,7 @@ playwright_browser_evaluate({
|
|
|
150
150
|
**Assert for each entry:**
|
|
151
151
|
|
|
152
152
|
- Figma surface has a background → `bg !== 'rgba(0, 0, 0, 0)'`
|
|
153
|
-
- Figma section floats on the page background → `bg === 'rgba(0, 0, 0, 0)'` (do not
|
|
153
|
+
- Figma section floats on the page background → `bg === 'rgba(0, 0, 0, 0)'` (do not add a surface that the design does not show)
|
|
154
154
|
- `radius`, `padding`, `border`, `shadow` match the Phase 1g values
|
|
155
155
|
- children shown inside the card in Figma are inside the card's bounding rect in the DOM
|
|
156
156
|
|
|
@@ -162,7 +162,7 @@ playwright_browser_evaluate({
|
|
|
162
162
|
})
|
|
163
163
|
```
|
|
164
164
|
|
|
165
|
-
Compare
|
|
165
|
+
Compare the result with the Phase 1d inventory. If a control is not in the design context output, it is fabricated. Remove it. `(unlabeled)` entries are also an accessibility failure: icon-only buttons need `aria-label`.
|
|
166
166
|
|
|
167
167
|
### Input variant audit (every page with form controls)
|
|
168
168
|
|
|
@@ -172,7 +172,7 @@ playwright_browser_evaluate({
|
|
|
172
172
|
})
|
|
173
173
|
```
|
|
174
174
|
|
|
175
|
-
Compare
|
|
175
|
+
Compare the result with the variant that you detected in Phase 1d. If the design uses border-style inputs everywhere, every control should report `outlined === count`.
|
|
176
176
|
|
|
177
177
|
### Property-binding audit (collection-bound charts, grids, combos)
|
|
178
178
|
|
|
@@ -182,7 +182,9 @@ playwright_browser_evaluate({
|
|
|
182
182
|
})
|
|
183
183
|
```
|
|
184
184
|
|
|
185
|
-
`dataLength: null` means the
|
|
185
|
+
`dataLength: null` means that the code set the collection as an attribute (or did not set it), not as a property. An empty `brushes` list on a chart means that no series colors are assigned. The chart then uses the default palette instead of the Figma series colors. The brush members are different for each chart: `brushes` / `outlines` on most charts, `brush` on `igc-sparkline`, `fillBrushes` on `igc-treemap`, and `brushes` / `outlines` on each `igc-ring-series` child of `igc-doughnut-chart` (not on the host). `height: 0` means that the element or its grid track has no height.
|
|
186
|
+
|
|
187
|
+
Use this audit for the collection-bound host tags in the selected plan. Gauges and maps need their own host-specific validation after you know which properties the selected component binds.
|
|
186
188
|
|
|
187
189
|
### Measure the gap between two elements
|
|
188
190
|
|
|
@@ -216,7 +218,7 @@ playwright_browser_evaluate({
|
|
|
216
218
|
})
|
|
217
219
|
```
|
|
218
220
|
|
|
219
|
-
Use the reported `part` names
|
|
221
|
+
Use the reported `part` names. When there is no design token for a detail that the design requires, these parts are the supported styling surface.
|
|
220
222
|
|
|
221
223
|
---
|
|
222
224
|
|
|
@@ -231,18 +233,18 @@ Use the reported `part` names — they are the supported styling surface when a
|
|
|
231
233
|
| **Major** | Wrong component | Figma shows a combo, code has a select | Fix |
|
|
232
234
|
| **Major** | Wrong variant | `variant="flat"` when the design shows contained | Fix |
|
|
233
235
|
| **Major** | Collection not bound | `data` / `dataSource` set as an attribute, or no series brushes assigned | Fix |
|
|
234
|
-
| **Major** | Token-fixable mismatch | Color, radius, border, shadow, or text casing differs, or a control height differs by more than 4px
|
|
236
|
+
| **Major** | Token-fixable mismatch | Color, radius, border, shadow, or text casing differs, or a control height differs by more than 4px. A component token, palette seed, `--ig-size` step, or `--ig-<style>-<property>` override can close the difference | Fix |
|
|
235
237
|
| **Minor** | Spacing off by > 4px | `gap: 24px` measured, Figma shows `16px` | Fix |
|
|
236
238
|
| **Minor** | Font size wrong by > 2px | `16px` measured, Figma shows `14px` | Fix |
|
|
237
239
|
| **Cosmetic** | Color rounding | The same color after conversion: `rgb(51, 51, 51)` vs `#333333`. Any visibly different shade (`#333` vs `#2d2d2d`, a 500-vs-600 seed) is **Major** | Report only |
|
|
238
240
|
| **Cosmetic** | Size off by ≤ 4px | Spacing or control height within 4px, or font size within 2px, from rounding or sub-pixel layout | Report only |
|
|
239
|
-
| **Accepted** | Approved anatomy delta | Matches a delta-ledger entry the user approved (
|
|
241
|
+
| **Accepted** | Approved anatomy delta | Matches a delta-ledger entry that the user approved (for example, an M3 segmented button's check icon, a sheet rendered as a dialog) | Report only. Do not "fix" it. It does not count toward the 3-retry rule |
|
|
240
242
|
|
|
241
|
-
**Exit condition for an artboard:** no Critical, Major, or Minor issues remain. Only Cosmetic and Accepted items
|
|
243
|
+
**Exit condition for an artboard:** no Critical, Major, or Minor issues remain. Only Cosmetic and Accepted items can remain. Put both types in the final report.
|
|
242
244
|
|
|
243
|
-
> **Accepted needs the user's approval.** A delta is Accepted only after the user approves its ledger entry. Most entries come from Phase 2d.
|
|
245
|
+
> **Accepted needs the user's approval.** A delta is Accepted only after the user approves its ledger entry. Most entries come from Phase 2d. Phase 5 can find a difference that tokens, documented `::part(...)` selectors, or slotted content cannot close. In that case, add it to the ledger and ask the user. After the user approves it, it stays Accepted. Until then, classify it normally, and never downgrade it silently.
|
|
244
246
|
>
|
|
245
|
-
> **Third-party kits (Path B):** color, radius, border, casing, and height mismatches
|
|
247
|
+
> **Third-party kits (Path B):** you can almost always fix color, radius, border, casing, and height mismatches with component tokens or the `--ig-<style>-<property>` typography overrides. They are Major, never Accepted. Only *structural* differences can go into the ledger: a label position that the baseline cannot move, an adornment that the component does not render, or a behavior pattern with no equivalent.
|
|
246
248
|
|
|
247
249
|
### Mismatch report format
|
|
248
250
|
|
|
@@ -302,7 +304,7 @@ After `playwright_browser_snapshot()`, verify:
|
|
|
302
304
|
| Check | What to look for |
|
|
303
305
|
| --------------------- | ------------------------------------------------------------------------ |
|
|
304
306
|
| Heading hierarchy | `h1` → `h2` → `h3` without skipping levels |
|
|
305
|
-
| Button labels | Every button has text or `aria-label` — icon-only buttons
|
|
307
|
+
| Button labels | Every button has text or `aria-label` — especially icon-only buttons |
|
|
306
308
|
| Input labels | Inputs use the `label` attribute or an associated `<label>` |
|
|
307
309
|
| Navigation landmark | `<nav>` or `role="navigation"` wraps the main navigation |
|
|
308
310
|
| Main content landmark | `<main>` or `role="main"` wraps the primary content region |
|
|
@@ -318,7 +320,7 @@ After `playwright_browser_snapshot()`, verify:
|
|
|
318
320
|
1. **Component design token** — `get_component_design_tokens` → `create_component_theme`
|
|
319
321
|
2. **Documented `::part(...)`** — for details with no token
|
|
320
322
|
3. **Slotted content you own** — style it in your own CSS
|
|
321
|
-
4. Never internal class names
|
|
323
|
+
4. Never use internal class names. Never try to reach into a shadow root from page CSS
|
|
322
324
|
|
|
323
325
|
### Density and spacing
|
|
324
326
|
|
|
@@ -328,7 +330,7 @@ set_spacing({ component: "calendar", spacing: 0.75, platform: "webcomponents" })
|
|
|
328
330
|
set_size({ scope: ".compact-toolbar", size: "small", platform: "webcomponents" })
|
|
329
331
|
```
|
|
330
332
|
|
|
331
|
-
Or directly:
|
|
333
|
+
Or set the custom properties directly:
|
|
332
334
|
|
|
333
335
|
```css
|
|
334
336
|
igc-calendar {
|
|
@@ -337,7 +339,7 @@ igc-calendar {
|
|
|
337
339
|
}
|
|
338
340
|
```
|
|
339
341
|
|
|
340
|
-
Choose the multiplier by visual judgment
|
|
342
|
+
Choose the multiplier by visual judgment. Never map a Figma pixel value to it.
|
|
341
343
|
|
|
342
344
|
### Typography correction
|
|
343
345
|
|
|
@@ -351,7 +353,7 @@ Fix the type style, not an internal class. Every type style is a set of `--ig-<s
|
|
|
351
353
|
}
|
|
352
354
|
```
|
|
353
355
|
|
|
354
|
-
If the text
|
|
356
|
+
If the text is part of a component, find its type style in the component's doc. Or use the typography-related design tokens of the component from `theming_get_component_design_tokens`. Or style the content that you put in its slots.
|
|
355
357
|
|
|
356
358
|
Inside a Lit view's shadow root, document CSS such as `.ig-typography h1` does not reach native headings. Apply the variables in the view's `static styles` yourself, for example `h1 { font-size: var(--ig-h1-font-size); font-weight: var(--ig-h1-font-weight); line-height: var(--ig-h1-line-height); }`.
|
|
357
359
|
|
|
@@ -363,8 +365,15 @@ background: var(--ig-primary-500);
|
|
|
363
365
|
color: var(--ig-primary-500-contrast);
|
|
364
366
|
```
|
|
365
367
|
|
|
366
|
-
|
|
368
|
+
If you are not sure of the exact variable name, use `get_color({ color: "primary", variant: "500", contrast: true })`.
|
|
367
369
|
|
|
368
370
|
### Missing element
|
|
369
371
|
|
|
370
|
-
If an element is in Figma but
|
|
372
|
+
If an element is in Figma but not in the DOM, do these checks in this order:
|
|
373
|
+
|
|
374
|
+
1. Check the registration (`customElements.get`).
|
|
375
|
+
2. Check the import path.
|
|
376
|
+
3. Check the slot name that the element must use.
|
|
377
|
+
4. Go back to Phase 2 and read the component doc again.
|
|
378
|
+
|
|
379
|
+
A wrong slot name renders nothing and reports no error.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
license: MIT
|
|
3
3
|
name: igniteui-wc-generate-from-image-design
|
|
4
|
-
description: "Implement application views from design images (screenshots, mockups, wireframes)
|
|
4
|
+
description: "Implement application views from design images (screenshots, mockups, wireframes) with Ignite UI Web Components. Use the igniteui-cli and igniteui-theming MCP servers for component discovery, theme generation, and best practices. WHEN TO USE: the user gives a design image and wants a working view from it, or asks to 'implement this design', 'build this UI', 'convert this mockup', or 'create a page from this image' in an Ignite UI Web Components project. WHEN NOT TO USE: the design source is a Figma file or URL (use figma-to-app), the user gives no image and needs only component suggestions (use choose-components), the task is only theming or restyling of existing views (use customize-component-theme), or the task is package installation/framework setup (use integrate-with-framework)."
|
|
5
5
|
user-invocable: true
|
|
6
6
|
---
|
|
7
7
|
|
|
@@ -9,24 +9,24 @@ user-invocable: true
|
|
|
9
9
|
|
|
10
10
|
## MANDATORY AGENT PROTOCOL
|
|
11
11
|
|
|
12
|
-
Before
|
|
12
|
+
Before you write implementation code, do these steps in this order:
|
|
13
13
|
|
|
14
14
|
1. Analyze the image and identify all visible regions and UI patterns.
|
|
15
15
|
2. Read [references/component-mapping.md](references/component-mapping.md) and [references/gotchas.md](references/gotchas.md).
|
|
16
|
-
3. This skill is Web Components-first. Check package layout or licensing only when package choice, component registration, or theming
|
|
17
|
-
4. To apply a theme, use the theming workflow from this skill and the dedicated `igniteui-wc-customize-component-theme` skill
|
|
18
|
-
5. Call `get_doc` for every chosen component family before
|
|
19
|
-
6. Only then start
|
|
16
|
+
3. This skill is Web Components-first. Check the package layout or licensing only when package choice, component registration, or theming depends on them.
|
|
17
|
+
4. To apply a theme, use the theming workflow from this skill and the dedicated `igniteui-wc-customize-component-theme` skill. Use the `igniteui-theming` MCP tools. Do not style from memory.
|
|
18
|
+
5. Call `get_doc` for every chosen component family before you use it.
|
|
19
|
+
6. Only then start to write code.
|
|
20
20
|
|
|
21
21
|
## Workflow
|
|
22
22
|
|
|
23
|
-
1. **Analyze the design image** - Read the image
|
|
24
|
-
2. **Confirm package layout if needed** - Web Components packages are split by component family
|
|
23
|
+
1. **Analyze the design image** - Read the image. Identify every UI section, component, and layout structure.
|
|
24
|
+
2. **Confirm package layout if needed** - Web Components packages are split by component family. Check the package layout or licensing only when package choice, component registration, or theming depends on them.
|
|
25
25
|
3. **Discover components** - Call `list_components` with targeted filters to find matching components for each UI pattern.
|
|
26
26
|
4. **Look up component docs** - Call `get_doc` for every chosen component family before coding.
|
|
27
|
-
5. **Generate theme** - (a) To generate a theme, first extract colors
|
|
27
|
+
5. **Generate theme** - (a) To generate a theme, first extract the colors. Create a color palette with `create_palette` or `create_custom_palette`, as the scenario requires. Then extract the elevations and call `create_elevations`. Then extract the typography and call `create_typography`. Then call `create_theme` when Sass is configured, or import the closest pre-built theme CSS. (b) After a theme exists, use design tokens or scoped semantic CSS variables instead of raw literals where possible. (c) For every Ignite UI component family that exposes design tokens, call `get_component_design_tokens`. Map the extracted image tokens to token roles. Then call `create_component_theme` with the component tokens that are different from the global theme.
|
|
28
28
|
6. **Implement** - Build the screenshot-first layout, data, and view components.
|
|
29
|
-
7. **Refine** - Use the `set_size`, `set_spacing`, `set_roundness` tools to refine the
|
|
29
|
+
7. **Refine** - Use the `set_size`, `set_spacing`, `set_roundness` tools to refine the visual fidelity of the view against the image. Then change the implementation and theming again until the view closely matches the design.
|
|
30
30
|
8. **Validate** - Build, test, run, compare against the image, and fix differences.
|
|
31
31
|
|
|
32
32
|
## Step 1: Analyze the Design Image
|
|
@@ -34,15 +34,15 @@ Before writing any implementation code, you must complete these steps in order:
|
|
|
34
34
|
Read the input image carefully. For each visual section, identify:
|
|
35
35
|
|
|
36
36
|
- **Layout structure**: grid rows/columns, sidebar, navbar, content area proportions, and estimated fixed widths or percentages for major regions.
|
|
37
|
-
> Note: Do not guess the exact CSS properties at this stage
|
|
37
|
+
> Note: Do not guess the exact CSS properties at this stage. Identify only the high-level structure and relative proportions. Do not try to fit the view into exact breakpoints or pixel values. Generate a flexible layout that keeps the observed proportions and adapts to different screen sizes. You refine the exact CSS rules in Step 8, after you build a first version of the view.
|
|
38
38
|
- **Component type**: chart, list, card, grid, form, navigation, etc.
|
|
39
39
|
- **Color palette**: primary, secondary, surface/background, accent, text colors.
|
|
40
40
|
- **Typography**: font sizes, weights, letter-spacing patterns.
|
|
41
41
|
- **Surface styling**: borders, border-radius, shadows, elevation, divider treatments.
|
|
42
|
-
- **Data patterns**:
|
|
42
|
+
- **Data patterns**: the mock data that the view needs (time series, lists, KPIs, tabular, scheduling).
|
|
43
43
|
- **Spacing system**: translate observed padding and gaps into a small reusable scale derived from the design.
|
|
44
44
|
|
|
45
|
-
Before
|
|
45
|
+
Before you write code, create a decomposition table. Give each visible region one row with these columns:
|
|
46
46
|
|
|
47
47
|
| Region | Visual role | Candidate component | Custom CSS required | Data type |
|
|
48
48
|
|---|---|---|---|---|
|
|
@@ -50,9 +50,9 @@ Before writing code, create a decomposition table with one row per visible regio
|
|
|
50
50
|
| Example: top bar | brand + tabs + search | `IgcNavbarComponent` | yes - multi-zone slot layout | n/a |
|
|
51
51
|
| Example: side panel | always-visible navigation | `IgcNavDrawerComponent` | yes - width, item styling | n/a |
|
|
52
52
|
|
|
53
|
-
Start every region with the most
|
|
53
|
+
Start every region with the most applicable Ignite UI component from [references/component-mapping.md](references/component-mapping.md). First, try CSS overrides, tokens, slots, and documented `::part(...)` selectors. Use plain semantic HTML only when the component DOM structure is still fundamentally incompatible with the design. Write the reason for each plain-HTML fallback in a code comment.
|
|
54
54
|
|
|
55
|
-
Before
|
|
55
|
+
Before you write code, write a compact implementation brief that includes:
|
|
56
56
|
|
|
57
57
|
- chosen components per region
|
|
58
58
|
- fallback HTML regions
|
|
@@ -61,16 +61,16 @@ Before writing code, produce a compact implementation brief that captures:
|
|
|
61
61
|
- component registration needs
|
|
62
62
|
- major assumptions
|
|
63
63
|
|
|
64
|
-
After the table, translate the image into CSS Grid rows and columns first.
|
|
64
|
+
After the table, translate the image into CSS Grid rows and columns first. Keep the desktop proportions before you add responsive behavior. Then define explicit breakpoint stacking rules for smaller screens.
|
|
65
65
|
|
|
66
66
|
## Step 2-3: Use MCP Tools for Discovery
|
|
67
67
|
|
|
68
|
-
This skill is Web Components-first. Check package layout or licensing only when package choice, component registration, or theming
|
|
68
|
+
This skill is Web Components-first. Check the package layout or licensing only when package choice, component registration, or theming depends on them.
|
|
69
69
|
|
|
70
|
-
-
|
|
71
|
-
- If the result
|
|
70
|
+
- The project can be unlicensed or use the trial package layout. In that case, do not mark documented trial packages as blocked or licensed-only during implementation.
|
|
71
|
+
- If the result shows a licensed package layout, use the licensed import paths from the component reference when necessary.
|
|
72
72
|
|
|
73
|
-
Then call `list_components` with `framework: "webcomponents"` and relevant filters
|
|
73
|
+
Then, to find the components that match each UI pattern, call `list_components` with `framework: "webcomponents"` and relevant filters. Common filters:
|
|
74
74
|
|
|
75
75
|
- `chart`, `sparkline` - for data visualization
|
|
76
76
|
- `list view`, `card`, `avatar`, `badge` - for data display
|
|
@@ -79,44 +79,44 @@ Then call `list_components` with `framework: "webcomponents"` and relevant filte
|
|
|
79
79
|
- `grid lite`, `data grid`, `tree grid` - for tabular data
|
|
80
80
|
- `calendar`, `date picker`, `combo`, `select`, `input` - for forms and scheduling
|
|
81
81
|
|
|
82
|
-
Use narrow search terms to
|
|
82
|
+
Use narrow search terms to get fewer unrelated MCP results. Search for the specific UI pattern that you need, for example `list view` instead of `list`.
|
|
83
83
|
|
|
84
84
|
For component-to-Ignite-UI mapping, see [references/component-mapping.md](references/component-mapping.md).
|
|
85
85
|
|
|
86
86
|
## Step 4: Look Up Component API
|
|
87
87
|
|
|
88
|
-
|
|
88
|
+
Before you write code, use both tools for every chosen component category:
|
|
89
89
|
|
|
90
90
|
- **Usage patterns, HTML examples, slots, registration** → `get_doc({ framework: "webcomponents", name: "<doc-name>" })` — use the `name` field from `list_components`, not the display title
|
|
91
91
|
- **Full property/method/event API** → `get_api_reference({ platform: "webcomponents", component: "<ClassName>" })` — use `search_api` first to find the exact class name if needed
|
|
92
92
|
|
|
93
|
-
Call `search_docs` for feature-based questions (
|
|
93
|
+
Call `search_docs` for feature-based questions (for example, "how to configure [component] for [specific behavior or styling need]").
|
|
94
94
|
|
|
95
95
|
## Step 5: Generate Theme with MCP
|
|
96
96
|
|
|
97
|
-
Use this skill for the image-to-view theming workflow only. The dedicated [`igniteui-wc-customize-component-theme`](../igniteui-wc-customize-component-theme/SKILL.md) skill
|
|
97
|
+
Use this skill for the image-to-view theming workflow only. The dedicated [`igniteui-wc-customize-component-theme`](../igniteui-wc-customize-component-theme/SKILL.md) skill is the primary reference for palette-token behavior, global theme rules, and general theming-system guidance.
|
|
98
98
|
|
|
99
99
|
### 5a - Existing app guard (always run first)
|
|
100
100
|
|
|
101
|
-
Before
|
|
101
|
+
Before you generate theme code, examine the entry point and main stylesheet(s) of the project (usually `main.ts`, `main.js`, `index.ts`, `app.ts`, `styles.css`, or the main theme stylesheet of the app). Look for:
|
|
102
102
|
|
|
103
103
|
- an imported pre-built theme CSS file such as `igniteui-webcomponents/themes/light/material.css`
|
|
104
104
|
- existing palette tokens or semantic CSS variables already exposed by the app
|
|
105
105
|
- existing app-level typography or elevation variables already exposed by the app
|
|
106
106
|
|
|
107
107
|
- **Existing theme found** -> the global theme is already set. Do **not** call `create_palette` unless the user explicitly wants a global theme change. Instead:
|
|
108
|
-
1.
|
|
108
|
+
1. Examine the existing theme import, palette definition, and any exposed semantic CSS variables.
|
|
109
109
|
2. Reuse the current design system, variant, and palette tokens wherever they already match the design image.
|
|
110
|
-
3. Skip to **5c** and apply only minimal scoped overrides for the new view
|
|
111
|
-
- **No theme found / blank theme setup** ->
|
|
110
|
+
3. Skip to **5c** and apply only minimal scoped overrides for the components of the new view.
|
|
111
|
+
- **No theme found / blank theme setup** -> continue with **5b** to generate a new CSS-based theme baseline.
|
|
112
112
|
|
|
113
113
|
### 5b - Global theme generation (new projects only)
|
|
114
114
|
|
|
115
115
|
Follow this order - MCP guidance first, image extraction second:
|
|
116
116
|
|
|
117
|
-
1. **Read MCP guidance first** - call `theming://guidance/colors/rules` (or `get_theming_guidance`) before
|
|
118
|
-
2. **Resolve the design system** -
|
|
119
|
-
3. **Extract from the image** - now
|
|
117
|
+
1. **Read MCP guidance first** - call `theming://guidance/colors/rules` (or `get_theming_guidance`) before you look at the image. The guidance gives the available theme inputs and any luminance or variant constraints.
|
|
118
|
+
2. **Resolve the design system** - find it from the existing workspace, an explicit user request, or the closest visual match in the design. Do not assume a design system if a stronger signal exists.
|
|
119
|
+
3. **Extract from the image** - you now know the available slots. Extract values only for the inputs that you need.
|
|
120
120
|
4. **Call `create_palette` or `create_custom_palette`** with the extracted seed values:
|
|
121
121
|
|
|
122
122
|
```
|
|
@@ -129,79 +129,79 @@ create_palette({
|
|
|
129
129
|
})
|
|
130
130
|
```
|
|
131
131
|
|
|
132
|
-
Import the closest built-in theme CSS for the resolved design system and variant
|
|
132
|
+
Import the closest built-in theme CSS for the resolved design system and variant. Then use `get_color` to translate the generated palette into CSS custom properties, semantic app tokens, and component token values. Apply typography decisions with standard CSS `font-family`, `font-size`, and `font-weight` rules. Apply elevations with CSS box-shadow values or semantic shadow variables.
|
|
133
133
|
|
|
134
|
-
Read
|
|
134
|
+
Read all returned luminance warnings and make the necessary changes. The design can need multiple surface depths that one generated surface color does not cover. In that case, use `create_custom_palette` or define semantic CSS variables for the additional depths in the main stylesheet.
|
|
135
135
|
|
|
136
|
-
Use `create_palette` for
|
|
136
|
+
Use `create_palette` for designs with a small, coherent color system. Use `create_custom_palette` when the design has multiple distinct surface depths or several accent families. Also use it when the generated palette cannot reliably match the screenshot.
|
|
137
137
|
|
|
138
138
|
### 5c - Per-component token discovery and mapping (always run)
|
|
139
139
|
|
|
140
|
-
> **Scope:**
|
|
140
|
+
> **Scope:** This step applies to every Ignite UI Web Components family that exposes design tokens. The primary targets are the core components: cards, inputs, select, combo, navbar, nav drawer, list, tabs, date pickers, chips, and others. Some packages or components do not expose a practical token surface in the current project. For them, use documented properties, `::part(...)` selectors, or wrapper styles. Do not invent unsupported tokens.
|
|
141
141
|
|
|
142
|
-
For **every** chosen Ignite UI component family in Steps 3-4, follow this MCP-first loop
|
|
142
|
+
For **every** chosen Ignite UI component family in Steps 3-4, follow this MCP-first loop. Query MCP before you look at the image:
|
|
143
143
|
|
|
144
|
-
1. **Discover (MCP first)** - call `get_component_design_tokens(component)` before
|
|
145
|
-
2. **Extract (image second)** - now
|
|
146
|
-
3. **Generate** - call `create_component_theme(component, platform, licensed, tokens)
|
|
144
|
+
1. **Discover (MCP first)** - call `get_component_design_tokens(component)` before you look at the image for that component. Read the full token list with names, types, and descriptions. Identify the tokens that correspond to visible surfaces, text, borders, icons, and interaction states.
|
|
145
|
+
2. **Extract (image second)** - you now know the exact token names. Go to the image region for that component. Read the exact token value for each relevant token slot. Do not guess. Zoom into the component region.
|
|
146
|
+
3. **Generate** - call `create_component_theme(component, platform, licensed, tokens)`. Give it only the tokens whose resolved value is different from the global theme. The result is the minimal set of scoped theme overrides for the component.
|
|
147
147
|
|
|
148
148
|
**Example - theming a grid:**
|
|
149
|
-
- `get_component_design_tokens("grid")` returns `header-background`, `content-background`, `row-hover-background
|
|
149
|
+
- `get_component_design_tokens("grid")` returns `header-background`, `content-background`, `row-hover-background`, and many other tokens.
|
|
150
150
|
- Look at the grid region in the image -> extract the color intent for header, row background, and hover state.
|
|
151
151
|
- Resolve each value to a palette token or local semantic CSS variable.
|
|
152
152
|
- Call `create_component_theme("grid", ...)` with only `{ "header-background": "<resolved token>", "content-background": "<resolved token>", "row-hover-background": "<resolved token>" }`.
|
|
153
153
|
|
|
154
|
-
Apply the generated theme blocks to the component selector or a scoped wrapper exactly as
|
|
154
|
+
Apply the generated theme blocks to the component selector or a scoped wrapper exactly as the `create_component_theme` output shows.
|
|
155
155
|
|
|
156
|
-
Do not run `create_component_theme` for regions
|
|
156
|
+
Do not run `create_component_theme` for regions that use only custom HTML/CSS.
|
|
157
157
|
|
|
158
158
|
### 5d - Theming sequence summary
|
|
159
159
|
|
|
160
160
|
Apply in this exact order:
|
|
161
161
|
|
|
162
|
-
1.
|
|
162
|
+
1. Examine the entry point and main stylesheet(s) -> existing theme or blank?
|
|
163
163
|
2. Create or update a theme baseline: pre-built theme import plus palette-backed CSS variables and token overrides (Step 5b)
|
|
164
164
|
3. For each Ignite UI component: `get_component_design_tokens` -> map image design tokens -> resolve values to design tokens or semantic CSS variables -> `create_component_theme` (Step 5c)
|
|
165
165
|
4. Use `get_color` after palette generation whenever a palette token can represent the final color intent
|
|
166
166
|
|
|
167
|
-
Use standard CSS `font-family` lists in stylesheets or CSS variables for typography. Do not
|
|
167
|
+
Use standard CSS `font-family` lists in stylesheets or CSS variables for typography. Do not write Sass typography mixins for Ignite UI Web Components apps.
|
|
168
168
|
|
|
169
169
|
## Step 6: Install Required Packages
|
|
170
170
|
|
|
171
|
-
General UI components
|
|
171
|
+
General UI components are in `igniteui-webcomponents`. For lightweight tabular data, you can use `igniteui-grid-lite`. Advanced grids, dock manager, and charts require additional packages. These packages can be different for the trial and the licensed package layout. Resolve the selected component families against the current workspace and [references/component-mapping.md](references/component-mapping.md).
|
|
172
172
|
|
|
173
|
-
After
|
|
173
|
+
After you select the packages, register only the custom elements that you use. Use `defineComponents(...)` in the applicable entry point or setup module. Do not do this if the host framework integration already handles registration differently. Use [`igniteui-wc-integrate-with-framework`](../igniteui-wc-integrate-with-framework/SKILL.md) when framework-specific setup details are important.
|
|
174
174
|
|
|
175
|
-
If required packages are missing, identify the exact packages and versions required
|
|
175
|
+
If required packages are missing, first identify the exact packages and versions that are required. Then ask for approval before you install packages or change dependency manifests.
|
|
176
176
|
|
|
177
177
|
## Step 7: Implement
|
|
178
178
|
|
|
179
179
|
### Structure
|
|
180
180
|
|
|
181
|
-
- **Layout**: use Ignite UI layout and data-display components as the starting point for standard regions
|
|
182
|
-
- **Data**: use typed mock data that matches the
|
|
183
|
-
- **View**: keep layout, spacing, typography, and surface styling in CSS
|
|
184
|
-
- **Theming**: apply the resolved design system and theme variant from Step 5
|
|
181
|
+
- **Layout**: use Ignite UI layout and data-display components as the starting point for standard regions. Then apply CSS Grid/Flexbox and component overrides to match the screenshot. Use plain semantic HTML only when an Ignite UI component is still structurally incompatible after a genuine attempt.
|
|
182
|
+
- **Data**: use typed mock data that matches the density and domain of the design. Add models/services only when they help the implementation.
|
|
183
|
+
- **View**: keep layout, spacing, typography, and surface styling in CSS, not in inline attributes.
|
|
184
|
+
- **Theming**: apply the resolved design system and theme variant from Step 5. Keep color usage aligned with palette tokens or local semantic CSS variables.
|
|
185
185
|
|
|
186
186
|
### Implementation Checks
|
|
187
187
|
|
|
188
188
|
- Follow repo conventions from `.github/copilot-instructions.md` and `.github/CODING_GUIDELINES.md`.
|
|
189
189
|
- Use [references/component-mapping.md](references/component-mapping.md) for component-choice and semantic-fallback rules.
|
|
190
|
-
- Use [references/gotchas.md](references/gotchas.md) for
|
|
191
|
-
-
|
|
192
|
-
- Register only the custom elements you
|
|
193
|
-
- Use slots, parts, and documented component APIs before
|
|
194
|
-
-
|
|
195
|
-
-
|
|
196
|
-
-
|
|
190
|
+
- Use [references/gotchas.md](references/gotchas.md) for component, theming, registration, and API edge cases. Do not repeat those rules inline.
|
|
191
|
+
- Use Ignite UI components instead of custom HTML when both approaches can give similar visual fidelity.
|
|
192
|
+
- Register only the custom elements that you use. Put the registration in the existing entry-point pattern of the project.
|
|
193
|
+
- Use slots, parts, and documented component APIs before you try shadow-DOM workarounds.
|
|
194
|
+
- Keep the spacing, hierarchy, and data density before you add extra interactivity.
|
|
195
|
+
- Do not use generic placeholders when the image shows domain-specific content.
|
|
196
|
+
- When the image is ambiguous, write down short assumptions. Do not guess silently.
|
|
197
197
|
|
|
198
198
|
## Step 8: Refine
|
|
199
199
|
|
|
200
|
-
After the first implementation pass, use the `set_size`, `set_spacing`, and `set_roundness` tools to adjust the
|
|
200
|
+
After the first implementation pass, use the `set_size`, `set_spacing`, and `set_roundness` tools to adjust the visual properties of the view. Make the view match the image more closely. Start with the most visually distinctive elements (for example, panel proportions, chart shape, button prominence). Then tune the smaller details (for example, row heights, spacing between regions).
|
|
201
201
|
|
|
202
202
|
## Step 9: Validate
|
|
203
203
|
|
|
204
|
-
Use this validation loop
|
|
204
|
+
Use this validation loop:
|
|
205
205
|
|
|
206
206
|
1. Build
|
|
207
207
|
2. Test
|
|
@@ -209,7 +209,7 @@ Use this validation loop explicitly:
|
|
|
209
209
|
4. Visually compare against the image
|
|
210
210
|
5. Adjust and repeat
|
|
211
211
|
|
|
212
|
-
In terminal-only environments, the user
|
|
212
|
+
In terminal-only environments, the user does the visual comparison and gives feedback about mismatches. Do the visual check yourself only when the environment gives the agent browser and screenshot capabilities.
|
|
213
213
|
|
|
214
214
|
Use this checklist during the first visual comparison:
|
|
215
215
|
|
|
@@ -221,7 +221,7 @@ Use this checklist during the first visual comparison:
|
|
|
221
221
|
- row heights
|
|
222
222
|
- spacing between regions
|
|
223
223
|
|
|
224
|
-
|
|
224
|
+
During the build/test steps, fix TypeScript, registration, markup, or build errors immediately. To remove the remaining differences, use the build output, component docs, [references/gotchas.md](references/gotchas.md), and the visual feedback from the user. Typical adjustments include:
|
|
225
225
|
|
|
226
226
|
- revisiting chart data density, smoothing, or marker visibility
|
|
227
227
|
- adjusting layout ratios, region spacing, or row heights
|
|
@@ -229,4 +229,4 @@ Fix TypeScript, registration, markup, or build errors immediately during the bui
|
|
|
229
229
|
- tuning theme tokens, component overrides, and dark-surface hierarchy
|
|
230
230
|
- re-examining the original design for overlooked sections or missing registration/imports
|
|
231
231
|
|
|
232
|
-
After the build
|
|
232
|
+
After the build completes with zero errors, refine the layout proportions, color values, missing sections, and typography until the view closely matches the design.
|