igniteui-cli 15.8.1 → 15.8.3-alpha.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/lib/MultiTemplateComponent.d.ts +1 -1
- package/lib/TemplateManager.d.ts +1 -1
- package/lib/cli.d.ts +1 -1
- package/lib/cli.js +2 -2
- package/lib/commands/doc.js +1 -1
- package/lib/commands/list.js +1 -1
- package/lib/commands/types.d.ts +2 -2
- package/lib/commands/upgrade.js +4 -1
- package/lib/project-utility/GridHelper.d.ts +6 -2
- package/lib/templates/IgniteUIForReactTemplate.d.ts +9 -5
- package/lib/templates/IgniteUIForReactTemplate.js +2 -2
- package/lib/templates/IgniteUIForWebComponentsTemplate.d.ts +8 -4
- package/lib/templates/IgniteUIForWebComponentsTemplate.js +8 -4
- package/lib/templates/jQueryTemplate.d.ts +8 -4
- package/lib/templates/jQueryTemplate.js +1 -1
- package/package.json +5 -4
- package/templates/blazor/igb/projects/ai-config/files/skills/AGENTS.md +7 -2
- 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/data-display.md +2 -2
- 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 +2 -2
- 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 +24 -5
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/SKILL.md +1 -1
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/editing.md +4 -3
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/grid-migration.md +1 -1
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/types.md +1 -1
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-theming/references/common-patterns.md +1 -1
- package/templates/blazor/igb/projects/ai-config/index.d.ts +1 -1
- package/templates/blazor/igb/projects/ai-config/index.js +1 -0
- package/templates/blazor/igb/projects/empty/index.d.ts +1 -1
- package/templates/jquery/js/projects/empty/index.js +1 -0
- package/templates/react/ReactTypeScriptFileUpdate.js +4 -4
- package/templates/react/igr-ts/constants.d.ts +1 -1
- package/templates/react/igr-ts/constants.js +1 -1
- package/templates/react/igr-ts/projects/_base/index.d.ts +1 -1
- package/templates/react/igr-ts/projects/_base/index.js +1 -0
- package/templates/react/igr-ts/projects/ai-config/index.d.ts +1 -1
- package/templates/webcomponents/WebComponentsTypeScriptFileUpdate.js +2 -2
- package/templates/webcomponents/igc-ts/category-chart/default/files/src/app/__path__/__filePrefix__.test.ts +9 -0
- package/templates/webcomponents/igc-ts/category-chart/default/files/src/app/__path__/__filePrefix__.ts +37 -0
- package/templates/webcomponents/igc-ts/category-chart/default/index.d.ts +1 -0
- package/templates/webcomponents/igc-ts/category-chart/default/index.js +21 -0
- package/templates/webcomponents/igc-ts/category-chart/index.d.ts +1 -0
- package/templates/webcomponents/igc-ts/category-chart/index.js +12 -0
- package/templates/webcomponents/igc-ts/constants.d.ts +1 -1
- package/templates/webcomponents/igc-ts/constants.js +1 -1
- package/templates/webcomponents/igc-ts/doughnut-chart/default/files/src/app/__path__/__filePrefix__.test.ts +9 -0
- package/templates/webcomponents/igc-ts/doughnut-chart/default/files/src/app/__path__/__filePrefix__.ts +52 -0
- package/templates/webcomponents/igc-ts/doughnut-chart/default/index.d.ts +1 -0
- package/templates/webcomponents/igc-ts/doughnut-chart/default/index.js +21 -0
- package/templates/webcomponents/igc-ts/doughnut-chart/index.d.ts +1 -0
- package/templates/webcomponents/igc-ts/doughnut-chart/index.js +12 -0
- package/templates/webcomponents/igc-ts/projects/_base/index.d.ts +4 -2
- 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
- package/templates/webcomponents/igc-ts/projects/ai-config/index.d.ts +1 -1
- package/templates/webcomponents/igc-ts/projects/ai-config/index.js +1 -0
|
@@ -4,31 +4,31 @@
|
|
|
4
4
|
>
|
|
5
5
|
> Use this file in Phase 2a to resolve every row of the Phase 1g Table A to a tag, component class, package, and `get_doc` name. It has two entry points:
|
|
6
6
|
>
|
|
7
|
-
> - **Canonical Role Index** (next section). Use it for **Tier B and Tier C** layers: components from any other UI kit, or un-componentized frames, after
|
|
8
|
-
> - **Kit Component Name** tables (the sections after it). Use them for **Tier A** layers from the Infragistics **Indigo.Design UI Kits** (Material, Fluent, Bootstrap, Indigo variants)
|
|
7
|
+
> - **Canonical Role Index** (next section). Use it for **Tier B and Tier C** layers: components from any other UI kit, or un-componentized frames, after you normalize them with [design-provenance.md](design-provenance.md).
|
|
8
|
+
> - **Kit Component Name** tables (the sections after it). Use them for **Tier A** layers from the Infragistics **Indigo.Design UI Kits** (Material, Fluent, Bootstrap, Indigo variants). The layer names of these kits map to Ignite UI directly.
|
|
9
9
|
>
|
|
10
|
-
>
|
|
10
|
+
> If a role or layer name is in neither part, call `list_components`. Then call `get_doc` on the closest match.
|
|
11
11
|
|
|
12
12
|
---
|
|
13
13
|
|
|
14
14
|
## Canonical Role Index
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
This index maps each normalized role from `design-provenance.md` to the Ignite UI tag. It also gives the section below that holds the full row (class, package, doc name, key attributes).
|
|
17
17
|
|
|
18
18
|
| Canonical role (+ normalized props) | Ignite UI Web Components | Section |
|
|
19
19
|
| --- | --- | --- |
|
|
20
20
|
| `button` · high | `<igc-button variant="contained">` | Button Components |
|
|
21
21
|
| `button` · medium (outlined) | `<igc-button variant="outlined">` | Button Components |
|
|
22
|
-
| `button` · medium (tonal / secondary fill) | `<igc-button variant="contained">` + `contained-button` tokens set to the **measured** tonal fill and text colors (usually a light shade such as `var(--ig-primary-100)`). Do not use the plain `secondary` palette
|
|
22
|
+
| `button` · medium (tonal / secondary fill) | `<igc-button variant="contained">` + `contained-button` tokens set to the **measured** tonal fill and text colors (usually a light shade such as `var(--ig-primary-100)`). Do not use the plain `secondary` palette. On a `material` baseline, it holds the brand color, so tonal buttons look like high-emphasis buttons | Button Components |
|
|
23
23
|
| `button` · low | `<igc-button variant="flat">` | Button Components |
|
|
24
24
|
| `button` · link | `<igc-button variant="flat" href="…">`, or a plain `<a>` styled as a link | Button Components |
|
|
25
|
-
| `button` · elevated | `<igc-button variant="contained">` + elevation
|
|
25
|
+
| `button` · elevated | `<igc-button variant="contained">` + elevation set through tokens | Button Components |
|
|
26
26
|
| `button` · danger | Same variant + tokens bound to `--ig-error-*` | Button Components |
|
|
27
27
|
| `icon-button` | `<igc-icon-button variant="flat\|outlined\|contained">` | Button Components |
|
|
28
28
|
| `fab` | `<igc-button variant="fab">` | Button Components |
|
|
29
29
|
| `toggle-group` | `<igc-button-group>` + `<igc-toggle-button>` | Button Components |
|
|
30
30
|
| `text-field` · outlined | `<igc-input outlined>` | Form Controls |
|
|
31
|
-
| `text-field` · filled / underlined | `<igc-input>` (
|
|
31
|
+
| `text-field` · filled / underlined | `<igc-input>` (use `input-group` tokens to match the look) | Form Controls |
|
|
32
32
|
| `textarea` | `<igc-textarea>` | Form Controls |
|
|
33
33
|
| `select` | `<igc-select>` | Form Controls |
|
|
34
34
|
| `combobox` (single, searchable) | `<igc-combo single-select>` | Form Controls |
|
|
@@ -71,17 +71,18 @@ Normalized roles from `design-provenance.md` → the Ignite UI tag, and the sect
|
|
|
71
71
|
|
|
72
72
|
## How to Use the Kit Tables
|
|
73
73
|
|
|
74
|
-
1. Find the kit component name
|
|
74
|
+
1. Find the kit component name in the **Kit Component Name** column. Use the name from the Figma layers panel or the Indigo.Design kit library.
|
|
75
75
|
2. Read the **Tag**, **Class**, and **Package** columns for the markup and imports.
|
|
76
|
-
3. Call `get_doc({ framework: "webcomponents", name: "<doc name>" })` for usage patterns and slots
|
|
77
|
-
4.
|
|
76
|
+
3. Call `get_doc({ framework: "webcomponents", name: "<doc name>" })` for usage patterns and slots.
|
|
77
|
+
4. Call `get_api_reference({ platform: "webcomponents", component: "<Class>" })` for the full property, method, and event API.
|
|
78
|
+
5. Read **Key attributes / slots** for the properties that Figma variants configure most frequently. These are starting points. They do not replace the docs.
|
|
78
79
|
|
|
79
|
-
> The kit component names are
|
|
80
|
+
> The kit component names are the same in all four kit variants (Material, Fluent, Bootstrap, Indigo). The kit variant sets the theme, not the component name.
|
|
80
81
|
|
|
81
82
|
### Doc-name rules you will hit immediately
|
|
82
83
|
|
|
83
|
-
- **Doc names are topic-page names, not tag names.** `navigation-drawer`, `text-area`, `data-grid`, `circular-progress`.
|
|
84
|
-
- **`get_doc` normalizes and aliases input.** It
|
|
84
|
+
- **Doc names are topic-page names, not tag names.** For example: `navigation-drawer`, `text-area`, `data-grid`, `circular-progress`.
|
|
85
|
+
- **`get_doc` normalizes and aliases input.** It removes the `Igc` prefix and the `Component` suffix, so `IgcCarouselComponent` resolves to `carousel`. It also aliases these Web Components names:
|
|
85
86
|
|
|
86
87
|
| You pass | Resolves to |
|
|
87
88
|
| --- | --- |
|
|
@@ -96,8 +97,8 @@ Normalized roles from `design-provenance.md` → the Ignite UI tag, and the sect
|
|
|
96
97
|
| `range-slider` | `slider` |
|
|
97
98
|
| `geographic-map` | `geo-map` |
|
|
98
99
|
|
|
99
|
-
- Combo has several topic pages (`overview`, `features`, `single-selection`, `templates`)
|
|
100
|
-
- Always confirm
|
|
100
|
+
- Combo has several topic pages (`overview`, `features`, `single-selection`, `templates`). Read `overview` first, then read the page that the design needs.
|
|
101
|
+
- Always confirm with a live `list_components({ framework: "webcomponents" })` call. The catalog is the source of truth. This table is only a shortcut.
|
|
101
102
|
|
|
102
103
|
### Registration cheat sheet
|
|
103
104
|
|
|
@@ -109,7 +110,7 @@ Normalized roles from `design-provenance.md` → the Ignite UI tag, and the sect
|
|
|
109
110
|
| `igniteui-webcomponents-charts` / `-gauges` / `-maps` | `ModuleManager.register(IgcCategoryChartModule, …)` from `igniteui-webcomponents-core` |
|
|
110
111
|
| `igniteui-dockmanager` | `defineComponents(IgcDockManagerComponent)` from `igniteui-dockmanager` (`defineCustomElements()` is deprecated since 2.0.0) |
|
|
111
112
|
|
|
112
|
-
Licensed projects use the same names
|
|
113
|
+
Licensed projects use the same names with the prefix `@infragistics/` (for example, `@infragistics/igniteui-webcomponents-grids`, `@infragistics/igniteui-dockmanager`). `igniteui-webcomponents` has the MIT license and has no licensed variant. Resolve the layout once in Phase 0b and keep it consistent.
|
|
113
114
|
|
|
114
115
|
---
|
|
115
116
|
|
|
@@ -124,13 +125,13 @@ Licensed projects use the same names prefixed with `@infragistics/` (e.g. `@infr
|
|
|
124
125
|
| `_Icon Button/*` | `<igc-icon-button variant="flat">` | `IgcIconButtonComponent` | `igniteui-webcomponents` | `icon-button` | `variant` (`flat\|contained\|outlined`), `name`, `collection` |
|
|
125
126
|
| `_Button Group` | `<igc-button-group>` | `IgcButtonGroupComponent` | `igniteui-webcomponents` | `button-group` | `selection`, `alignment`; `<igc-toggle-button>` children |
|
|
126
127
|
|
|
127
|
-
> `variant` is an **attribute** on the element
|
|
128
|
+
> `variant` is an **attribute** on the element. There is no directive equivalent of Angular's `igxButton`. Icon-only buttons need an `aria-label` for the Phase 5g check.
|
|
128
129
|
|
|
129
130
|
---
|
|
130
131
|
|
|
131
132
|
## Form Controls
|
|
132
133
|
|
|
133
|
-
> **Input variants.** The kits
|
|
134
|
+
> **Input variants.** The kits use the `line`, `box`, and `border` input types. Web Components have one boolean **`outlined`** attribute on `igc-input`, `igc-textarea`, `igc-mask-input`, `igc-date-time-input`, `igc-file-input`, `igc-select`, `igc-combo`, `igc-date-picker`, and `igc-date-range-picker`. Map `_Input/Border` → `outlined`; `_Input/Line` and `_Input/Box` → default. There is **no** global injection-token equivalent of Angular's `IGX_INPUT_GROUP_TYPE`. Set the attribute on each control. Close the remaining differences with `input-group` component tokens (Phase 3d), never with internal class selectors.
|
|
134
135
|
|
|
135
136
|
| Kit Component Name | Tag | Class | Package | Doc | Key attributes / slots |
|
|
136
137
|
| ------------------------------ | ------------------------- | ------------------------------- | ------------------------ | ------------------- | --------------------------------------------------------------------------- |
|
|
@@ -163,7 +164,7 @@ Licensed projects use the same names prefixed with `@infragistics/` (e.g. `@infr
|
|
|
163
164
|
| `_Time Picker` | `<igc-date-time-input>` | `IgcDateTimeInputComponent` | `igniteui-webcomponents` | `date-time-input` | **No dedicated time picker in Web Components** — use a time `input-format` |
|
|
164
165
|
| `_Calendar` | `<igc-calendar>` | `IgcCalendarComponent` | `igniteui-webcomponents` | `calendar` | `selection` (`single\|multiple\|range`), `value`, `values`, `visible-months`, `week-start`, `show-week-numbers`, `header-orientation` |
|
|
165
166
|
|
|
166
|
-
> The date pickers are **compound**
|
|
167
|
+
> The date pickers are **compound** components. Their dropdown and calendar surfaces use separate themes. Follow the related-theme chain from `get_component_design_tokens`.
|
|
167
168
|
|
|
168
169
|
---
|
|
169
170
|
|
|
@@ -171,7 +172,7 @@ Licensed projects use the same names prefixed with `@infragistics/` (e.g. `@infr
|
|
|
171
172
|
|
|
172
173
|
| Kit Component Name | Tag | Class | Package | Doc | Key attributes / slots |
|
|
173
174
|
| ---------------------------------- | ------------------------- | ------------------------------ | ------------------------ | --------------------- | -------------------------------------------------------------------------------- |
|
|
174
|
-
| `_Navbar` | `<igc-navbar>` | `IgcNavbarComponent` | `igniteui-webcomponents` | `navbar` | Slots `start`, `end`, default (title). No `title` attribute —
|
|
175
|
+
| `_Navbar` | `<igc-navbar>` | `IgcNavbarComponent` | `igniteui-webcomponents` | `navbar` | Slots `start`, `end`, default (title). No `title` attribute — put the title in the default slot. |
|
|
175
176
|
| `_Navigation Drawer` / `_Side Nav` | `<igc-nav-drawer>` | `IgcNavDrawerComponent` | `igniteui-webcomponents` | `navigation-drawer` | `open`, `position` (`start\|end\|top\|bottom\|relative`), `label`; slot `mini`; `<igc-nav-drawer-item>` / `<igc-nav-drawer-header-item>` children |
|
|
176
177
|
| `_Tabs` | `<igc-tabs>` | `IgcTabsComponent` | `igniteui-webcomponents` | `tabs` | `alignment`, `activation`; `<igc-tab label="…">` children with `prefix`/`suffix` slots |
|
|
177
178
|
| `_Bottom Navigation` | — | — | — | — | **Not available in Web Components.** Use `igc-tabs` or custom markup; document the substitution. |
|
|
@@ -179,7 +180,7 @@ Licensed projects use the same names prefixed with `@infragistics/` (e.g. `@infr
|
|
|
179
180
|
| `_Breadcrumbs` | `<igc-breadcrumbs>` | `IgcBreadcrumbsComponent` | `igniteui-webcomponents` | confirm via `list_components` | `separator`; default slot contains `<igc-breadcrumb>` children; wrap in `<nav aria-label="…">` |
|
|
180
181
|
| `_Breadcrumb` | `<igc-breadcrumb>` | `IgcBreadcrumbComponent` | `igniteui-webcomponents` | confirm via `list_components` | `current`, `disabled`; slots `prefix`, `suffix`, `separator` |
|
|
181
182
|
|
|
182
|
-
>
|
|
183
|
+
> If a design shows a persistent sidebar that is always visible, map it to `<igc-nav-drawer position="relative" open>`, not to the modal default. The `navdrawer` design tokens `size` and `size--mini` set the drawer width. They are available as `--ig-nav-drawer-size` (default 15rem) and `--ig-nav-drawer-size--mini`. Set them through `create_component_theme`, as you do for other tokens.
|
|
183
184
|
|
|
184
185
|
---
|
|
185
186
|
|
|
@@ -202,10 +203,10 @@ Licensed projects use the same names prefixed with `@infragistics/` (e.g. `@infr
|
|
|
202
203
|
| `_List` | `<igc-list>` | `IgcListComponent` | `igniteui-webcomponents` | `list` | `<igc-list-item>` children with slots `start`, `title`, `subtitle`, `end`; `<igc-list-header>` |
|
|
203
204
|
| `_Tree` / `_Tree View` | `<igc-tree>` | `IgcTreeComponent` | `igniteui-webcomponents` | `tree` | `selection`; `<igc-tree-item>` children |
|
|
204
205
|
| `_Card` | `<igc-card>` | `IgcCardComponent` | `igniteui-webcomponents` | `card` | `<igc-card-header>` (slots `thumbnail`, `title`, `subtitle`), `<igc-card-media>`, `<igc-card-content>`, `<igc-card-actions>` |
|
|
205
|
-
| `_Chip` / `_Chips` | `<igc-chip>` | `IgcChipComponent` | `igniteui-webcomponents` | `chip` | `removable`, `selectable`, `selected`, `disabled`, `outlined`, `variant`; slots `prefix`, `suffix`, `start`, `end` — there is **no chips-area
|
|
206
|
+
| `_Chip` / `_Chips` | `<igc-chip>` | `IgcChipComponent` | `igniteui-webcomponents` | `chip` | `removable`, `selectable`, `selected`, `disabled`, `outlined`, `variant`; slots `prefix`, `suffix`, `start`, `end` — there is **no chips-area**; use a flex layout for chips |
|
|
206
207
|
| `_Avatar` | `<igc-avatar>` | `IgcAvatarComponent` | `igniteui-webcomponents` | `avatar` | `src`, `alt`, `initials`, `shape` (`circle\|rounded\|square`) |
|
|
207
208
|
| `_Badge` | `<igc-badge>` | `IgcBadgeComponent` | `igniteui-webcomponents` | `badge` | `variant` (`primary\|info\|success\|warning\|danger`), `shape`, `outlined`, `dot` |
|
|
208
|
-
| `_Icon` | `<igc-icon>` | `IgcIconComponent` | `igniteui-webcomponents` | `icon` | `name`, `collection` —
|
|
209
|
+
| `_Icon` | `<igc-icon>` | `IgcIconComponent` | `igniteui-webcomponents` | `icon` | `name`, `collection` — you must **register icons first** (see below) |
|
|
209
210
|
| `_Carousel` | `<igc-carousel>` | `IgcCarouselComponent` | `igniteui-webcomponents` | `carousel` | `<igc-carousel-slide>` children; `interval`, `vertical`, `disable-loop`, `hide-indicators`, `hide-navigation` |
|
|
210
211
|
| `_Linear Progress` / `_Progress Bar` | `<igc-linear-progress>` | `IgcLinearProgressComponent` | `igniteui-webcomponents` | `linear-progress` | `value`, `max`, `indeterminate`, `variant`, `striped` — theme key `progress-linear` |
|
|
211
212
|
| `_Circular Progress` | `<igc-circular-progress>` | `IgcCircularProgressComponent` | `igniteui-webcomponents` | `circular-progress` | `value`, `max`, `indeterminate` — theme key `progress-circular` |
|
|
@@ -241,18 +242,18 @@ Licensed projects use the same names prefixed with `@infragistics/` (e.g. `@infr
|
|
|
241
242
|
Grid rules that differ from Angular:
|
|
242
243
|
|
|
243
244
|
- Register per grid type: `IgcGridComponent.register()`.
|
|
244
|
-
- The grid packages
|
|
245
|
+
- The grid packages include their **own theme CSS** (`igniteui-webcomponents-grids/grids/themes/<variant>/<design-system>.css`) in addition to the core theme. In a Lit component, import it with `?inline` and inject it into the shadow root. At app level, import it normally.
|
|
245
246
|
- `data` is a property, not an attribute: `.data=${rows}` / `grid.data = rows`.
|
|
246
247
|
- Leave at least one `<igc-column>` without a `width` so it fills the remaining space.
|
|
247
|
-
- Feature docs are separate pages (`grid-editing`, `grid-filtering`, `grid-paging`, …)
|
|
248
|
+
- Feature docs are separate pages (`grid-editing`, `grid-filtering`, `grid-paging`, …). Get the pages for the features that the artboard shows.
|
|
248
249
|
|
|
249
250
|
---
|
|
250
251
|
|
|
251
252
|
## Charts, Gauges, and Maps
|
|
252
253
|
|
|
253
|
-
> These are DV components. They have **no design tokens
|
|
254
|
+
> These are DV components. They have **no design tokens**. Do not call `get_component_design_tokens` for them. Configure all settings through properties. Take series colors from `theming_get_chart_series_colors` and the Figma values that you recorded in Phase 1d.
|
|
254
255
|
>
|
|
255
|
-
>
|
|
256
|
+
> To register components from all three packages, use `ModuleManager.register(IgcXxxModule, …)` from `igniteui-webcomponents-core`. You must **assign array and function values as properties**, never as attributes.
|
|
256
257
|
|
|
257
258
|
| Kit Component Name | Tag | Class | Package | Doc |
|
|
258
259
|
| --------------------------------------------------------- | ------------------------- | ---------------------------- | -------------------------------- | --------------------------------------------- |
|
|
@@ -269,18 +270,18 @@ Grid rules that differ from Angular:
|
|
|
269
270
|
| `_Bullet Graph` | `<igc-bullet-graph>` | `IgcBulletGraphComponent` | `igniteui-webcomponents-gauges` | `bullet-graph` |
|
|
270
271
|
| `_Geographic Map` | `<igc-geographic-map>` | `IgcGeographicMapComponent` | `igniteui-webcomponents-maps` | `geographic-map` → `geo-map` |
|
|
271
272
|
|
|
272
|
-
DV
|
|
273
|
+
DV details to know before Phase 4:
|
|
273
274
|
|
|
274
|
-
- Gauge and chart **attributes are kebab-case** (`minimum-value`, `maximum-value`, `chart-type`)
|
|
275
|
-
- `plotAreaBackground` and `areaFillOpacity`
|
|
276
|
-
- Category charts show markers by default
|
|
277
|
-
-
|
|
275
|
+
- Gauge and chart **attributes are kebab-case** (`minimum-value`, `maximum-value`, `chart-type`). Collection-valued members such as `dataSource` are properties.
|
|
276
|
+
- `plotAreaBackground` and `areaFillOpacity` come from parent classes. They do not appear in `get_api_reference` for `IgcCategoryChartComponent`. Find them with `search_api`.
|
|
277
|
+
- Category charts show markers by default. If the design has no markers, set the documented no-marker value.
|
|
278
|
+
- Set an explicit height on charts and a `min-height` on their grid track. If you do not, the charts collapse.
|
|
278
279
|
|
|
279
280
|
---
|
|
280
281
|
|
|
281
282
|
## Icons
|
|
282
283
|
|
|
283
|
-
`igc-icon` renders from a **registry
|
|
284
|
+
`igc-icon` renders icons from a **registry**. By default, the package bundles no icons. Register each icon before you use it:
|
|
284
285
|
|
|
285
286
|
```typescript
|
|
286
287
|
import { registerIcon, registerIconFromText } from 'igniteui-webcomponents';
|
|
@@ -292,7 +293,7 @@ registerIconFromText('home', '<svg …></svg>', 'material');
|
|
|
292
293
|
await registerIcon('search', 'https://example.com/icons/search.svg');
|
|
293
294
|
```
|
|
294
295
|
|
|
295
|
-
|
|
296
|
+
The Indigo.Design UI Kit for Material uses the Material Icons Extended set. For icons from this set, Figma component descriptions have the suffix **"material extended"**. To use the set:
|
|
296
297
|
|
|
297
298
|
```bash
|
|
298
299
|
npm install @igniteui/material-icons-extended
|
|
@@ -311,13 +312,13 @@ for (const icon of all) {
|
|
|
311
312
|
<igc-icon name="credit-cards"></igc-icon>
|
|
312
313
|
```
|
|
313
314
|
|
|
314
|
-
**Detection in Phase 1d:**
|
|
315
|
+
**Detection in Phase 1d:** look for "material extended" in `data-name` values and component descriptions. If you find it, add the package to the required list. Get approval before Phase 4. If the design uses a glyph again under a different label, use `setIconRef(name, collection, meta)` to alias the registered icon to the new name.
|
|
315
316
|
|
|
316
|
-
|
|
317
|
+
Do not extract registered icons as image assets (see `asset-extraction.md`).
|
|
317
318
|
|
|
318
319
|
### Icons from other kits
|
|
319
320
|
|
|
320
|
-
Third-party kits
|
|
321
|
+
Third-party kits have their own icon sets. Identify the set from the icon instance names (`lucide/chevron-down`, `ic_fluent_…`, `Icon / arrow-right`, `Symbols/…`), from the component descriptions, or from the kit fingerprint in `design-provenance.md`. Then register glyphs **from that set's SVG package**, so that names, weights, and stroke widths match the design:
|
|
321
322
|
|
|
322
323
|
| Icon set | SVG source package (confirm name, version, and license before installing) |
|
|
323
324
|
| --- | --- |
|
|
@@ -338,13 +339,13 @@ registerIconFromText('chevron-down', chevronDown, 'lucide');
|
|
|
338
339
|
<igc-icon name="chevron-down" collection="lucide"></igc-icon>
|
|
339
340
|
```
|
|
340
341
|
|
|
341
|
-
Register only the glyphs the design uses
|
|
342
|
+
Register only the glyphs that the design uses. If you import a full set, the bundle becomes larger. The set can be paid (for example, Untitled UI Icons Pro), unknown, or not licensed for the web (SF Symbols). In these cases, export the glyphs that the design uses as SVG with Tier 1 Method B from `asset-extraction.md`. Then register these SVGs instead. Tell the user which icons came from a licensed set.
|
|
342
343
|
|
|
343
344
|
---
|
|
344
345
|
|
|
345
346
|
## Components With No Web Components Equivalent
|
|
346
347
|
|
|
347
|
-
|
|
348
|
+
Before you assume that a 1:1 mapping exists, check this list. If the component is in this list, use the substitute. Document the substitution in a code comment and in the Phase 2d plan.
|
|
348
349
|
|
|
349
350
|
| Kit component / role | Status in Web Components | Substitute |
|
|
350
351
|
| ----------------- | ------------------------- | ------------------------------------------------------------------ |
|
|
@@ -362,9 +363,9 @@ Check this list before assuming a 1:1 mapping exists. When you hit one, substitu
|
|
|
362
363
|
|
|
363
364
|
## Unmapped Layers
|
|
364
365
|
|
|
365
|
-
|
|
366
|
+
If a Figma layer is **not in this file**, do these steps:
|
|
366
367
|
|
|
367
|
-
1. Normalize it with [design-provenance.md](design-provenance.md) (Tier B variant properties, or Tier C structure)
|
|
368
|
-
2. Call `list_components({ framework: "webcomponents", filter: "<keyword>" })
|
|
369
|
-
3.
|
|
370
|
-
4. If no Ignite UI component matches after a
|
|
368
|
+
1. Normalize it with [design-provenance.md](design-provenance.md) (Tier B variant properties, or Tier C structure). Then try the Canonical Role Index again. If you do not find a match, identify the visual pattern (is it a list, a form field, or a card?).
|
|
369
|
+
2. Call `list_components({ framework: "webcomponents", filter: "<keyword>" })`. Find the closest match in the result.
|
|
370
|
+
3. Before you write code, call `get_doc`. If you need the full API, also call `get_api_reference`.
|
|
371
|
+
4. If no Ignite UI component matches after a careful search, use plain semantic HTML. Document the reason in a code comment.
|
|
@@ -2,45 +2,47 @@
|
|
|
2
2
|
|
|
3
3
|
> **Part of the [`igniteui-wc-figma-to-app`](../SKILL.md) skill.**
|
|
4
4
|
>
|
|
5
|
-
> Use this file in Phase 1 to explore the Figma design and capture
|
|
5
|
+
> Use this file in Phase 1 to explore the Figma design and to capture all data that implementation and validation need. Read it in full before the first Figma MCP call.
|
|
6
6
|
|
|
7
|
-
**Goal:** understand the full design structure and capture all data
|
|
7
|
+
**Goal:** understand the full design structure, and capture all data for implementation and validation before you write code.
|
|
8
8
|
|
|
9
9
|
> **Rate-limit awareness:** Figma MCP limits depend on the **seat**, not only the plan (as published in September 2026; verify at https://developers.figma.com/docs/figma-mcp-server/rate-limits-access/): **View/Collab seats** get up to 6 calls/month (20 on Starter). **Dev/Full seats** get 200/day (Starter, Professional) or 600/day (Organization, Enterprise), with 10–20/min.
|
|
10
10
|
>
|
|
11
|
-
> Estimated call budget for a 5-artboard design: `figma_get_metadata` ×2 + `figma_get_screenshot` ×5 + `figma_get_design_context` ×5 + `figma_get_variable_defs` ×1 per target page + `figma_get_code_connect_map` ×5 + `figma_get_libraries` ×1 = **~19 calls**. Retries and sparse-response follow-
|
|
12
|
-
> 1. Call `figma_get_variable_defs` once per **target page**, not once per artboard. It returns the variables used inside the node you pass, so one page-level call covers every artboard on that page.
|
|
13
|
-
> 2. Prioritize `figma_get_design_context` over additional screenshots if quota is tight.
|
|
14
|
-
> 3. For large files, consider implementing one artboard per monthly budget cycle.
|
|
11
|
+
> Estimated call budget for a 5-artboard design: `figma_get_metadata` ×2 + `figma_get_screenshot` ×5 + `figma_get_design_context` ×5 + `figma_get_variable_defs` ×1 per target page + `figma_get_code_connect_map` ×5 + `figma_get_libraries` ×1 = **~19 calls**. Retries and sparse-response follow-up calls increase this number. **Compare the estimate with the user's remaining quota before you start.**
|
|
15
12
|
>
|
|
16
|
-
>
|
|
13
|
+
> On a View/Collab seat (6/month on Professional and above), possibly even one artboard does not fit. The Starter View/Collab limit (20/month) is sufficient for a small design with no retries. If the estimate does not fit, tell the user. Then suggest a Dev/Full seat, or the REST API with a personal access token for metadata and assets. Strategies:
|
|
14
|
+
> 1. Call `figma_get_variable_defs` once per **target page**, not once per artboard. It returns the variables used inside the node that you pass, so one page-level call covers every artboard on that page.
|
|
15
|
+
> 2. If the quota is small, give `figma_get_design_context` priority over additional screenshots.
|
|
16
|
+
> 3. For large files, you can implement one artboard in each monthly budget cycle.
|
|
17
|
+
>
|
|
18
|
+
> Use `figma_get_metadata` first to find the structure at a low cost. Then call `figma_get_design_context` only for the artboards that you will implement.
|
|
17
19
|
|
|
18
20
|
## Before the First Call: Determine the Figma MCP Variant
|
|
19
21
|
|
|
20
|
-
Figma has two official MCP servers (setup: `mcp-setup.md § 1. Figma MCP`).
|
|
22
|
+
Figma has two official MCP servers (setup: `mcp-setup.md § 1. Figma MCP`). Identify which one is connected **before** Phase 1, because the server decides how you address artboards.
|
|
21
23
|
|
|
22
24
|
| Variant | How to recognize it | How you drive it |
|
|
23
25
|
| --- | --- | --- |
|
|
24
|
-
| **Remote** | Configured URL `https://mcp.figma.com/mcp`; the tools take `fileKey` | Pass `fileKey` and a `nodeId` (page or artboard) on **every** call. You can
|
|
25
|
-
| **Desktop** | Configured URL `http://127.0.0.1:3845/mcp`; the tools take no `fileKey` | Works only on the file **open in the Figma desktop app**. Pass the `nodeId` from a frame link, or
|
|
26
|
+
| **Remote** | Configured URL `https://mcp.figma.com/mcp`; the tools take `fileKey` | Pass `fileKey` and a `nodeId` (page or artboard) on **every** call. You can move between artboards without the user's help. |
|
|
27
|
+
| **Desktop** | Configured URL `http://127.0.0.1:3845/mcp`; the tools take no `fileKey` | Works only on the file **open in the Figma desktop app**. Pass the `nodeId` from a frame link, or use the current selection. |
|
|
26
28
|
|
|
27
|
-
|
|
29
|
+
If both variants are available, use the remote variant. Ask the user once for the file URL:
|
|
28
30
|
|
|
29
31
|
```
|
|
30
32
|
https://figma.com/design/:fileKey/:fileName?node-id=1-2 → fileKey = ":fileKey", nodeId = "1:2"
|
|
31
33
|
```
|
|
32
34
|
|
|
33
|
-
On the remote variant,
|
|
35
|
+
On the remote variant, always pass both `fileKey` and `nodeId`, also when the schema marks `nodeId` as optional. The server does not reliably support calls without a node.
|
|
34
36
|
|
|
35
37
|
On the desktop variant:
|
|
36
38
|
|
|
37
39
|
1. Make sure the user has the design file **open** in the desktop app.
|
|
38
|
-
2.
|
|
39
|
-
3. If the response describes a different node, or the user cannot share links,
|
|
40
|
+
2. If the user can share frame links (right-click → **Copy link to selection**), pass the `nodeId` of each frame. Then **check that the response describes the requested frame** (same name and size as in the Phase 1a metadata).
|
|
41
|
+
3. If the response describes a different node, or the user cannot share links, use the selection instead. Ask *"In Figma, please click the **[Artboard Name]** frame to select it, then confirm."* Wait for confirmation, then call the tool with no node. Never batch selection-based calls, because each call depends on what the user has selected at that moment.
|
|
40
42
|
|
|
41
43
|
## 1a: Discover Pages and Artboards
|
|
42
44
|
|
|
43
|
-
|
|
45
|
+
List the pages, then get the artboard tree of each relevant page. The calls are different for each variant:
|
|
44
46
|
|
|
45
47
|
```
|
|
46
48
|
// Remote variant: fileKey and nodeId are both required
|
|
@@ -53,13 +55,13 @@ figma_get_metadata({})
|
|
|
53
55
|
|
|
54
56
|
**Remote variant.** Choose the starting `nodeId` like this:
|
|
55
57
|
|
|
56
|
-
1. If the shared URL has a `node-id`, use it (replace `-` with `:`,
|
|
57
|
-
2. Otherwise, list the pages with the REST API when a token is available. It
|
|
58
|
-
3. Otherwise, ask the user to copy the link to the page or a frame (right-click → **Copy link to selection**)
|
|
58
|
+
1. If the shared URL has a `node-id`, use it (replace `-` with `:`, for example `1-2` → `1:2`). URL format: `https://figma.com/design/:fileKey/:name?node-id=1-2`.
|
|
59
|
+
2. Otherwise, list the pages with the REST API when a token is available. It uses no MCP quota: `GET https://api.figma.com/v1/files/:fileKey?depth=1` returns `document.children[]` with each page's `id` and `name`.
|
|
60
|
+
3. Otherwise, ask the user to copy the link to the page or a frame (right-click → **Copy link to selection**). Then take its `node-id`.
|
|
59
61
|
|
|
60
|
-
If that node is a single frame
|
|
62
|
+
If that node is a single frame and not a page, the response covers only the subtree of that frame. To see its sibling artboards, get the page's `id` (step 2 or 3), and call `figma_get_metadata` again with it. Repeat for each page that looks relevant.
|
|
61
63
|
|
|
62
|
-
**Desktop variant.** The user must have the file open in the desktop app.
|
|
64
|
+
**Desktop variant.** The user must have the file open in the desktop app. If you have a link to the page or a frame, pass its `nodeId` and check the response. Otherwise, ask the user to open the relevant page and select its top-level frames (or the page in the Layers panel). Then call `figma_get_metadata({})`. Repeat for each relevant page, and wait for confirmation each time.
|
|
63
65
|
|
|
64
66
|
## 1b: Select Target Artboards
|
|
65
67
|
|
|
@@ -72,30 +74,32 @@ If there are multiple pages or artboards, show the user a list:
|
|
|
72
74
|
>
|
|
73
75
|
> Which artboards should I implement? (You can say 'all' or list specific names.)"
|
|
74
76
|
|
|
75
|
-
Wait for confirmation before
|
|
77
|
+
Wait for confirmation before you continue.
|
|
76
78
|
|
|
77
79
|
## 1c: Capture Reference Screenshots
|
|
78
80
|
|
|
79
81
|
For each target artboard:
|
|
80
82
|
|
|
81
|
-
1. **Remote variant:** call `figma_get_screenshot({ fileKey: "<fileKey>", nodeId: "<artboardId>", maxDimension: 2048 })`. **Desktop variant:** call `figma_get_screenshot({ nodeId: "<artboardId>" })` and check that the image shows the requested artboard. If it does not, or you have no node ID, ask the user to select the artboard
|
|
82
|
-
2. **Save each screenshot to disk** (
|
|
83
|
+
1. **Remote variant:** call `figma_get_screenshot({ fileKey: "<fileKey>", nodeId: "<artboardId>", maxDimension: 2048 })`. **Desktop variant:** call `figma_get_screenshot({ nodeId: "<artboardId>" })` and check that the image shows the requested artboard. If it does not, or you have no node ID, ask the user to select the artboard. Wait for confirmation, then call `figma_get_screenshot({})`. Do **not** batch selection-based calls.
|
|
84
|
+
2. **Save each screenshot to disk** (for example, `.figma-reference/<artboard-name>.png`). Phase 5 compares against these files. If the tool returns a URL, download it immediately, because the URL is short-lived. The tool can return the image inline, and you possibly cannot write it to disk. In that case, export the node through the REST API when a token is available (`GET /v1/images/:fileKey?ids=<nodeId>&format=png&scale=2`, see `asset-extraction.md`). If you have no token, keep the image in context for Phase 5.
|
|
85
|
+
|
|
86
|
+
Record `{ artboardName, nodeId, file, width, height }`.
|
|
83
87
|
|
|
84
|
-
After all artboards
|
|
88
|
+
After you capture all artboards, confirm the count:
|
|
85
89
|
|
|
86
90
|
> *"I have N reference screenshots: [list artboard names]. Proceeding to design context extraction."*
|
|
87
91
|
|
|
88
|
-
If
|
|
92
|
+
If screenshots are missing, capture them again. On the remote server, use the `nodeId`. On the desktop server, ask the user to select the artboard.
|
|
89
93
|
|
|
90
94
|
> Never skip this step. The screenshots are your ground truth for Phase 5 validation.
|
|
91
95
|
|
|
92
96
|
## 1d: Extract Design Context
|
|
93
97
|
|
|
94
|
-
> **Output format:** `figma_get_design_context` returns **React + Tailwind CSS reference code**, not structured Web Components metadata. Do **not** copy that code into the project. Read the JSX to extract the information below. Asset URLs in the output (localhost on the desktop server, https on the remote server) are short-lived previews
|
|
98
|
+
> **Output format:** `figma_get_design_context` returns **React + Tailwind CSS reference code**, not structured Web Components metadata. Do **not** copy that code into the project. Read the JSX to extract the information below. Asset URLs in the output (localhost on the desktop server, https on the remote server) are short-lived previews. Do **not** use them as final assets (see Phase 1h and `references/asset-extraction.md`).
|
|
95
99
|
|
|
96
100
|
For **each** target artboard:
|
|
97
101
|
|
|
98
|
-
1. On the remote variant, pass `fileKey` and `nodeId`. On the desktop variant, pass the `nodeId` and check the response, or
|
|
102
|
+
1. On the remote variant, pass `fileKey` and `nodeId`. On the desktop variant, pass the `nodeId` and check the response, or use the selection instead (see [Before the First Call](#before-the-first-call-determine-the-figma-mcp-variant)).
|
|
99
103
|
2. Call:
|
|
100
104
|
```
|
|
101
105
|
figma_get_design_context({
|
|
@@ -110,18 +114,18 @@ For **each** target artboard:
|
|
|
110
114
|
- **Typography** — `font-['...']`, `text-[...]`, `font-weight` classes
|
|
111
115
|
- **Surface colors** — `bg-[#XXXXXX]` classes on container `<div>` elements that wrap major sections (these become plain `<div>` wrappers in the view, not Ignite UI components)
|
|
112
116
|
- **Border/roundness** — `rounded-[...]`, `border`, `border-[...]` classes on containers and cards
|
|
113
|
-
- **Input type variants** *(Tier A only)* — look for hidden zero-size nodes (`size-[0.5px]`) whose `data-name` contains a component type (
|
|
117
|
+
- **Input type variants** *(Tier A only)* — look for hidden zero-size nodes (`size-[0.5px]`) whose `data-name` contains a component type (for example, `"Date Picker Type"`, `"Combo Input"`). These nodes are the Indigo.Design kit's **variant indicator nodes**. Their name encodes the active input variant (border/line/box) for that component. For other kits, read the field style from its variant property or its visuals (outlined / filled / underlined, label floating or above). Web Components show this as the boolean `outlined` attribute, not as a three-way type (SKILL.md Phase 4, rule 12).
|
|
114
118
|
- **Chart series colors** — for any chart layer, note the fill colors on its series paths
|
|
115
|
-
- **Color census** — which colors appear on which kinds of element: high-emphasis button fills, page and card backgrounds, borders, primary and secondary text, error states. For Tier B/C designs, Phase 3 seeds the palette from this (see `design-token-bridge.md § B2`), not from variable names.
|
|
119
|
+
- **Color census** — which colors appear on which kinds of element: high-emphasis button fills, page and card backgrounds, borders, primary and secondary text, error states. For Tier B/C designs, Phase 3 seeds the palette from this census (see `design-token-bridge.md § B2`), not from variable names.
|
|
116
120
|
- **Measured control heights** — button, input, and list-row heights. Phase 3 uses them to pick `--ig-size`.
|
|
117
|
-
- **Action controls** — list every button, icon button, and toolbar action visible in the artboard
|
|
118
|
-
- **Provenance signals** — library/source file names (
|
|
121
|
+
- **Action controls** — list every button, icon button, and toolbar action that is visible in the artboard. This list is your authoritative inventory. Do not add actions that are not in the design
|
|
122
|
+
- **Provenance signals** — library/source file names (for example, `Indigo.Design UI Kit for Material`, `Material 3 Design Kit`, `shadcn/ui`), naming conventions (`_Button/…` vs `Button` with `Variant=…`), and un-componentized frames. Phase 1f uses them to set a tier for each instance.
|
|
119
123
|
|
|
120
124
|
4. Record all surface containers for **Table B — Layout Surfaces** (Phase 1g).
|
|
121
125
|
|
|
122
126
|
## 1e: Extract Design Tokens
|
|
123
127
|
|
|
124
|
-
> `figma_get_variable_defs` returns the variables and styles **used inside the node you pass** (or the current selection), not every variable in the file. Call it **once per target page**, with the page's node ID.
|
|
128
|
+
> `figma_get_variable_defs` returns the variables and styles **used inside the node you pass** (or the current selection), not every variable in the file. Call it **once per target page**, with the page's node ID. One call covers every target artboard on the page, so you do not use a call for each artboard. If the targets are on two pages, call it twice.
|
|
125
129
|
|
|
126
130
|
```
|
|
127
131
|
// Remote variant
|
|
@@ -132,7 +136,7 @@ figma_get_variable_defs({ nodeId: "<pageId>" })
|
|
|
132
136
|
figma_get_variable_defs({})
|
|
133
137
|
```
|
|
134
138
|
|
|
135
|
-
The response contains a map of variable names to values,
|
|
139
|
+
The response contains a map of variable names to values, for example:
|
|
136
140
|
|
|
137
141
|
```
|
|
138
142
|
"color/primary/500": "#6200EE"
|
|
@@ -140,13 +144,15 @@ The response contains a map of variable names to values, e.g.:
|
|
|
140
144
|
"typography/body/font-family": "Roboto"
|
|
141
145
|
```
|
|
142
146
|
|
|
143
|
-
Use `references/design-token-bridge.md` to map color and typography variables to Ignite UI theming inputs in Phase 3. Third-party kits name variables differently (`md.sys.color.primary`, `Colors/Brand/600`, `colorBrandBackground`, `primary-foreground`, …). Record them
|
|
147
|
+
Use `references/design-token-bridge.md` to map color and typography variables to Ignite UI theming inputs in Phase 3. Third-party kits name variables differently (`md.sys.color.primary`, `Colors/Brand/600`, `colorBrandBackground`, `primary-foreground`, …). Record them without changes. Phase 3 matches them to roles by **usage** (the Phase 1d color census), not by name.
|
|
148
|
+
|
|
149
|
+
Files without variables are normal for Tier C designs. For these files, the color census gives every seed. Do **not** try to map Figma spacing or sizing values. See `references/design-token-bridge.md § Spacing, Sizing, and Roundness` for the reason.
|
|
144
150
|
|
|
145
151
|
## 1f: Classify Provenance and Normalize Components
|
|
146
152
|
|
|
147
153
|
Read [design-provenance.md](design-provenance.md) in full.
|
|
148
154
|
|
|
149
|
-
1. Call `figma_get_libraries` **once per file**, if the connected server
|
|
155
|
+
1. Call `figma_get_libraries` **once per file**, if the connected server has it. The subscribed library names (`Indigo.Design UI Kit for Material`, `Material 3 Design Kit`, `shadcn/ui`, an in-house library) are the fastest provenance signal.
|
|
150
156
|
2. Check for Code Connect mappings:
|
|
151
157
|
|
|
152
158
|
```
|
|
@@ -154,16 +160,16 @@ Read [design-provenance.md](design-provenance.md) in full.
|
|
|
154
160
|
figma_get_code_connect_map({ nodeId: "<artboardId>" }) // desktop variant
|
|
155
161
|
```
|
|
156
162
|
|
|
157
|
-
Mappings are strong evidence of a component's **role and props**. They
|
|
163
|
+
Mappings are strong evidence of a component's **role and props**. They can point to **another library** (for example, a shadcn kit connected to `@/components/ui/button`). Never copy their imports or tags. The target is always Ignite UI for Web Components.
|
|
158
164
|
|
|
159
165
|
3. Classify **every** component-like layer as **Tier A** (Indigo.Design kit), **Tier B** (any other component library), or **Tier C** (un-componentized). Classify per instance, not per file.
|
|
160
|
-
4.
|
|
166
|
+
4. Use their variant properties to normalize Tier B instances to a canonical role + emphasis/style + measured height. When names are ambiguous and a file key and token are available, read the exact `componentProperties` from the REST API (`design-provenance.md § Step 1`).
|
|
161
167
|
5. Infer Tier C roles from structure and visuals. Mark them **low confidence**.
|
|
162
168
|
6. Record the dominant tier. It selects the Phase 3 theming path (A or B).
|
|
163
169
|
|
|
164
170
|
## 1g: Build the Decomposition Table
|
|
165
171
|
|
|
166
|
-
Before
|
|
172
|
+
Before you write code, produce **two tables** for **each artboard**.
|
|
167
173
|
|
|
168
174
|
### Table A — Ignite UI Components
|
|
169
175
|
|
|
@@ -176,35 +182,35 @@ Before writing any code, produce **two tables** for **each artboard**.
|
|
|
176
182
|
| _e.g._ `Segmented button` | B | M3 Design Kit | `toggle-group` · 40px | `<igc-button-group>` | `igniteui-webcomponents` | high | radius, colors | check icon on the selected segment | n/a |
|
|
177
183
|
| _e.g._ `Frame 427` | C | — | `tag` · pill · 24px | `<igc-badge>` | `igniteui-webcomponents` | low | radius, colors | — (confirm the role) | n/a |
|
|
178
184
|
|
|
179
|
-
The **Package** column is not optional in Web Components
|
|
185
|
+
The **Package** column is not optional in Web Components. General UI (`igniteui-webcomponents`, MIT), grids, charts, and dock manager ship as separate packages. The commercial packages come in trial and `@infragistics` licensed variants.
|
|
180
186
|
|
|
181
187
|
- **Token Work** lists what Phase 3 must set: colors, radius, borders, casing, size. These are implementation work. They are **never** anatomy deltas and never become Accepted.
|
|
182
|
-
- **Suspected Anatomy Deltas** lists only structural differences that tokens, documented `::part(...)` selectors, and slotted content cannot close.
|
|
188
|
+
- **Suspected Anatomy Deltas** lists only structural differences that tokens, documented `::part(...)` selectors, and slotted content cannot close. At this point, they are only suspicions. You know what Ignite UI renders only after you read its doc in Phase 2b. Confirm them in the Phase 2d ledger.
|
|
183
189
|
|
|
184
|
-
|
|
190
|
+
Use plain semantic HTML only when no Ignite UI component can match the layer. Make this decision after you read `references/figma-component-map.md`. Document the reason inline.
|
|
185
191
|
|
|
186
192
|
### Table B — Layout Surfaces
|
|
187
193
|
|
|
188
|
-
Record every **non-`igc-*` container** that
|
|
194
|
+
Record every **non-`igc-*` container** that has visual properties (background color, border, padding, shadow). These containers are plain `<div>` wrappers in the view, not Ignite UI components. But they are critical to visual fidelity. Fill this table from the `bg-[...]`, `rounded-[...]`, `border`, `p-[...]`, and `shadow-[...]` Tailwind classes on container divs. These classes are in the Phase 1d design context output.
|
|
189
195
|
|
|
190
196
|
| Figma Frame / Container Name | Background | Border-Radius | Padding | Border | Shadow | Encloses (child sections) |
|
|
191
197
|
| ---------------------------- | ---------- | ------------- | ------- | ------ | ------ | ------------------------- |
|
|
192
198
|
| _e.g._ `Budget Categories` | `#222222` | `4px` | `24px` | none | none | Categories list, Add button |
|
|
193
199
|
| _e.g._ `Friend Card` | `#222222` | `8px` | `24px 16px` | `1px solid #333` | none | Avatar, name, phone, email, buttons |
|
|
194
200
|
|
|
195
|
-
> **Rule:** if a section
|
|
201
|
+
> **Rule:** if a section is on a surface in Figma, it **must** have that background in the implementation. (A section is on a surface when its container has a non-transparent background.) If a section floats on the page background (transparent), do **not** add a surface wrapper. Never infer the surface structure from another page. Always derive it from the design context of the artboard that you implement.
|
|
196
202
|
|
|
197
|
-
|
|
203
|
+
Show both tables to the user for review before you continue. List the **low-confidence** mappings first, and ask the user to confirm or correct them. After Phase 4, a wrong role is the most expensive mistake to fix.
|
|
198
204
|
|
|
199
205
|
## 1h: Extract Image Assets
|
|
200
206
|
|
|
201
|
-
Read [references/asset-extraction.md](asset-extraction.md) in full before
|
|
207
|
+
Read [references/asset-extraction.md](asset-extraction.md) in full before you start an extraction.
|
|
202
208
|
|
|
203
|
-
**Zero-placeholder policy:** every image visible in the Figma design
|
|
209
|
+
**Zero-placeholder policy:** before Phase 4, extract every image that is visible in the Figma design. Commit each image to the project's assets directory. Do not use gradient placeholders.
|
|
204
210
|
|
|
205
|
-
**Step 0 — File key and token.** Reuse the file key from Phase 1 (the remote server always has one). On the desktop server
|
|
211
|
+
**Step 0 — File key and token.** Reuse the file key from Phase 1 (the remote server always has one). On the desktop server, if you have no file key, ask the user for the file URL (Figma desktop: right-click the file tab → **Copy link**). Tier 1 also needs a REST API token (`mcp-setup.md § Personal access token`). Without both, use Tier 2 or 3.
|
|
206
212
|
|
|
207
|
-
From the decomposition tables, identify every layer that is a **static image asset** (photo, background, logo, custom icon, illustration)
|
|
213
|
+
From the decomposition tables, identify every layer that is a **static image asset** (photo, background, logo, custom icon, illustration), not an Ignite UI component. Do **not** extract component instances that Table A maps to a component, from any kit. Also do not extract icons that a registerable icon package supplies (`figma-component-map.md § Icons`, which also covers third-party kit icon sets).
|
|
208
214
|
|
|
209
215
|
**Use the four-tier decision tree from `asset-extraction.md`** (these asset tiers 1–4 are unrelated to the provenance Tiers A–C):
|
|
210
216
|
|
|
@@ -215,8 +221,8 @@ From the decomposition tables, identify every layer that is a **static image ass
|
|
|
215
221
|
| **3** | `figma_get_screenshot` per node (`nodeId`, or the selection on desktop) | No REST access and no asset URL for this node |
|
|
216
222
|
| **4** | CSS gradient/color placeholder with `// TODO` comment | Only for confirmed pure-color fills — never as a shortcut |
|
|
217
223
|
|
|
218
|
-
Save assets
|
|
224
|
+
Save assets in the project's static directory. In a CLI-scaffolded Vite project, this is `src/assets/images/` and `src/assets/icons/` (`vite-plugin-static-copy` copies them to the build output). In a stock Vite app, this is `public/`. Use the directory that the project already uses.
|
|
219
225
|
|
|
220
|
-
Build a concise asset manifest (see `asset-extraction.md § Build an Asset Manifest`) so the implementation phase uses consistent paths.
|
|
226
|
+
Build a concise asset manifest (see `asset-extraction.md § Build an Asset Manifest`), so that the implementation phase uses consistent paths.
|
|
221
227
|
|
|
222
|
-
If you used Tier 2 or Tier 3 for
|
|
228
|
+
If you used Tier 2 or Tier 3 for an asset, tell the user. Identify the assets that need a new export when the file key and a REST API token are available.
|