Skip to content

Commit 931f617

Browse files
damyanpetevdamyanpetev
committed
docs(npm): update package readme-s
1 parent 9c9c66b commit 931f617

File tree

3 files changed

+132
-24
lines changed

3 files changed

+132
-24
lines changed

‎.azure-pipelines/artifacts/README_Components.md‎

Lines changed: 66 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,76 @@
11
# Ignite UI for React - from Infragistics
22

3-
[Ignite UI for React](https://www.infragistics.com/products/ignite-ui-react) includes a wide range of easy to use React UI components that have been designed and optimized for high-performance, high-volume data scenarios. Ignite UI for React is designed to enable developers to build the most modern, high-performance HTML5 & JavaScript apps for modern desktop browsers, mobile experiences and progressive web apps (PWA’s) targeting the React framework.
3+
[![npm version](https://badge.fury.io/js/igniteui-react.svg)](https://badge.fury.io/js/igniteui-react)
4+
[![Discord](https://img.shields.io/discord/836634487483269200?logo=discord&logoColor=ffffff)](https://discord.gg/39MjrTRqds)
45

5-
## View Samples and Documentation
6+
[Ignite UI for React](https://www.infragistics.com/products/ignite-ui-react) includes a wide range of easy to use React UI components that have been designed and optimized for high-performance, high-volume data scenarios. Ignite UI for React is designed to enable developers to build the most modern, high-performance HTML5 & JavaScript apps for modern desktop browsers, mobile experiences and progressive web apps (PWA's) targeting the React framework.
7+
8+
## Browser Support
9+
10+
| ![Chrome](https://user-images.githubusercontent.com/2188411/168109445-fbd7b217-35f9-44d1-8002-1eb97e39cdc6.png) | ![Firefox](https://user-images.githubusercontent.com/2188411/168109465-e46305ee-f69f-4fa5-8f4a-14876f7fd3ca.png) | ![Edge](https://user-images.githubusercontent.com/2188411/168109472-a730f8c0-3822-4ae6-9f54-785a66695245.png) | ![Opera](https://user-images.githubusercontent.com/2188411/168109520-b6865a6c-b69f-44a4-9948-748d8afd687c.png) | ![Safari](https://user-images.githubusercontent.com/2188411/168109527-6c58f2cf-7386-4b97-98b1-cfe0ab4e8626.png) |
11+
| --------------- | ---------------- | ------------- | -------------- | --------------- |
12+
| Latest ✔️ | Latest ✔️ | Latest ✔️ | Latest ✔️ | Latest ✔️ |
13+
14+
## Components
615

716
This package provides the following components:
817

9-
[Avatar](https://www.infragistics.com/products/ignite-ui-react/react/components/layouts/avatar), [Badge](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/badge), [Button](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/button), [Card](https://www.infragistics.com/products/ignite-ui-react/react/components/layouts/card), [Checkbox](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/checkbox), [Chip](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/chip), [Calendar](https://www.infragistics.com/products/ignite-ui-react/react/components/scheduling/calendar), [Expansion Panel](https://www.infragistics.com/products/ignite-ui-react/react/components/layouts/expansion-panel), [Form](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/form), [Icon](https://www.infragistics.com/products/ignite-ui-react/react/components/layouts/icon), [Input](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/input), [List](https://www.infragistics.com/products/ignite-ui-react/react/components/grids/list), [Nav Bar](https://www.infragistics.com/products/ignite-ui-react/react/components/menus/navbar), [Radio](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/radio), [Ripple](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/ripple), [Switch](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/switch), [Slider](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/slider), [Snackbar](https://www.infragistics.com/products/ignite-ui-react/react/components/notifications/snackbar), [Toast](https://www.infragistics.com/products/ignite-ui-react/react/components/notifications/toast), [Tree](https://www.infragistics.com/products/ignite-ui-react/react/components/grids/tree), and many more.
18+
| Component | Status | Documentation |
19+
|:----------|:------:|:-------------:|
20+
| Grid Lite (requires [igniteui-grid-lite](https://www.npmjs.com/package/igniteui-grid-lite)) | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/grid-lite/overview) |
21+
| AI Chat | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/interactivity/chat) |
22+
| Accordion | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/layouts/accordion) |
23+
| Avatar | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/layouts/avatar) |
24+
| Badge | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/badge) |
25+
| Banner | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/notifications/banner) |
26+
| Button | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/button) |
27+
| Button Group | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/button-group) |
28+
| Calendar | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/scheduling/calendar) |
29+
| Card | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/layouts/card) |
30+
| Carousel | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/layouts/carousel) |
31+
| Checkbox | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/checkbox) |
32+
| Chip | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/chip) |
33+
| ComboBox | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/combo/overview) |
34+
| Date Picker | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/scheduling/date-picker) |
35+
| Date Range Picker | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/scheduling/date-range-picker) |
36+
| Date Time Input | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/date-time-input) |
37+
| Dialog | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/notifications/dialog) |
38+
| Divider | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/layouts/divider) |
39+
| Dropdown | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/dropdown) |
40+
| Expansion Panel | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/layouts/expansion-panel) |
41+
| Icon | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/layouts/icon) |
42+
| Icon Button | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/icon-button) |
43+
| Input | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/input) |
44+
| Linear Progress | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/linear-progress) |
45+
| List | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/grids/list) |
46+
| Mask Input | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/mask-input) |
47+
| Navigation Bar (Navbar) | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/menus/navbar) |
48+
| Navigation Drawer | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/menus/navigation-drawer) |
49+
| Radio & Radio Group | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/radio) |
50+
| Rating | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/rating) |
51+
| Ripple | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/ripple) |
52+
| Select | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/select) |
53+
| Slider & Range Slider | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/slider) |
54+
| Snackbar | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/notifications/snackbar) |
55+
| Stepper | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/layouts/stepper) |
56+
| Switch | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/switch) |
57+
| Tabs | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/layouts/tabs) |
58+
| Text Area | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/text-area) |
59+
| Tile Manager | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/layouts/tile-manager) |
60+
| Toast | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/notifications/toast) |
61+
| Tooltip | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/inputs/tooltip) |
62+
| Tree | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/grids/tree) |
63+
64+
## AI-Assisted Development
1065

