@igniteui/angular-templates 21.1.14100-alpha.2 → 21.1.14100-alpha.3
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/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-components/SKILL.md +68 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-components/references/charts.md +457 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-components/references/data-display.md +360 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-components/references/directives.md +272 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-components/references/feedback.md +149 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-components/references/form-controls.md +313 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-components/references/layout-manager.md +420 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-components/references/layout.md +225 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-components/references/setup.md +166 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-grids/SKILL.md +110 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-grids/references/data-operations.md +445 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-grids/references/editing.md +491 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-grids/references/features.md +234 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-grids/references/paging-remote.md +397 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-grids/references/state.md +314 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-grids/references/structure.md +299 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-grids/references/types.md +507 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-theming/SKILL.md +439 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-theming/references/common-patterns.md +45 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-theming/references/contributing.md +471 -0
- package/igx-ts/projects/_base/files/__dot__claude/skills/igniteui-angular-theming/references/mcp-setup.md +77 -0
- package/igx-ts/projects/_base/files/__dot__vscode/mcp.json +2 -2
- package/package.json +2 -2
|
@@ -0,0 +1,439 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: igniteui-angular-theming
|
|
3
|
+
description: "Generates and customizes Ignite UI for Angular themes including color palettes, typography, elevations, and component-level styles using the Sass theming system and the igniteui-theming MCP server. Use when users ask to theme, restyle, or style Ignite UI components, change colors or the color palette, switch between light and dark themes, create or apply a global theme, customize typography or elevation shadows, adjust spacing, sizing, or roundness, or configure per-component design tokens. Do NOT use for component behavior, APIs, or data binding — use igniteui-angular-components or igniteui-angular-grids instead."
|
|
4
|
+
user-invocable: true
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Ignite UI for Angular — Theming Skill
|
|
8
|
+
|
|
9
|
+
## Description
|
|
10
|
+
|
|
11
|
+
This skill teaches AI agents how to theme Ignite UI for Angular applications using the Sass-based theming system and the **Ignite UI Theming MCP server**. It covers global themes, palettes, typography, elevations, component-level theming, layout controls (spacing, sizing, roundness), and how to use the MCP tools for code generation.
|
|
12
|
+
|
|
13
|
+
## Prerequisites
|
|
14
|
+
|
|
15
|
+
- An Angular project with `igniteui-angular` installed, **or** `@infragistics/igniteui-angular` for licensed users
|
|
16
|
+
- Sass support enabled in the project (default for Angular CLI projects)
|
|
17
|
+
- The **Ignite UI Theming MCP server** (`igniteui-theming`) available as a tool provider
|
|
18
|
+
|
|
19
|
+
> **AGENT INSTRUCTION — MCP Server Setup (REQUIRED)**
|
|
20
|
+
>
|
|
21
|
+
> Before using any theming tools, you MUST verify the MCP server is available
|
|
22
|
+
> by calling `detect_platform`. If the tool is not available or the call fails,
|
|
23
|
+
> you MUST automatically configure it by following the setup process steps described below.
|
|
24
|
+
>
|
|
25
|
+
> After writing the file, inform the user that the MCP server has been
|
|
26
|
+
> configured and they may need to reload the editor for the tools to activate.
|
|
27
|
+
> Start the MCP server and wait for that MCP server to start before continuing the theming related work.
|
|
28
|
+
> Do NOT skip this step or ask the user to do it manually.
|
|
29
|
+
|
|
30
|
+
## Setting Up the Theming MCP Server
|
|
31
|
+
|
|
32
|
+
> **Full setup instructions for VS Code, Cursor, Claude Desktop, and JetBrains IDEs are in [`references/mcp-setup.md`](./references/mcp-setup.md).** Read that file for editor-specific configuration steps and verification.
|
|
33
|
+
|
|
34
|
+
## Theming Architecture
|
|
35
|
+
|
|
36
|
+
> **Docs:** [Theming Overview](https://www.infragistics.com/products/ignite-ui-angular/angular/components/themes/index) · [Palette](https://www.infragistics.com/products/ignite-ui-angular/angular/components/themes/palettes) · [Typography](https://www.infragistics.com/products/ignite-ui-angular/angular/components/themes/typography) · [Elevations](https://www.infragistics.com/products/ignite-ui-angular/angular/components/themes/elevations)
|
|
37
|
+
|
|
38
|
+
The Ignite UI theming system is built on four pillars:
|
|
39
|
+
|
|
40
|
+
| Concept | Purpose |
|
|
41
|
+
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
|
42
|
+
| **Palette** | Color system with primary, secondary, surface, gray, info, success, warn, error families, each with shades 50–900 + accents A100–A700 |
|
|
43
|
+
| **Typography** | Font family, type scale (h1–h6, subtitle, body, button, caption, overline) |
|
|
44
|
+
| **Elevations** | Box-shadow levels 0–24 for visual depth |
|
|
45
|
+
| **Schema** | Per-component recipes mapping palette colors to component tokens |
|
|
46
|
+
|
|
47
|
+
### Design Systems
|
|
48
|
+
|
|
49
|
+
Four built-in design systems are available:
|
|
50
|
+
|
|
51
|
+
- **Material** (default) — Material Design 3
|
|
52
|
+
- **Bootstrap** — Bootstrap-inspired
|
|
53
|
+
- **Fluent** — Microsoft Fluent Design
|
|
54
|
+
- **Indigo** — Infragistics Indigo Design
|
|
55
|
+
|
|
56
|
+
Each has light and dark variants (e.g., `$light-material-schema`, `$dark-fluent-schema`).
|
|
57
|
+
|
|
58
|
+
## Pre-built Themes
|
|
59
|
+
|
|
60
|
+
The quickest way to theme an app is to include a pre-built CSS file in `angular.json`:
|
|
61
|
+
|
|
62
|
+
```json
|
|
63
|
+
"styles": ["node_modules/igniteui-angular/styles/igniteui-angular.css"]
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
> **Licensed package users:** replace `igniteui-angular` with `@infragistics/igniteui-angular` in the path:
|
|
67
|
+
> ```json
|
|
68
|
+
> "styles": ["node_modules/@infragistics/igniteui-angular/styles/igniteui-angular.css"]
|
|
69
|
+
> ```
|
|
70
|
+
|
|
71
|
+
Available pre-built CSS files:
|
|
72
|
+
|
|
73
|
+
| File | Theme |
|
|
74
|
+
| ------------------------------ | --------------- |
|
|
75
|
+
| `igniteui-angular.css` | Material Light |
|
|
76
|
+
| `igniteui-angular-dark.css` | Material Dark |
|
|
77
|
+
| `igniteui-fluent-light.css` | Fluent Light |
|
|
78
|
+
| `igniteui-fluent-dark.css` | Fluent Dark |
|
|
79
|
+
| `igniteui-bootstrap-light.css` | Bootstrap Light |
|
|
80
|
+
| `igniteui-bootstrap-dark.css` | Bootstrap Dark |
|
|
81
|
+
| `igniteui-indigo-light.css` | Indigo Light |
|
|
82
|
+
| `igniteui-indigo-dark.css` | Indigo Dark |
|
|
83
|
+
|
|
84
|
+
All files are located under `node_modules/igniteui-angular/styles/` (or `node_modules/@infragistics/igniteui-angular/styles/` for the licensed package).
|
|
85
|
+
|
|
86
|
+
## Custom Sass Theme (Manual)
|
|
87
|
+
|
|
88
|
+
> **AGENT INSTRUCTION — Sass Theming Docs**: If the user explicitly asks to build a Sass-based theme or configure Sass, refer to the dedicated Sass documentation:
|
|
89
|
+
>
|
|
90
|
+
> - [Sass Theming Overview](https://www.infragistics.com/products/ignite-ui-angular/angular/components/themes/sass/index)
|
|
91
|
+
> - [Sass Configuration](https://www.infragistics.com/products/ignite-ui-angular/angular/components/themes/sass/configuration)
|
|
92
|
+
> - [Sass Palettes](https://www.infragistics.com/products/ignite-ui-angular/angular/components/themes/sass/palettes)
|
|
93
|
+
> - [Sass Component Themes](https://www.infragistics.com/products/ignite-ui-angular/angular/components/themes/sass/component-themes)
|
|
94
|
+
|
|
95
|
+
Create a `styles.scss` file and include it in `angular.json`:
|
|
96
|
+
|
|
97
|
+
```scss
|
|
98
|
+
// Open-source package
|
|
99
|
+
@use 'igniteui-angular/theming' as *;
|
|
100
|
+
// Licensed package — same Sass API, different import path
|
|
101
|
+
// @use '@infragistics/igniteui-angular/theming' as *;
|
|
102
|
+
$my-palette: palette(
|
|
103
|
+
$primary: #1976d2,
|
|
104
|
+
$secondary: #ff9800,
|
|
105
|
+
$surface: #fafafa,
|
|
106
|
+
);
|
|
107
|
+
|
|
108
|
+
// 2. Typography (optional)
|
|
109
|
+
@include typography($font-family: $material-typeface, $type-scale: $material-type-scale);
|
|
110
|
+
|
|
111
|
+
// 3. Core reset & base styles
|
|
112
|
+
@include core();
|
|
113
|
+
|
|
114
|
+
// 4. Apply theme
|
|
115
|
+
@include theme($palette: $my-palette, $schema: $light-material-schema);
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
For dark themes, use a dark surface color and a dark schema:
|
|
119
|
+
|
|
120
|
+
```scss
|
|
121
|
+
$dark-palette: palette(
|
|
122
|
+
$primary: #90caf9,
|
|
123
|
+
$secondary: #ffb74d,
|
|
124
|
+
$surface: #121212,
|
|
125
|
+
);
|
|
126
|
+
|
|
127
|
+
@include theme($palette: $dark-palette, $schema: $dark-material-schema);
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
## Component-Level Theming
|
|
131
|
+
|
|
132
|
+
> **Docs:** [Component Themes](https://www.infragistics.com/products/ignite-ui-angular/angular/components/themes/sass/component-themes)
|
|
133
|
+
|
|
134
|
+
Override individual component appearance using component theme functions and the `tokens` mixin.
|
|
135
|
+
|
|
136
|
+
> **AGENT INSTRUCTION — No Hardcoded Colors (CRITICAL)**
|
|
137
|
+
>
|
|
138
|
+
> Once a palette has been generated (via `palette()` in Sass or `create_palette` / `create_theme` via MCP),
|
|
139
|
+
> **every color reference MUST come from the generated palette tokens** — never hardcode hex/RGB/HSL values.
|
|
140
|
+
>
|
|
141
|
+
> Use `var(--ig-primary-500)`, `var(--ig-secondary-300)`, `var(--ig-surface-500)`, etc. in CSS,
|
|
142
|
+
> or the `get_color` MCP tool to obtain the correct token reference.
|
|
143
|
+
>
|
|
144
|
+
> **WRONG** (hardcoded hex — breaks theme switching, ignores the palette):
|
|
145
|
+
>
|
|
146
|
+
> ```scss
|
|
147
|
+
> $custom-avatar: avatar-theme(
|
|
148
|
+
> $background: #e91e63,
|
|
149
|
+
> $color: #ffffff,
|
|
150
|
+
> );
|
|
151
|
+
> ```
|
|
152
|
+
>
|
|
153
|
+
> **RIGHT** (palette token — stays in sync with the theme):
|
|
154
|
+
>
|
|
155
|
+
> ```scss
|
|
156
|
+
> $custom-avatar: avatar-theme(
|
|
157
|
+
> $schema: $light-material-schema,
|
|
158
|
+
> $background: var(--ig-primary-500),
|
|
159
|
+
> $color: var(--ig-primary-500-contrast),
|
|
160
|
+
> );
|
|
161
|
+
> ```
|
|
162
|
+
>
|
|
163
|
+
> This applies to **all** style code: component themes, custom CSS rules, Sass variables used
|
|
164
|
+
> for borders/backgrounds/text, Angular `host` bindings, and inline styles.
|
|
165
|
+
> The only place raw hex values belong is the **initial `palette()` call** that seeds the color system.
|
|
166
|
+
> Everything downstream must reference the palette.
|
|
167
|
+
|
|
168
|
+
```scss
|
|
169
|
+
@use 'igniteui-angular/theming' as *;
|
|
170
|
+
|
|
171
|
+
$custom-avatar: avatar-theme(
|
|
172
|
+
$schema: $light-material-schema,
|
|
173
|
+
$background: var(--ig-primary-500),
|
|
174
|
+
$color: var(--ig-primary-500-contrast),
|
|
175
|
+
);
|
|
176
|
+
|
|
177
|
+
igx-avatar {
|
|
178
|
+
@include tokens($custom-avatar);
|
|
179
|
+
}
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
### Discovering Available Tokens
|
|
183
|
+
|
|
184
|
+
Each component has its own set of design tokens (themeable CSS custom properties). Before theming a component, you must know which tokens exist. Use the **MCP tool** `get_component_design_tokens` to discover them.
|
|
185
|
+
|
|
186
|
+
### Compound Components
|
|
187
|
+
|
|
188
|
+
Some components (e.g., `combo`, `grid`, `date-picker`, `select`) are **compound** — they contain internal child components, each requiring their own theme. For example, `date-picker` uses `calendar`, `flat-button`, and `input-group` internally.
|
|
189
|
+
|
|
190
|
+
Workflow for compound components:
|
|
191
|
+
1. Call `get_component_design_tokens` for the parent (e.g., `date-picker`)
|
|
192
|
+
2. The response lists related themes and scope selectors
|
|
193
|
+
3. Call `create_component_theme` for each child, using the parent's selector as the wrapper
|
|
194
|
+
|
|
195
|
+
## Layout Controls
|
|
196
|
+
|
|
197
|
+
### Sizing
|
|
198
|
+
|
|
199
|
+
> **Docs:** [Display Density / Sizing](https://www.infragistics.com/products/ignite-ui-angular/angular/components/display-density)
|
|
200
|
+
|
|
201
|
+
Controls the size of components via `--ig-size` (values: 1 = small, 2 = medium, 3 = large):
|
|
202
|
+
|
|
203
|
+
```css
|
|
204
|
+
/* Global */
|
|
205
|
+
:root {
|
|
206
|
+
--ig-size: 2;
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
/* Component-scoped */
|
|
210
|
+
igx-grid {
|
|
211
|
+
--ig-size: 1;
|
|
212
|
+
}
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
### Spacing
|
|
216
|
+
|
|
217
|
+
> **Docs:** [Spacing](https://www.infragistics.com/products/ignite-ui-angular/angular/components/themes/spacing)
|
|
218
|
+
|
|
219
|
+
Controls internal padding via `--ig-spacing` (1 = default, 0.5 = compact, 2 = spacious):
|
|
220
|
+
|
|
221
|
+
```css
|
|
222
|
+
:root {
|
|
223
|
+
--ig-spacing: 1;
|
|
224
|
+
}
|
|
225
|
+
.compact-section {
|
|
226
|
+
--ig-spacing: 0.75;
|
|
227
|
+
}
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
### Roundness
|
|
231
|
+
|
|
232
|
+
Controls border-radius via `--ig-radius-factor` (0 = square, 1 = maximum radius):
|
|
233
|
+
|
|
234
|
+
```css
|
|
235
|
+
:root {
|
|
236
|
+
--ig-radius-factor: 1;
|
|
237
|
+
}
|
|
238
|
+
igx-avatar {
|
|
239
|
+
--ig-radius-factor: 0.5;
|
|
240
|
+
}
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
## Using the Theming MCP Server
|
|
244
|
+
|
|
245
|
+
The Ignite UI Theming MCP server provides tools for AI-assisted theme code generation.
|
|
246
|
+
|
|
247
|
+
> **IMPORTANT — File Safety Rule**: When generating or updating theme code, **never overwrite existing style files directly**. Instead, always **propose the changes as an update** and let the user review and approve before writing to disk. If a `styles.scss` (or any target file) already exists, show the generated code as a diff or suggestion rather than replacing the file contents. This prevents accidental loss of custom styles the user has already written.
|
|
248
|
+
|
|
249
|
+
Always follow this workflow:
|
|
250
|
+
|
|
251
|
+
### Step 1 — Detect Platform
|
|
252
|
+
|
|
253
|
+
```
|
|
254
|
+
Tool: detect_platform
|
|
255
|
+
```
|
|
256
|
+
This auto-detects `angular` from `package.json` and sets the correct import paths.
|
|
257
|
+
|
|
258
|
+
### Step 2 — Generate a Full Theme
|
|
259
|
+
|
|
260
|
+
```
|
|
261
|
+
Tool: create_theme
|
|
262
|
+
Params: {
|
|
263
|
+
platform: "angular",
|
|
264
|
+
designSystem: "material",
|
|
265
|
+
primaryColor: "#1976D2",
|
|
266
|
+
secondaryColor: "#FF9800",
|
|
267
|
+
surfaceColor: "#FAFAFA",
|
|
268
|
+
variant: "light",
|
|
269
|
+
fontFamily: "'Roboto', sans-serif",
|
|
270
|
+
includeTypography: true,
|
|
271
|
+
includeElevations: true
|
|
272
|
+
}
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
Generates a complete Sass file with palette, typography, elevations, and the `theme()` mixin call.
|
|
276
|
+
|
|
277
|
+
### Step 3 — Customize Individual Components
|
|
278
|
+
|
|
279
|
+
```
|
|
280
|
+
Tool: get_component_design_tokens
|
|
281
|
+
Params: { component: "grid" }
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
Then use **palette token references** (not hardcoded hex values) for every color:
|
|
285
|
+
|
|
286
|
+
```
|
|
287
|
+
Tool: create_component_theme
|
|
288
|
+
Params: {
|
|
289
|
+
platform: "angular",
|
|
290
|
+
designSystem: "material",
|
|
291
|
+
variant: "light",
|
|
292
|
+
component: "grid",
|
|
293
|
+
tokens: {
|
|
294
|
+
"header-background": "var(--ig-primary-50)",
|
|
295
|
+
"header-text-color": "var(--ig-primary-800)"
|
|
296
|
+
}
|
|
297
|
+
}
|
|
298
|
+
```
|
|
299
|
+
|
|
300
|
+
> **Reminder**: After a palette is generated, all token values passed to
|
|
301
|
+
> `create_component_theme` must reference palette CSS custom properties
|
|
302
|
+
> (e.g., `var(--ig-primary-500)`, `var(--ig-secondary-A200)`,
|
|
303
|
+
> `var(--ig-gray-100)`). Never pass raw hex values like `"#E3F2FD"`.
|
|
304
|
+
|
|
305
|
+
### Step 4 — Generate a Palette
|
|
306
|
+
|
|
307
|
+
For simple mid-luminance base colors:
|
|
308
|
+
|
|
309
|
+
```
|
|
310
|
+
Tool: create_palette
|
|
311
|
+
Params: {
|
|
312
|
+
platform: "angular",
|
|
313
|
+
primary: "#1976D2",
|
|
314
|
+
secondary: "#FF9800",
|
|
315
|
+
surface: "#FAFAFA",
|
|
316
|
+
variant: "light"
|
|
317
|
+
}
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
For brand-specific exact shade values, use `create_custom_palette` with `mode: "explicit"` for full control over each shade.
|
|
321
|
+
|
|
322
|
+
### Step 5 — Adjust Layout
|
|
323
|
+
|
|
324
|
+
```
|
|
325
|
+
Tool: set_size → { size: "medium" }
|
|
326
|
+
Tool: set_spacing → { spacing: 0.75, component: "grid" }
|
|
327
|
+
Tool: set_roundness → { radiusFactor: 0.8 }
|
|
328
|
+
```
|
|
329
|
+
|
|
330
|
+
### Step 6 — Reference Palette Colors (MANDATORY for All Color Usage)
|
|
331
|
+
|
|
332
|
+
After a palette is generated, **always** use the `get_color` tool to obtain the correct CSS custom property reference. Never hardcode hex/RGB/HSL values in component themes, custom CSS, or Sass variables.
|
|
333
|
+
|
|
334
|
+
```
|
|
335
|
+
Tool: get_color
|
|
336
|
+
Params: { color: "primary", variant: "600" }
|
|
337
|
+
→ var(--ig-primary-600)
|
|
338
|
+
|
|
339
|
+
Params: { color: "primary", variant: "600", contrast: true }
|
|
340
|
+
→ var(--ig-primary-600-contrast)
|
|
341
|
+
|
|
342
|
+
Params: { color: "primary", opacity: 0.5 }
|
|
343
|
+
→ hsl(from var(--ig-primary-500) h s l / 0.5)
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
Use these token references everywhere:
|
|
347
|
+
- Component theme `tokens` values
|
|
348
|
+
- Custom CSS rules (`color`, `background`, `border-color`, `fill`, `stroke`, etc.)
|
|
349
|
+
- Sass variables for derived values (`$sidebar-bg: var(--ig-surface-500);`)
|
|
350
|
+
- Angular `host` style bindings
|
|
351
|
+
|
|
352
|
+
The **only** place raw hex values are acceptable is in the initial `palette()` call or the `create_palette` / `create_theme` MCP tool inputs that seed the color system.
|
|
353
|
+
|
|
354
|
+
### Loading Reference Data
|
|
355
|
+
|
|
356
|
+
Use `read_resource` with these URIs for preset values and documentation:
|
|
357
|
+
|
|
358
|
+
| URI | Content |
|
|
359
|
+
| --------------------------------- | ------------------------------ |
|
|
360
|
+
| `theming://presets/palettes` | Preset palette colors |
|
|
361
|
+
| `theming://presets/typography` | Typography presets |
|
|
362
|
+
| `theming://presets/elevations` | Elevation shadow presets |
|
|
363
|
+
| `theming://guidance/colors/usage` | Which shades for which purpose |
|
|
364
|
+
| `theming://guidance/colors/roles` | Semantic color roles |
|
|
365
|
+
| `theming://guidance/colors/rules` | Light/dark theme rules |
|
|
366
|
+
| `theming://platforms/angular` | Angular platform specifics |
|
|
367
|
+
|
|
368
|
+
## Referencing Colors in Custom Styles
|
|
369
|
+
|
|
370
|
+
After a theme is applied, the palette is available as CSS custom properties on `:root`. Use these tokens in all custom CSS — never introduce standalone hex/RGB variables for colors that the palette already provides.
|
|
371
|
+
|
|
372
|
+
### Correct: Palette Tokens
|
|
373
|
+
|
|
374
|
+
```scss
|
|
375
|
+
// All colors come from the theme — respects palette changes and dark/light switching
|
|
376
|
+
.sidebar {
|
|
377
|
+
background: var(--ig-surface-500);
|
|
378
|
+
color: var(--ig-gray-900);
|
|
379
|
+
border-right: 1px solid var(--ig-gray-200);
|
|
380
|
+
}
|
|
381
|
+
|
|
382
|
+
.accent-badge {
|
|
383
|
+
background: var(--ig-secondary-500);
|
|
384
|
+
color: var(--ig-secondary-500-contrast);
|
|
385
|
+
}
|
|
386
|
+
|
|
387
|
+
.hero-section {
|
|
388
|
+
// Semi-transparent primary overlay
|
|
389
|
+
background: hsl(from var(--ig-primary-500) h s l / 0.12);
|
|
390
|
+
}
|
|
391
|
+
```
|
|
392
|
+
|
|
393
|
+
### Incorrect: Hardcoded Values
|
|
394
|
+
|
|
395
|
+
```scss
|
|
396
|
+
// WRONG — these break when the palette changes and ignore dark/light mode
|
|
397
|
+
$primary-color: #00838f; // ✗ hardcoded
|
|
398
|
+
$secondary-color: #3d5afe; // ✗ hardcoded
|
|
399
|
+
$surface-color: #f0f5fa; // ✗ hardcoded
|
|
400
|
+
|
|
401
|
+
.sidebar {
|
|
402
|
+
background: $surface-color; // ✗ not a palette token
|
|
403
|
+
color: #333; // ✗ not a palette token
|
|
404
|
+
}
|
|
405
|
+
```
|
|
406
|
+
|
|
407
|
+
### When Raw Hex Values Are OK
|
|
408
|
+
|
|
409
|
+
Raw hex values are acceptable **only** in these contexts:
|
|
410
|
+
|
|
411
|
+
1. **`palette()` call** — the initial seed colors that generate the full palette
|
|
412
|
+
2. **`create_palette` / `create_theme` MCP tool inputs** — the base colors passed to the tool
|
|
413
|
+
3. **Non-palette decorative values** — e.g., a one-off SVG illustration color that intentionally stays fixed regardless of theme
|
|
414
|
+
|
|
415
|
+
Everything else must use `var(--ig-<family>-<shade>)` tokens.
|
|
416
|
+
|
|
417
|
+
## Contributing to Component Themes
|
|
418
|
+
> **Contributing to the in-repo SCSS source (component theme files, structural SCSS, base functions, and the component registry) is covered in [`references/contributing.md`](./references/contributing.md).** Read that file when modifying or creating `_*-theme.scss` or `_*-component.scss` files, wiring a new component into the theme system, or writing style tests.
|
|
419
|
+
|
|
420
|
+
## Common Patterns
|
|
421
|
+
|
|
422
|
+
> **Light/dark theme switching, scoped themes, and licensed package configuration are in [`references/common-patterns.md`](./references/common-patterns.md).** Read that file for ready-to-use Sass patterns.
|
|
423
|
+
|
|
424
|
+
## Key Rules
|
|
425
|
+
|
|
426
|
+
1. **Never overwrite existing files directly** — always propose theme code as an update for user review; do not replace existing style files without confirmation
|
|
427
|
+
2. **Always call `detect_platform` first** when using MCP tools
|
|
428
|
+
3. **Always call `get_component_design_tokens` before `create_component_theme`** to discover valid token names
|
|
429
|
+
4. **Palette shades 50 = lightest, 900 = darkest** for all chromatic colors — never invert for dark themes (only gray inverts)
|
|
430
|
+
5. **Surface color must match the variant** — light color for `light`, dark color for `dark`
|
|
431
|
+
6. **Use `@include core()` once** before `@include theme()` in your global styles
|
|
432
|
+
7. **Component themes use `@include tokens($theme)`** inside a selector to emit CSS custom properties
|
|
433
|
+
8. **For compound components**, follow the full checklist returned by `get_component_design_tokens` — theme each child component with its scoped selector
|
|
434
|
+
9. **Never hardcode colors after palette generation** — once a palette is created, every color in component themes, custom CSS, and Sass variables must use `var(--ig-<family>-<shade>)` palette tokens (e.g., `var(--ig-primary-500)`, `var(--ig-gray-200)`). Raw hex/RGB/HSL values are only acceptable in the initial `palette()` seed call. This ensures themes remain consistent, switchable (light/dark), and maintainable
|
|
435
|
+
|
|
436
|
+
## Related Skills
|
|
437
|
+
|
|
438
|
+
- [`igniteui-angular-components`](../igniteui-angular-components/SKILL.md) — UI components (form controls, layout, data display, feedback/overlays, directives, charts)
|
|
439
|
+
- [`igniteui-angular-grids`](../igniteui-angular-grids/SKILL.md) — Data Grids (Flat Grid, Tree Grid, Hierarchical Grid, Grid Lite, Pivot Grid)
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Common Theming Patterns
|
|
2
|
+
|
|
3
|
+
> **Part of the [`igniteui-angular-theming`](../SKILL.md) skill hub.**
|
|
4
|
+
|
|
5
|
+
## Contents
|
|
6
|
+
|
|
7
|
+
- [Switching Between Light and Dark Themes](#switching-between-light-and-dark-themes)
|
|
8
|
+
- [Scoping a Theme to a Container](#scoping-a-theme-to-a-container)
|
|
9
|
+
- [Licensed Package Users](#licensed-package-users)
|
|
10
|
+
|
|
11
|
+
## Switching Between Light and Dark Themes
|
|
12
|
+
|
|
13
|
+
```scss
|
|
14
|
+
@use 'igniteui-angular/theming' as *;
|
|
15
|
+
|
|
16
|
+
$light-palette: palette($primary: #1976D2, $secondary: #FF9800, $surface: #FAFAFA);
|
|
17
|
+
$dark-palette: palette($primary: #90CAF9, $secondary: #FFB74D, $surface: #121212);
|
|
18
|
+
|
|
19
|
+
@include core();
|
|
20
|
+
@include typography($font-family: $material-typeface, $type-scale: $material-type-scale);
|
|
21
|
+
|
|
22
|
+
// Light is default
|
|
23
|
+
@include theme($palette: $light-palette, $schema: $light-material-schema);
|
|
24
|
+
|
|
25
|
+
// Dark via class on <body> or <html>
|
|
26
|
+
.dark-theme {
|
|
27
|
+
@include theme($palette: $dark-palette, $schema: $dark-material-schema);
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Scoping a Theme to a Container
|
|
32
|
+
|
|
33
|
+
```scss
|
|
34
|
+
.admin-panel {
|
|
35
|
+
@include theme($palette: $admin-palette, $schema: $light-indigo-schema);
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Licensed Package Users
|
|
40
|
+
|
|
41
|
+
If using the licensed `@infragistics/igniteui-angular` package, set `licensed: true` on MCP tool calls and change the Sass import:
|
|
42
|
+
|
|
43
|
+
```scss
|
|
44
|
+
@use '@infragistics/igniteui-angular/theming' as *;
|
|
45
|
+
```
|