igniteui-cli 15.8.1 → 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
|
@@ -30,17 +30,17 @@
|
|
|
30
30
|
|
|
31
31
|
Decision rule:
|
|
32
32
|
|
|
33
|
-
- Use `IgcNavbarComponent` for a top horizontal bar when its slot structure and behavior match the screenshot. Use slotted content and CSS flex overrides to
|
|
34
|
-
- Use `IgcNavDrawerComponent` for a sidebar or side-navigation panel when drawer structure and behavior match the screenshot. Configure `open`, `position`, and mini content
|
|
33
|
+
- Use `IgcNavbarComponent` for a top horizontal bar when its slot structure and behavior match the screenshot. Use slotted content and CSS flex overrides to make multi-zone layouts inside it. Use a plain `<header>` when that is a closer structural fit.
|
|
34
|
+
- Use `IgcNavDrawerComponent` for a sidebar or side-navigation panel when drawer structure and behavior match the screenshot. Configure `open`, `position`, and mini content for the navigation type in the design: fixed, collapsible, or icon-only. Use a plain `<aside>` when a static custom sidebar matches the screenshot better.
|
|
35
35
|
- Use `IgcTabsComponent` for a horizontal tab strip when the screenshot clearly shows tabbed state switching.
|
|
36
|
-
- Use `IgcDockManagerComponent` only when the screenshot
|
|
36
|
+
- Use `IgcDockManagerComponent` only when the screenshot clearly shows docked, floating, or IDE-like panels. Do not use it as a substitute for a basic dashboard grid.
|
|
37
37
|
|
|
38
38
|
Component decision matrix (by visual pattern, domain-neutral):
|
|
39
39
|
|
|
40
40
|
| Visual Pattern | Recommended Component | Notes |
|
|
41
41
|
|---|---|---|
|
|
42
|
-
| Repeated rows with icon/text/action | `IgcListComponent` + `IgcListItemComponent` | Use when the row anatomy and interaction model match
|
|
43
|
-
| Spreadsheet-like editable or sortable table | `IgcGridComponent` | Use `igniteui-grid-lite` for lightweight tables
|
|
42
|
+
| Repeated rows with icon/text/action | `IgcListComponent` + `IgcListItemComponent` | Use when the row anatomy and interaction model match. Use `slot="title"`, `slot="subtitle"`, `slot="start"`, `slot="end"`. Use native `<ul>/<li>` or custom containers when that is a closer visual fit |
|
|
43
|
+
| Spreadsheet-like editable or sortable table | `IgcGridComponent` | Use `igniteui-grid-lite` for lightweight tables. Use advanced grid packages when the screenshot needs built-in editing, paging, filtering, grouping, summaries, hierarchy, or pivoting |
|
|
44
44
|
| Hierarchical or tree-structured table | `IgcTreeGridComponent` or `IgcHierarchicalGridComponent` | Use when rows have parent-child or master-detail relationships |
|
|
45
45
|
| Content blocks / summary cards | `IgcCardComponent` | Use when card chrome helps match the panel shape and structure. Use header/content/actions subcomponents with slotted content. Use plain `<div>` containers for flat or highly custom tiles |
|
|
46
46
|
| Any text input field | `IgcInputComponent` | Use when the input anatomy matches the screenshot, including search fields and inline editors. Apply CSS and tokens to match the screenshot's border/radius style |
|
|
@@ -49,7 +49,7 @@ Component decision matrix (by visual pattern, domain-neutral):
|
|
|
49
49
|
| Multi-step form / wizard | `IgcStepperComponent` | Use when a sequence of steps is visually present |
|
|
50
50
|
| Filter chips / tag inputs | `IgcChipComponent` | Use when chip anatomy matches status badges, filter tags, or removable labels in the screenshot |
|
|
51
51
|
| Calendar or date picker as a primary view element | `IgcCalendarComponent`, `IgcDatePickerComponent`, `IgcDateRangePickerComponent` | Use when scheduling or date selection is the core UI |
|
|
52
|
-
| Top icon/action bar | `IgcNavbarComponent` with slotted icon buttons | Use when a navbar structure matches the screenshot
|
|
52
|
+
| Top icon/action bar | `IgcNavbarComponent` with slotted icon buttons | Use when a navbar structure matches the screenshot. Use plain icon buttons or custom containers when that is a closer fit |
|
|
53
53
|
|
|
54
54
|
## Chart Components
|
|
55
55
|
|
|
@@ -70,7 +70,7 @@ Component decision matrix (by visual pattern, domain-neutral):
|
|
|
70
70
|
Decision rule:
|
|
71
71
|
|
|
72
72
|
- Financial or OHLC screenshot: prefer `IgcFinancialChartComponent`.
|
|
73
|
-
- Simple or moderate trend panel: prefer `IgcCategoryChartComponent
|
|
73
|
+
- Simple or moderate trend panel: prefer `IgcCategoryChartComponent`. Use `IgcDataChartComponent` when you need lower-level per-series control.
|
|
74
74
|
- Highly custom sparkline or microchart: use `IgcSparklineComponent` or a custom fallback if the built-in anatomy is not a close visual match.
|
|
75
75
|
|
|
76
76
|
## Data Display Components
|
|
@@ -90,9 +90,9 @@ Decision rule:
|
|
|
90
90
|
Decision rule:
|
|
91
91
|
|
|
92
92
|
- Use `IgcListComponent` for repeated-row content lists when its row structure and interaction model match the screenshot. The component adds accessible keyboard navigation, item structure, and theming when those benefits fit the design. Use native `<ul>/<li>` or custom containers when they are a closer visual fit.
|
|
93
|
-
- Choose `IgcGridComponent` only when the image is
|
|
93
|
+
- Choose `IgcGridComponent` only when the image is clearly tabular (flat rows and columns, spreadsheet-style). Use the required behavior to decide if the lightweight or the advanced grid package is the correct fit.
|
|
94
94
|
- Choose `IgcTreeGridComponent` or `IgcHierarchicalGridComponent` when rows have parent-child or nested structure.
|
|
95
|
-
- Use `IgcChipComponent` when chip anatomy matches the screenshot's status badges, tags, or label pills. Use custom badge or pill markup when a simpler or more exact visual match
|
|
95
|
+
- Use `IgcChipComponent` when chip anatomy matches the screenshot's status badges, tags, or label pills. Use custom badge or pill markup when you need a simpler or more exact visual match.
|
|
96
96
|
|
|
97
97
|
## Form & Input Components
|
|
98
98
|
|
|
@@ -122,10 +122,10 @@ Decision rule:
|
|
|
122
122
|
|
|
123
123
|
See [`igniteui-wc-choose-components`](../../igniteui-wc-choose-components/SKILL.md) for the full package routing table (general UI, grids, charts, dock manager, trial vs. licensed).
|
|
124
124
|
|
|
125
|
-
Install only the packages
|
|
125
|
+
Install only the packages that the selected components require.
|
|
126
126
|
|
|
127
127
|
## Import Patterns
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
Use this file as a component selection reference, not as authoritative import guidance for a specific repository. Confirm the exact imports and registration from `detect_platform`, the current workspace, framework setup, and `get_doc` results.
|
|
130
130
|
|
|
131
|
-
For direct Web Components usage, import the component classes from the selected package
|
|
131
|
+
For direct Web Components usage, import the component classes from the selected package. Register only the necessary elements with `defineComponents(...)`. If the host app uses React, Angular, Vue, or another wrapper pattern around Web Components, follow [`igniteui-wc-integrate-with-framework`](../../igniteui-wc-integrate-with-framework/SKILL.md) for the final setup details.
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
## Component Registration
|
|
11
11
|
|
|
12
12
|
### `defineComponents(...)` is required for direct Web Components usage
|
|
13
|
-
Register only the custom elements you
|
|
13
|
+
Register only the custom elements that you use. Register them from the correct package:
|
|
14
14
|
```ts
|
|
15
15
|
import {
|
|
16
16
|
defineComponents,
|
|
@@ -21,14 +21,14 @@ import {
|
|
|
21
21
|
defineComponents(IgcNavbarComponent, IgcCardComponent);
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
If the current app uses React, Angular, Vue, or another integration layer around Web Components, follow [`igniteui-wc-integrate-with-framework`](../../igniteui-wc-integrate-with-framework/SKILL.md)
|
|
24
|
+
If the current app uses React, Angular, Vue, or another integration layer around Web Components, follow [`igniteui-wc-integrate-with-framework`](../../igniteui-wc-integrate-with-framework/SKILL.md). Do not copy these registration patterns without a check.
|
|
25
25
|
|
|
26
26
|
### Package family matters
|
|
27
|
-
Do not assume
|
|
27
|
+
Do not assume that all components come from `igniteui-webcomponents`. Advanced grids, charts, and dock manager are in separate packages. These packages can have different names for the trial and the licensed versions. First, resolve the package. Then register components from that package.
|
|
28
28
|
|
|
29
29
|
## Chart Properties
|
|
30
30
|
|
|
31
|
-
> **Always use the MCP lookup pattern before
|
|
31
|
+
> **Always use the MCP lookup pattern before you write code for a chart.** Chart APIs are large and change between versions.
|
|
32
32
|
> - Find doc names → `list_components({ framework: "webcomponents", filter: "chart" })`
|
|
33
33
|
> - Usage examples and slots → `get_doc({ framework: "webcomponents", name: "<doc-name>" })`
|
|
34
34
|
> - Find exact class names → `search_api({ platform: "webcomponents", query: "<keyword>" })`
|
|
@@ -38,7 +38,7 @@ Do not assume everything comes from `igniteui-webcomponents`. Advanced grids, ch
|
|
|
38
38
|
Category charts can show markers by default. If the screenshot does not show markers, set `markerTypes` to the matching no-marker option documented for the component. Confirm the exact value shape from `get_doc`.
|
|
39
39
|
|
|
40
40
|
### `plotAreaBackground` and `areaFillOpacity` are inherited — not visible in `get_api_reference`
|
|
41
|
-
Both properties exist but
|
|
41
|
+
Both properties exist, but parent classes define them. Thus, `get_api_reference({ platform: "webcomponents", component: "IgcCategoryChartComponent" })` does not list them. Use `search_api` to find them:
|
|
42
42
|
```ts
|
|
43
43
|
chart.plotAreaBackground = 'transparent'; // inherited from IgcSeriesViewerComponent
|
|
44
44
|
chart.areaFillOpacity = 0.3; // inherited from IgcDomainChartComponent (not on IgcSparklineComponent)
|
|
@@ -53,18 +53,18 @@ chart.includedProperties = ['fieldOne', 'fieldTwo', 'fieldThree'];
|
|
|
53
53
|
Replace `'fieldOne'`, `'fieldTwo'`, etc. with the actual data property names from your mock data.
|
|
54
54
|
|
|
55
55
|
### Chart callback properties must be assigned as functions
|
|
56
|
-
|
|
56
|
+
Assign function-valued chart APIs on the element instance. Do not pass them as string attributes:
|
|
57
57
|
```ts
|
|
58
58
|
const chart = document.querySelector('igc-category-chart');
|
|
59
59
|
chart.xAxisFormatLabel = labelFormatter;
|
|
60
60
|
```
|
|
61
61
|
|
|
62
62
|
### Smooth area charts
|
|
63
|
-
For smooth
|
|
64
|
-
- Increase data density until the line or area
|
|
65
|
-
- Apply smoothing only when the source shape in the design looks smoothed
|
|
63
|
+
For a smooth area chart in which the data must look continuous, not spiky:
|
|
64
|
+
- Increase data density until the line or area looks continuous at the rendered size.
|
|
65
|
+
- Apply smoothing only when the source shape in the design looks smoothed, not point-to-point.
|
|
66
66
|
- Hide markers unless the screenshot clearly shows visible data points.
|
|
67
|
-
- Tune fill opacity and label density to match the screenshot
|
|
67
|
+
- Tune fill opacity and label density to match the screenshot. Do not use a fixed default.
|
|
68
68
|
|
|
69
69
|
### Charts inside CSS Grid can collapse
|
|
70
70
|
In a flexible CSS Grid track, set the grid cell and chart sizing values explicitly so the chart does not collapse:
|
|
@@ -98,7 +98,7 @@ Use the Web Components slot anatomy:
|
|
|
98
98
|
```
|
|
99
99
|
|
|
100
100
|
### Nav drawer width
|
|
101
|
-
|
|
101
|
+
The `navdrawer` design tokens `size` and `size--mini` set the width. They are exposed as `--ig-nav-drawer-size` (default 15rem) and `--ig-nav-drawer-size--mini` (the default depends on the design system). Set them with `create_component_theme("navdrawer", …)`, or set them directly:
|
|
102
102
|
```css
|
|
103
103
|
igc-nav-drawer {
|
|
104
104
|
--ig-nav-drawer-size: 280px;
|
|
@@ -107,9 +107,9 @@ igc-nav-drawer {
|
|
|
107
107
|
```
|
|
108
108
|
|
|
109
109
|
### Omit column `width` — both grid types are fluid by default
|
|
110
|
-
|
|
110
|
+
Explicit pixel widths prevent columns from filling the container and leave empty space at the end. When `width` is not set, both `igc-grid-lite-column` and `igc-column` are fluid by default.
|
|
111
111
|
|
|
112
|
-
When some columns need a fixed size, apply `width` only to those
|
|
112
|
+
When some columns need a fixed size, apply `width` only to those columns. Leave **at least one column without `width`** so that it fills the remaining space. The pattern is the same for both grid types. Change the tag name to match the grid that you use:
|
|
113
113
|
|
|
114
114
|
```html
|
|
115
115
|
<!-- replace igc-grid-lite-column with igc-column for the Premium Grid -->
|
|
@@ -118,27 +118,27 @@ When some columns need a fixed size, apply `width` only to those and leave **at
|
|
|
118
118
|
<igc-grid-lite-column field="name" header="Name">{/* no width — fills remaining space */}</igc-grid-lite-column>
|
|
119
119
|
```
|
|
120
120
|
|
|
121
|
-
When a Grid Lite column has `width` set and `resizable` enabled, use `px
|
|
121
|
+
When a Grid Lite column has `width` set and `resizable` enabled, use `px`. Do not use `%` or other relative units, because they cause layout shifts during resize.
|
|
122
122
|
|
|
123
123
|
## Theming Pitfalls
|
|
124
124
|
|
|
125
125
|
### Never hardcode colors after palette generation
|
|
126
|
-
|
|
126
|
+
After a palette or theme exists, use `get_color` and palette-backed CSS custom properties, such as `<resolved-palette-token-reference>`. You can also use semantic CSS variables that derive from them. Do not leave raw hex values in component styles, theme overrides, or one-off CSS rules. The only exception is a value that is intentionally outside the theme system.
|
|
127
127
|
|
|
128
128
|
### Compound components require child theming
|
|
129
|
-
`igc-select`, `igc-combo`, `igc-date-picker`, and `igc-date-range-picker` are compound components. Follow the related-theme chain
|
|
129
|
+
`igc-select`, `igc-combo`, `igc-date-picker`, and `igc-date-range-picker` are compound components. Follow the related-theme chain that `get_component_design_tokens` returns. Do not style only the parent selector.
|
|
130
130
|
|
|
131
131
|
### Component theme functions
|
|
132
|
-
|
|
132
|
+
To theme core UI components, prefer `create_component_theme`. Apply the returned theme block as the MCP server generates it.
|
|
133
133
|
|
|
134
134
|
### Grid theming is package-specific
|
|
135
|
-
`igniteui-grid-lite` and the premium grid packages do not map to Angular's `igx-grid__*` internal class structure. Use `get_component_design_tokens("grid")
|
|
135
|
+
`igniteui-grid-lite` and the premium grid packages do not map to Angular's `igx-grid__*` internal class structure. Use `get_component_design_tokens("grid")` and the docs of the exact grid package. Also use the exposed tokens or parts of the package in the workspace.
|
|
136
136
|
|
|
137
137
|
### `igniteui-webcomponents-grids` theme must be injected into the shadow root
|
|
138
138
|
|
|
139
|
-
A bare CSS import (`import '...material.css'`)
|
|
139
|
+
A bare CSS import (`import '...material.css'`) goes into the document head. Selector rules outside a Shadow root do not apply inside it. When the grid renders inside a Shadow root, inject the theme there too. The theme targets the internal structure and elements of the grid. Without it, internal grid elements render with incorrect dimensions. Checkboxes can expand to 1,100 px wide and collapse the full grid UI.
|
|
140
140
|
|
|
141
|
-
Import the theme as an inline string
|
|
141
|
+
Import the theme as an inline string. This requires bundler support for `?inline`, for example Vite. Inject the theme as a `<style>` tag inside the shadow root. The exact approach depends on the framework. For a LitElement component, render the tag at the top of `render()`:
|
|
142
142
|
|
|
143
143
|
```typescript
|
|
144
144
|
import { html } from 'lit';
|
|
@@ -156,7 +156,7 @@ render() {
|
|
|
156
156
|
Apply the same `?inline` + `<style>` approach for dark or other theme variants.
|
|
157
157
|
|
|
158
158
|
### Read luminance warnings from palette generation
|
|
159
|
-
If palette generation returns a luminance warning for a generated surface, do not ignore it. If the design needs multiple surface depths, use `create_custom_palette
|
|
159
|
+
If palette generation returns a luminance warning for a generated surface, do not ignore it. If the design needs multiple surface depths, use `create_custom_palette`, or define semantic CSS variables such as `--surface-1` and `--surface-2` in the main stylesheet. Do not use only one generated surface color.
|
|
160
160
|
|
|
161
161
|
|
|
162
162
|
## Dark Theme Specifics
|
|
@@ -168,7 +168,7 @@ import 'igniteui-webcomponents/themes/dark/material.css';
|
|
|
168
168
|
```
|
|
169
169
|
|
|
170
170
|
### CSS custom properties for dark panels
|
|
171
|
-
When the design uses multiple dark surface depths (panels, sidebars, cards on a dark background), define reusable semantic tokens
|
|
171
|
+
When the design uses multiple dark surface depths (panels, sidebars, cards on a dark background), define reusable semantic tokens. Use palette references or values that come from the design intent:
|
|
172
172
|
|
|
173
173
|
```css
|
|
174
174
|
:root {
|
|
@@ -180,7 +180,7 @@ When the design uses multiple dark surface depths (panels, sidebars, cards on a
|
|
|
180
180
|
}
|
|
181
181
|
```
|
|
182
182
|
|
|
183
|
-
|
|
183
|
+
Palette generation can return one surface color that does not cover all depth levels in the design. In that case, define an additional surface token (`--surface-1`, `--surface-2`, and so on) for each distinct depth.
|
|
184
184
|
|
|
185
185
|
### Use `::part(...)` only when tokens are not enough
|
|
186
|
-
When
|
|
186
|
+
When component design tokens cannot make a visual adjustment, target the documented `::part(...)` selectors from the current component docs or source. Scope the selector to the smallest practical wrapper. This keeps the override local to the generated view.
|
package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-grids/SKILL.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
license: MIT
|
|
3
3
|
name: igniteui-wc-grids
|
|
4
|
-
description: "
|
|
4
|
+
description: "Configure a data grid with Ignite UI Web Components: grid selection, single-design-system theming, Shadow DOM theme injection, component registration, fluid layout, and sorting/filtering. WHEN TO USE: adding a grid to a Web Components app; fixing an unstyled, mis-sized, or broken grid inside a custom element or Shadow DOM; or needing the correct package, theme, layout, or sorting/filter setup. WHEN NOT TO USE: general component selection (use choose-components), Grid Lite to premium migration (use migrate-grid-lite-to-premium), framework wiring (use integrate-with-framework), app-wide theming (use customize-component-theme), bundle optimization (use optimize-bundle-size), or non-tabular components such as charts, lists, or tree views."
|
|
5
5
|
user-invocable: true
|
|
6
6
|
---
|
|
7
7
|
|
|
@@ -9,8 +9,8 @@ user-invocable: true
|
|
|
9
9
|
|
|
10
10
|
## Required Workflow
|
|
11
11
|
|
|
12
|
-
1. **Pick the grid type/package**
|
|
13
|
-
2. **Use only the verified import paths in this file** (`igniteui-webcomponents-grids`, `grids/combined.js`, `themes/<variant>/<design>.css`). For anything else (toolbar, export, pivot/tree/hierarchical APIs, properties/events),
|
|
12
|
+
1. **Pick the grid type/package** from the table below. If the choice is not clear, ask the user.
|
|
13
|
+
2. **Use only the verified import paths in this file** (`igniteui-webcomponents-grids`, `grids/combined.js`, `themes/<variant>/<design>.css`). For anything else (toolbar, export, pivot/tree/hierarchical APIs, properties/events), find it with `list_components({ framework: "webcomponents", ... })` / `get_doc({ framework: "webcomponents", name: "<doc-name>" })` / `search_api({ platform: "webcomponents", query: "<keyword>" })` / `get_api_reference({ platform: "webcomponents", component: "<ClassName>" })`. Do not guess.
|
|
14
14
|
|
|
15
15
|
## Choosing the Grid
|
|
16
16
|
|
|
@@ -22,9 +22,9 @@ user-invocable: true
|
|
|
22
22
|
| Parent-child, different schema per level | `<igc-hierarchical-grid>` | `igniteui-webcomponents-grids` (trial) / `@infragistics/igniteui-webcomponents-grids` (licensed) |
|
|
23
23
|
| Cross-tab / OLAP analysis | `<igc-pivot-grid>` | `igniteui-webcomponents-grids` (trial) / `@infragistics/igniteui-webcomponents-grids` (licensed) |
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
Do not mix `igc-grid-lite` with a premium grid type for the same table. Pick one. To upgrade Grid Lite to `igc-grid`, use the migration skill above.
|
|
26
26
|
|
|
27
|
-
For Grid Lite, import the `igniteui-grid-lite` package and its elements directly. Load only the base Ignite UI theme
|
|
27
|
+
For Grid Lite, import the `igniteui-grid-lite` package and its elements directly. Load only the base Ignite UI theme. Do not import the premium grid package or the grid theme:
|
|
28
28
|
|
|
29
29
|
```typescript
|
|
30
30
|
import { IgcGridLite, IgcGridLiteColumn } from 'igniteui-grid-lite';
|
|
@@ -33,8 +33,8 @@ import 'igniteui-webcomponents/themes/light/material.css';
|
|
|
33
33
|
|
|
34
34
|
## Theming Setup
|
|
35
35
|
|
|
36
|
-
- **Pick exactly one design system** (`material` | `bootstrap` | `fluent` | `indigo`) **and one variant** (`light` | `dark`) for the whole app.
|
|
37
|
-
- **For premium grids only** (`igc-grid`, `igc-tree-grid`, `igc-hierarchical-grid`, `igc-pivot-grid`), load
|
|
36
|
+
- **Pick exactly one design system** (`material` | `bootstrap` | `fluent` | `indigo`) **and one variant** (`light` | `dark`) for the whole app. Do not load two design systems together. Do not load a light and a dark file at the same time. Instead, toggle between the matching light/dark pair of the *same* design system.
|
|
37
|
+
- **For premium grids only** (`igc-grid`, `igc-tree-grid`, `igc-hierarchical-grid`, `igc-pivot-grid`), load the base theme and the grid theme with the same design system + variant. The grid package has its own theme file for its internal structure (headers, cells, sort/filter icons, resize handles):
|
|
38
38
|
|
|
39
39
|
```typescript
|
|
40
40
|
import 'igniteui-webcomponents/themes/light/material.css';
|
|
@@ -43,7 +43,7 @@ import 'igniteui-webcomponents/themes/light/material.css';
|
|
|
43
43
|
|
|
44
44
|
Path pattern for both packages: `themes/<light|dark>/<material|bootstrap|fluent|indigo>.css` (grid package: `igniteui-webcomponents-grids/grids/themes/...`).
|
|
45
45
|
|
|
46
|
-
- These are document-level imports
|
|
46
|
+
- These are document-level imports. They style only the light DOM. A bare import never goes into a shadow root. If the grid renders inside a Shadow root, see **Shadow DOM** below.
|
|
47
47
|
|
|
48
48
|
## Registering Components
|
|
49
49
|
|
|
@@ -60,11 +60,11 @@ defineComponents(IgcButtonComponent);
|
|
|
60
60
|
|
|
61
61
|
Use the corresponding `Igc*GridComponent.register()` method for tree, hierarchical, or pivot grids. Use `igniteui-webcomponents-grids/grids/combined.js` only when the application intentionally uses all premium grid types.
|
|
62
62
|
|
|
63
|
-
Built-in grid glyphs (sort direction, filter, expand/collapse) come from the
|
|
63
|
+
Built-in grid glyphs (sort direction, filter, expand/collapse) come from the internal SVG icon collection of the library. They render automatically after you register the grid module above. They do not need an icon font or a manual `registerIcon`/`registerIconFromText` call. Register icons only for custom glyphs that the app adds itself.
|
|
64
64
|
|
|
65
65
|
## Shadow DOM
|
|
66
66
|
|
|
67
|
-
The most common cause of a "broken grid" (
|
|
67
|
+
The most common cause of a "broken grid" (for example, a checkbox that expands to 1000px+ wide) is a missing theme. A Lit component renders `<igc-grid>` in its own shadow tree, and the grid theme does not reach that tree. To fix this, import the theme as an inline string. Then inject it as a `<style>` tag in `render()`:
|
|
68
68
|
|
|
69
69
|
```typescript
|
|
70
70
|
import { html, LitElement } from 'lit';
|
|
@@ -86,11 +86,11 @@ class MyGridPanel extends LitElement {
|
|
|
86
86
|
}
|
|
87
87
|
```
|
|
88
88
|
|
|
89
|
-
The ?inline suffix is Vite-specific. In other bundlers, use their equivalent method for raw-string CSS imports. If the grid looks broken, fix the missing theme injection
|
|
89
|
+
The ?inline suffix is Vite-specific. In other bundlers, use their equivalent method for raw-string CSS imports. If the grid looks broken, fix the missing theme injection. Do not hide the symptom with fallback CSS overrides.
|
|
90
90
|
|
|
91
91
|
## Fluid Layout
|
|
92
92
|
|
|
93
|
-
|
|
93
|
+
Make the grid fill its container. Do not hardcode pixel heights:
|
|
94
94
|
|
|
95
95
|
```css
|
|
96
96
|
.app-shell { display: flex; flex-direction: column; block-size: 100vh; }
|
|
@@ -99,8 +99,8 @@ Let the grid fill its container instead of hardcoding pixel heights:
|
|
|
99
99
|
igc-grid { flex: 1 1 auto; min-height: 0; block-size: 100%; }
|
|
100
100
|
```
|
|
101
101
|
|
|
102
|
-
- The grid still needs a resolvable height for row virtualization
|
|
103
|
-
-
|
|
102
|
+
- The grid still needs a resolvable height for row virtualization. Get this height from the fluid layout (`100%` of a sized ancestor). Do not set a guessed fixed pixel value on the grid itself.
|
|
103
|
+
- Columns are fluid by default. Do not set a column `width` unless the column needs a fixed size. Keep at least one column without `width` to fill the remaining space.
|
|
104
104
|
|
|
105
105
|
## Sorting & Filtering
|
|
106
106
|
|
|
@@ -110,24 +110,24 @@ igc-grid { flex: 1 1 auto; min-height: 0; block-size: 100%; }
|
|
|
110
110
|
</igc-grid>
|
|
111
111
|
```
|
|
112
112
|
|
|
113
|
-
|
|
113
|
+
The filtering UI shows only when the grid has `allow-filtering="true"`. A column's `filterable="true"` alone has no visible effect. Boolean-looking attributes take quoted string values (`sortable="true"`, not bare `sortable`). For events, remote sort/filter, or programmatic APIs, see the migration skill above. The API is the same for apps that migrate from Grid Lite and for apps that do not.
|
|
114
114
|
|
|
115
115
|
## Verify with a Clean Run
|
|
116
116
|
|
|
117
117
|
- [ ] No console errors/warnings (missing element definitions, CSS import errors)
|
|
118
118
|
- [ ] Grid fully styled per the chosen design system — no unstyled/browser-default look
|
|
119
119
|
- [ ] Sort/filter icons render as glyphs, not empty boxes or ligature text
|
|
120
|
-
- [ ] Filtering UI is visible
|
|
121
|
-
- [ ] Grid
|
|
120
|
+
- [ ] Filtering UI is visible. Sorting and filtering both work interactively
|
|
121
|
+
- [ ] Grid continues to fill its container on resize — no trailing empty space, no clipped rows
|
|
122
122
|
- [ ] No leftover commented-out theme blocks from an earlier attempt
|
|
123
123
|
|
|
124
124
|
## Key Rules
|
|
125
125
|
|
|
126
|
-
1.
|
|
126
|
+
1. Use one design system and one variant everywhere. Do not mix design systems or light/dark files.
|
|
127
127
|
2. Always load both the base theme and the grid theme for that same design system + variant.
|
|
128
128
|
3. Inject the grid theme into every Shadow root that renders `<igc-grid>`/`<igc-tree-grid>`/`<igc-hierarchical-grid>`/`<igc-pivot-grid>`.
|
|
129
|
-
4. Register only the selected grid type and components
|
|
130
|
-
5.
|
|
131
|
-
6.
|
|
132
|
-
7. `allow-filtering="true"` on the grid
|
|
133
|
-
8. Fix root causes (missing theme/registration)
|
|
129
|
+
4. Register only the selected grid type and the components that the app uses. Do not use `defineAllComponents()`. Do not add bundles for possible future use.
|
|
130
|
+
5. Do not guess deep import paths or APIs that this file does not verify. Search for them with the MCP tools.
|
|
131
|
+
6. Use a fluid layout by default: `min-height: 0` + `flex`/`grid` sizing. Use fixed pixel heights only when they are explicitly required.
|
|
132
|
+
7. To enable the sorting/filtering UI, set `allow-filtering="true"` on the grid and `sortable`/`filterable` per column.
|
|
133
|
+
8. Fix root causes (missing theme/registration). Do not hide symptoms with fallback CSS.
|
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
---
|
|
2
2
|
license: MIT
|
|
3
3
|
name: igniteui-wc-integrate-with-framework
|
|
4
|
-
description: "Install and integrate Ignite UI Web Components packages into React, Angular, Vue 3, LitElement, or vanilla JS/HTML apps
|
|
4
|
+
description: "Install and integrate Ignite UI Web Components packages into React, Angular, Vue 3, LitElement, or vanilla JS/HTML apps. Identify the framework and apply the framework-specific setup: package choice, component registration, theme imports, schemas and configuration, events and property binding. WHEN TO USE: the user wants to add Ignite UI Web Components or igniteui-react to a project, create a new app with them, fix registration or 'unknown element' errors, or needs framework-specific configuration for templates, events, or forms. WHEN NOT TO USE: selecting the components to use (use choose-components), customizing themes or styles (use customize-component-theme), reducing bundle size or import granularity (use optimize-bundle-size), building a view from a design (use generate-from-image-design or figma-to-app), or projects that use Ignite UI for Angular/Blazor native packages instead of Web Components."
|
|
5
5
|
user-invocable: true
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# Integrate with Framework
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
Use this skill to integrate Ignite UI Web Components into an application. Identify the framework or platform, then load the step-by-step integration reference for it.
|
|
11
11
|
|
|
12
12
|
## Before You Answer
|
|
13
13
|
|
|
14
14
|
- Choose the package first, then load the framework reference.
|
|
15
15
|
- Do not assume every setup flow uses `igniteui-webcomponents`.
|
|
16
|
-
- If
|
|
16
|
+
- If `package.json` does not contain the necessary package, add or install the correct Ignite UI dependency first. A package that is not in `package.json` can still be valid.
|
|
17
17
|
|
|
18
18
|
### Package Routing
|
|
19
19
|
|
|
@@ -25,7 +25,7 @@ This skill helps users integrate Ignite UI Web Components into their application
|
|
|
25
25
|
| Dock Manager | `igniteui-dockmanager` (trial) `@infragistics/igniteui-dockmanager` (licensed) |
|
|
26
26
|
| Charts | `igniteui-webcomponents-charts` (trial) `@infragistics/igniteui-webcomponents-charts` (licensed) |
|
|
27
27
|
|
|
28
|
-
If the request only says "grid",
|
|
28
|
+
If the request only says "grid", use the requested features to select the package:
|
|
29
29
|
|
|
30
30
|
- Use `igniteui-webcomponents-grids` for editing, paging, sorting, filtering, summaries, grouping, hierarchical data, or pivot features.
|
|
31
31
|
- Use `igniteui-grid-lite` for lightweight tabular data.
|
|
@@ -44,23 +44,23 @@ If the request only says "grid", infer the package from the requested features:
|
|
|
44
44
|
|
|
45
45
|
## When to Use
|
|
46
46
|
|
|
47
|
-
-
|
|
48
|
-
-
|
|
49
|
-
-
|
|
50
|
-
-
|
|
47
|
+
- The user wants to add igniteui-webcomponents to a framework project
|
|
48
|
+
- The user has framework-specific integration problems
|
|
49
|
+
- The user needs help with component imports and registration
|
|
50
|
+
- The user asks about React, Angular, Vue, or vanilla JS setup
|
|
51
51
|
|
|
52
52
|
---
|
|
53
53
|
|
|
54
54
|
## Framework Detection
|
|
55
55
|
|
|
56
|
-
Before
|
|
56
|
+
Before you load a reference, use the project context to identify the target framework. Check these signals in sequence:
|
|
57
57
|
|
|
58
58
|
### 1. Detect React
|
|
59
59
|
|
|
60
|
-
**Evidence
|
|
60
|
+
**Evidence:**
|
|
61
61
|
- `package.json` contains `"react"` or `"react-dom"` in `dependencies` or `devDependencies`
|
|
62
62
|
- Files with `.tsx` or `.jsx` extensions exist in `src/`
|
|
63
|
-
-
|
|
63
|
+
- The entry point imports `ReactDOM` or `createRoot`
|
|
64
64
|
- `vite.config.ts` uses `@vitejs/plugin-react` or `@vitejs/plugin-react-swc`
|
|
65
65
|
|
|
66
66
|
→ **Load:** [react.md](./references/react.md)
|
|
@@ -69,11 +69,11 @@ Before loading a reference, identify the target framework from the project conte
|
|
|
69
69
|
|
|
70
70
|
### 2. Detect Angular
|
|
71
71
|
|
|
72
|
-
**Evidence
|
|
72
|
+
**Evidence:**
|
|
73
73
|
- `package.json` contains `"@angular/core"` in `dependencies`
|
|
74
|
-
- `angular.json` file exists in the workspace root
|
|
74
|
+
- An `angular.json` file exists in the workspace root
|
|
75
75
|
- Files with `.component.ts`, `.module.ts`, or `.component.html` patterns exist
|
|
76
|
-
-
|
|
76
|
+
- The entry point calls `bootstrapApplication` or `platformBrowserDynamic`
|
|
77
77
|
|
|
78
78
|
→ **Load:** [angular.md](./references/angular.md)
|
|
79
79
|
|
|
@@ -81,11 +81,11 @@ Before loading a reference, identify the target framework from the project conte
|
|
|
81
81
|
|
|
82
82
|
### 3. Detect Vue 3
|
|
83
83
|
|
|
84
|
-
**Evidence
|
|
84
|
+
**Evidence:**
|
|
85
85
|
- `package.json` contains `"vue"` in `dependencies` or `devDependencies`
|
|
86
86
|
- Files with `.vue` extensions exist in `src/`
|
|
87
87
|
- `vite.config.ts` uses `@vitejs/plugin-vue`
|
|
88
|
-
-
|
|
88
|
+
- The entry point calls `createApp`
|
|
89
89
|
|
|
90
90
|
→ **Load:** [vue.md](./references/vue.md)
|
|
91
91
|
|
|
@@ -93,12 +93,12 @@ Before loading a reference, identify the target framework from the project conte
|
|
|
93
93
|
|
|
94
94
|
### 4. Vanilla JavaScript / HTML (fallback)
|
|
95
95
|
|
|
96
|
-
**Evidence
|
|
97
|
-
-
|
|
96
|
+
**Evidence:**
|
|
97
|
+
- `package.json` does not contain a major framework
|
|
98
98
|
- Plain `.html` files reference a `<script type="module">`
|
|
99
|
-
-
|
|
100
|
-
- `package.json` contains "lit"
|
|
101
|
-
-
|
|
99
|
+
- The entry point is a plain `.js` or `.ts` file without framework imports
|
|
100
|
+
- `package.json` contains "lit". Start with the vanilla JS reference. If the app uses Shadow DOM, follow the Shadow root theming note for grids.
|
|
101
|
+
- The user asks directly for vanilla JS, HTML, or LitElement integration
|
|
102
102
|
|
|
103
103
|
→ **Load:** [vanilla-js.md](./references/vanilla-js.md)
|
|
104
104
|
|
|
@@ -123,7 +123,7 @@ Then load the matching reference from the options above.
|
|
|
123
123
|
| Vue 3 | [vue.md](./references/vue.md) |
|
|
124
124
|
| Vanilla JS / HTML / LitElement | [vanilla-js.md](./references/vanilla-js.md) |
|
|
125
125
|
|
|
126
|
-
Each reference
|
|
126
|
+
Each reference contains:
|
|
127
127
|
|
|
128
128
|
- Installation
|
|
129
129
|
- Theme import (required for styling)
|
|
@@ -131,5 +131,5 @@ Each reference covers:
|
|
|
131
131
|
- Usage examples
|
|
132
132
|
- TypeScript support
|
|
133
133
|
- Platform-specific considerations
|
|
134
|
-
- Common
|
|
134
|
+
- Common problems and solutions
|
|
135
135
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Integrating Ignite UI Web Components — Angular
|
|
2
2
|
|
|
3
|
-
> Package note: This page shows the default setup for `igniteui-webcomponents`. If the routing step selected `igniteui-webcomponents-charts`, `igniteui-webcomponents-grids`, `igniteui-grid-lite`, or `igniteui-dockmanager`,
|
|
3
|
+
> Package note: This page shows the default setup for `igniteui-webcomponents`. If the routing step selected `igniteui-webcomponents-charts`, `igniteui-webcomponents-grids`, `igniteui-grid-lite`, or `igniteui-dockmanager`, use the setup of that package for the package-specific steps below. These are the install, import, and registration steps.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -12,7 +12,7 @@ npm install igniteui-webcomponents
|
|
|
12
12
|
|
|
13
13
|
### Step 1 — Register the theme and components
|
|
14
14
|
|
|
15
|
-
In `src/main.ts`, import a theme and register the components before
|
|
15
|
+
In `src/main.ts`, import a theme and register the components before you bootstrap the application:
|
|
16
16
|
|
|
17
17
|
```typescript
|
|
18
18
|
import { bootstrapApplication } from '@angular/platform-browser';
|
|
@@ -29,7 +29,7 @@ bootstrapApplication(AppComponent, appConfig)
|
|
|
29
29
|
|
|
30
30
|
### Step 2 — Add `CUSTOM_ELEMENTS_SCHEMA`
|
|
31
31
|
|
|
32
|
-
Angular
|
|
32
|
+
Angular accepts custom element tags in templates only with `CUSTOM_ELEMENTS_SCHEMA`.
|
|
33
33
|
|
|
34
34
|
**Standalone components** — add the schema to each component that uses Ignite UI elements:
|
|
35
35
|
|
|
@@ -47,7 +47,7 @@ import { Component, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
|
|
|
47
47
|
export class MyComponent {}
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
**NgModule-based apps** — add the schema once to `AppModule` (or the
|
|
50
|
+
**NgModule-based apps** — add the schema once to `AppModule` (or the applicable module):
|
|
51
51
|
|
|
52
52
|
```typescript
|
|
53
53
|
import { NgModule, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
|
|
@@ -145,7 +145,7 @@ export class MyComponent {
|
|
|
145
145
|
| **CUSTOM_ELEMENTS_SCHEMA** | Required in every module or standalone component that uses `igc-*` tags |
|
|
146
146
|
| **Event binding** | Use Angular syntax: `(igcChange)="handler($event)"` |
|
|
147
147
|
| **Property binding** | Use `[property]="value"` for reactive data and complex types |
|
|
148
|
-
| **Form integration** | Web components work with Angular Forms
|
|
148
|
+
| **Form integration** | Web components work with Angular Forms through `ngModel` or reactive form controls |
|
|
149
149
|
|
|
150
150
|
## TypeScript Support
|
|
151
151
|
|
|
@@ -168,20 +168,20 @@ Add `CUSTOM_ELEMENTS_SCHEMA` to the component's `schemas` array (standalone) or
|
|
|
168
168
|
|
|
169
169
|
### Events not firing
|
|
170
170
|
|
|
171
|
-
Use Angular
|
|
171
|
+
Use the Angular event binding syntax `(igcChange)="handler($event)"`, not `(change)`. Ignite UI components emit custom events with a prefix (for example, `igcInput`, `igcChange`).
|
|
172
172
|
|
|
173
173
|
### No styles applied
|
|
174
174
|
|
|
175
|
-
|
|
175
|
+
Make sure that you import a theme CSS file in `main.ts` before you bootstrap the application.
|
|
176
176
|
|
|
177
177
|
### Properties not updating
|
|
178
178
|
|
|
179
|
-
Use `[property]="value"` binding for complex or reactive data. Attribute strings (
|
|
179
|
+
Use `[property]="value"` binding for complex or reactive data. Attribute strings (for example, `label="Name"`) work only for primitive values.
|
|
180
180
|
|
|
181
181
|
---
|
|
182
182
|
|
|
183
183
|
## Next Steps
|
|
184
184
|
|
|
185
|
-
- [Optimize bundle size](../../igniteui-wc-optimize-bundle-size/) — import only the components you use
|
|
185
|
+
- [Optimize bundle size](../../igniteui-wc-optimize-bundle-size/) — import only the components that you use
|
|
186
186
|
- [Customize themes](../../igniteui-wc-customize-component-theme/) — apply your brand colors
|
|
187
|
-
- [Component documentation](https://igniteui.github.io/igniteui-webcomponents) — full API reference
|
|
187
|
+
- [Component documentation](https://igniteui.github.io/igniteui-webcomponents) — the full API reference
|
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
# Integrating Ignite UI Web Components — React
|
|
2
2
|
|
|
3
|
-
React integration uses the **`igniteui-react`** package
|
|
3
|
+
React integration uses the **`igniteui-react`** package. This package contains React-native wrappers for Ignite UI Web Components:
|
|
4
4
|
|
|
5
5
|
- ✅ Native React event handling
|
|
6
6
|
- ✅ Full TypeScript types and IntelliSense for all props
|
|
7
7
|
- ✅ Automatic global type declarations (`HTMLElementTagNameMap`)
|
|
8
8
|
- ✅ camelCase props instead of kebab-case attributes
|
|
9
|
-
- ✅
|
|
9
|
+
- ✅ Complex data binding (objects and arrays work as props)
|
|
10
10
|
- ✅ React DevTools integration
|
|
11
11
|
|
|
12
|
-
Components use the `Igr` prefix (
|
|
12
|
+
Components use the `Igr` prefix (for example, `IgrButton`, `IgrInput`, `IgrCombo`).
|
|
13
13
|
|
|
14
|
-
> Package note: This page shows the default React wrapper setup for general UI components. If the routing step selected `igniteui-webcomponents-charts`, `igniteui-webcomponents-grids`, `igniteui-grid-lite`, or `igniteui-dockmanager`,
|
|
14
|
+
> Package note: This page shows the default React wrapper setup for general UI components. If the routing step selected `igniteui-webcomponents-charts`, `igniteui-webcomponents-grids`, `igniteui-grid-lite`, or `igniteui-dockmanager`, use the setup of that package. Do not use the `igniteui-react` and `Igr*` instructions below without changes.
|
|
15
15
|
|
|
16
16
|
### Installation
|
|
17
17
|
|
|
@@ -84,7 +84,7 @@ function MyComponent() {
|
|
|
84
84
|
|
|
85
85
|
### TypeScript Support
|
|
86
86
|
|
|
87
|
-
The `igniteui-react` package
|
|
87
|
+
The `igniteui-react` package contains full type definitions. You do not need more configuration:
|
|
88
88
|
|
|
89
89
|
```tsx
|
|
90
90
|
import { IgrButton } from 'igniteui-react';
|
|
@@ -102,17 +102,17 @@ const button = document.querySelector('igc-button'); // IgcButtonComponent | nul
|
|
|
102
102
|
|
|
103
103
|
### Components not rendering
|
|
104
104
|
|
|
105
|
-
The `igniteui-react` package registers components automatically
|
|
105
|
+
The `igniteui-react` package registers components automatically when you import them. Make sure that the package is installed. Make sure that you import the components before the component tree renders.
|
|
106
106
|
|
|
107
107
|
### No styles applied
|
|
108
108
|
|
|
109
|
-
|
|
109
|
+
Make sure that you import a theme CSS file in your entry point. Without it, components render without styles.
|
|
110
110
|
|
|
111
111
|
---
|
|
112
112
|
|
|
113
113
|
## Next Steps
|
|
114
114
|
|
|
115
|
-
- [Optimize bundle size](../../igniteui-wc-optimize-bundle-size/) — import only the components you use
|
|
115
|
+
- [Optimize bundle size](../../igniteui-wc-optimize-bundle-size/) — import only the components that you use
|
|
116
116
|
- [Customize themes](../../igniteui-wc-customize-component-theme/) — apply your brand colors
|
|
117
117
|
- [igniteui-react on npm](https://www.npmjs.com/package/igniteui-react) — React wrapper documentation
|
|
118
|
-
- [Component documentation](https://igniteui.github.io/igniteui-webcomponents) — full API reference
|
|
118
|
+
- [Component documentation](https://igniteui.github.io/igniteui-webcomponents) — the full API reference
|