66+
This package ships with **LLM Agent Skills** — structured knowledge files that teach AI coding assistants (GitHub Copilot, Cursor, Windsurf, Claude, JetBrains AI, etc.) how to work with Ignite UI for React:
1167

12-
## NPM Package
68+
| Skill | Description |
69+
|:------|:------------|
70+
| **components** | Identify the right React components (`Igr*`) for a UI pattern, then install, import, and use them — JSX patterns, events, refs, forms, Next.js setup |
71+
| **customize-theme** | Customize styling using CSS custom properties, Sass, and the theming system in React |
72+
| **optimize-bundle-size** | Reduce bundle size with granular imports, tree-shaking, and lazy loading |
1373

14-
You can include Ignite UI for React in your project using this `npm` command:
74+
## License
1575

16-
`npm install --save igniteui-react`
76+
MIT-licensed package. See [LICENSE](LICENSE) for details.

‎.azure-pipelines/artifacts/README_DockManager.md‎

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,38 @@
11
# Ignite UI for React Dock Manager - from Infragistics
22

3+
[![npm version](https://badge.fury.io/js/igniteui-react-dockmanager.svg)](https://badge.fury.io/js/igniteui-react-dockmanager)
4+
[![Discord](https://img.shields.io/discord/836634487483269200?logo=discord&logoColor=ffffff)](https://discord.gg/39MjrTRqds)
5+
36
[Ignite UI React Dock Manager](https://www.infragistics.com/products/ignite-ui-react) provides means to manage the layout of your application through panes, allowing your end-users to customize it further by pinning, resizing, moving and hiding panes.
47

8+
![Dock Manager](https://github.com/IgniteUI/igniteui-webcomponents/assets/52001020/a9643f17-f1c2-4554-87aa-96c9daea13b0)
9+
10+
Provide a complete windowing experience, splitting complex layouts into smaller, easier-to-manage panes.
11+
12+
## Browser Support
13+
14+
| ![Chrome](https://user-images.githubusercontent.com/2188411/168109445-fbd7b217-35f9-44d1-8002-1eb97e39cdc6.png) | ![Firefox](https://user-images.githubusercontent.com/2188411/168109465-e46305ee-f69f-4fa5-8f4a-14876f7fd3ca.png) | ![Edge](https://user-images.githubusercontent.com/2188411/168109472-a730f8c0-3822-4ae6-9f54-785a66695245.png) | ![Opera](https://user-images.githubusercontent.com/2188411/168109520-b6865a6c-b69f-44a4-9948-748d8afd687c.png) | ![Safari](https://user-images.githubusercontent.com/2188411/168109527-6c58f2cf-7386-4b97-98b1-cfe0ab4e8626.png) |
15+
| --------------- | ---------------- | ------------- | -------------- | --------------- |
16+
| Latest ✔️ | Latest ✔️ | Latest ✔️ | Latest ✔️ | Latest ✔️ |
17+
518
## View Samples and Documentation
619

720
[React Dock Manager Overview](https://www.infragistics.com/products/ignite-ui-react/react/components/layouts/dock-manager)
821

9-
## NPM Package
10-
11-
You can include Ignite UI React Dock Manager in your project using this `npm` command:
22+
### Key Features
1223

13-
`npm install --save igniteui-react-dockmanager`
24+
- Dockable panes with drag-and-drop support
25+
- Pinning, resizing, moving, and hiding panes
26+
- Floating panes with window-like behavior
27+
- Tab groups for organizing related content
28+
- Nested docking for complex layouts
29+
- Save and restore layout state
30+
- Fully customizable appearance and behavior
1431

1532
## License
16-
This is a commercial product, requiring a valid paid-for license for use. This license details can by found [here](http://www.infragistics.com/legal/ultimate/license/)
33+
34+
This is a commercial product, requiring a valid paid-for license for use. License details can be found [here](https://www.infragistics.com/legal/license).
1735

1836
To acquire a license for usage, please register for a trial and acquire a license at [Infragistics.com](https://www.infragistics.com).
1937

20-
© Copyright 2025 Infragistics. All Rights Reserved. The Infragistics Ultimate license & copyright applies to this distribution. For information on that license, please go to our website [here](https://www.infragistics.com/legal/license).
38+
(c) Copyright 2026 Infragistics. All Rights Reserved. The Infragistics Ultimate license & copyright applies to this distribution. For information on that license, please go to our website [here](https://www.infragistics.com/legal/license).

‎.azure-pipelines/artifacts/README_Grids.md‎

Lines changed: 42 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,55 @@
11
# Ignite UI for React Grids - from Infragistics
22

3-
[Ignite UI for React](https://www.infragistics.com/products/ignite-ui-react) includes a wide range of easy to use React UI components that have been designed and optimized for high-performance, high-volume data scenarios. Ignite UI for React is designed to enable developers to build the most modern, high-performance HTML5 & JavaScript apps for modern desktop browsers, mobile experiences and progressive web apps (PWA’s) targeting the React framework.
3+
[![npm version](https://badge.fury.io/js/igniteui-react-grids.svg)](https://badge.fury.io/js/igniteui-react-grids)
4+
[![Discord](https://img.shields.io/discord/836634487483269200?logo=discord&logoColor=ffffff)](https://discord.gg/39MjrTRqds)
45

5-
## View Samples and Documentation
6+
[Ignite UI for React](https://www.infragistics.com/products/ignite-ui-react) includes a wide range of easy to use React UI components that have been designed and optimized for high-performance, high-volume data scenarios. Ignite UI for React is designed to enable developers to craft modern web app experiences using the most comprehensive UI library of modular React Components and the fastest data grid optimized for speed and performance.
67

7-
This package provides the grid components that include:
8+
## Browser Support
89

9-
- [**Grid**](https://www.infragistics.com/products/ignite-ui-react/react/components/grids/grids-header)
10-
- [**Pivot Grid**](https://www.infragistics.com/products/ignite-ui-react/react/components/grids/pivot-grid/overview)
11-
- [**Tree Grid**](https://www.infragistics.com/products/ignite-ui-react/react/components/grids/tree-grid/overview)
12-
- [**Hierarchical Grid**](https://www.infragistics.com/products/ignite-ui-react/react/components/grids/hierarchical-grid/overview)
10+
| ![Chrome](https://user-images.githubusercontent.com/2188411/168109445-fbd7b217-35f9-44d1-8002-1eb97e39cdc6.png) | ![Firefox](https://user-images.githubusercontent.com/2188411/168109465-e46305ee-f69f-4fa5-8f4a-14876f7fd3ca.png) | ![Edge](https://user-images.githubusercontent.com/2188411/168109472-a730f8c0-3822-4ae6-9f54-785a66695245.png) | ![Opera](https://user-images.githubusercontent.com/2188411/168109520-b6865a6c-b69f-44a4-9948-748d8afd687c.png) | ![Safari](https://user-images.githubusercontent.com/2188411/168109527-6c58f2cf-7386-4b97-98b1-cfe0ab4e8626.png) |
11+
| --------------- | ---------------- | ------------- | -------------- | --------------- |
12+
| Latest ✔️ | Latest ✔️ | Latest ✔️ | Latest ✔️ | Latest ✔️ |
1313

14-
## NPM Package
14+
## Grid Components
1515

16-
You can include Ignite UI for React Grids in your project using this `npm` command:
16+
This package provides the following grid components:
1717

18-
`npm install --save igniteui-react-grids`
18+
| Component | Status | Documentation |
19+
|:----------|:------:|:-------------:|
20+
| Grid | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/grids/data-grid) |
21+
| Tree Grid | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/grids/tree-grid/overview) |
22+
| Pivot Grid | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/grids/pivot-grid/overview) |
23+
| Hierarchical Grid | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/grids/hierarchical-grid/overview) |
24+
25+
### Key Features
26+
27+
- Virtualized rows and columns for unlimited data size
28+
- Column sorting, filtering, pinning, moving, hiding, and resizing
29+
- Row selection, cell selection, and clipboard support
30+
- Inline editing with cell, row, and batch editing modes
31+
- Built-in column types and templating support
32+
- Multi-column headers and column groups
33+
- Row and cell conditional styling
34+
- Export to Excel and CSV
35+
- Advanced filtering with filter row and Excel-style filter
36+
- Grouping, summaries, and paging
37+
- Keyboard navigation and accessibility
38+
39+
## AI-Assisted Development
40+
41+
This package ships with **LLM Agent Skills** — structured knowledge files that teach AI coding assistants (GitHub Copilot, Cursor, Windsurf, Claude, JetBrains AI, etc.) how to work with Ignite UI for React:
42+
43+
| Skill | Description |
44+
|:------|:------------|
45+
| **components** | Identify the right React components (`Igr*`) for a UI pattern, then install, import, and use them — JSX patterns, events, refs, forms, Next.js setup |
46+
| **customize-theme** | Customize styling using CSS custom properties, Sass, and the theming system in React |
47+
| **optimize-bundle-size** | Reduce bundle size with granular imports, tree-shaking, and lazy loading |
1948

2049
## License
21-
This is a commercial product, requiring a valid paid-for license for use. This license details can by found [here](http://www.infragistics.com/legal/ultimate/license/)
50+
51+
This is a commercial product, requiring a valid paid-for license for use. License details can be found [here](https://www.infragistics.com/legal/license).
2252

2353
To acquire a license for usage, please register for a trial and acquire a license at [Infragistics.com](https://www.infragistics.com).
2454

25-
© Copyright 2025 Infragistics. All Rights Reserved. The Infragistics Ultimate license & copyright applies to this distribution. For information on that license, please go to our website [here](https://www.infragistics.com/legal/license).
55+
(c) Copyright 2026 Infragistics. All Rights Reserved. The Infragistics Ultimate license & copyright applies to this distribution. For information on that license, please go to our website [here](https://www.infragistics.com/legal/license).

0 commit comments

Comments
 (0)