Skip to content

Commit 4ca9fe7

Browse files
ChronosSFChronosSF
authored
Merge pull request #2003 from IgniteUI/rmirchev/update-readme-oss-release
docs(*): update-readme-for-oss
2 parents 9397594 + b04215f commit 4ca9fe7

File tree

2 files changed

+81
-71
lines changed

2 files changed

+81
-71
lines changed

‎.vscode/cspell.json‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,33 @@
66
"aria-haspopup",
77
"aria-labelledby",
88
"aria-multiselectable",
9-
"aria-setsize",
109
"aria-posinset",
10+
"aria-setsize",
1111
"aria-valuenow",
1212
"aria-valuetext",
13+
"biomejs",
14+
"blazor",
1315
"combobox",
14-
"listbox",
15-
"listitem",
16-
"progressbar",
17-
"radiogroup",
18-
"tablist",
19-
"tabpanel",
20-
"treeitem",
21-
"compositionstart",
2216
"compositionend",
17+
"compositionstart",
2318
"contenteditable",
24-
"maxlength",
25-
"minlength",
26-
"inputmode",
27-
"biomejs",
28-
"blazor",
29-
"cssproperty",
3019
"csspart",
20+
"cssproperty",
21+
"dockmanager",
3122
"exportparts",
3223
"igniteui",
24+
"inputmode",
25+
"listbox",
26+
"listitem",
27+
"maxlength",
28+
"minlength",
29+
"progressbar",
30+
"radiogroup",
3331
"slotchange",
3432
"stylelint",
33+
"tablist",
34+
"tabpanel",
35+
"treeitem",
3536
"webcomponents"
3637
]
3738
}

‎README.md‎

Lines changed: 65 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -24,66 +24,67 @@ See the [Storybook Here](https://igniteui.github.io/igniteui-webcomponents)
2424
<details open>
2525
<summary>Components</summary>
2626

27-
| Components | Status | Documentation | Released Version |
28-
| :---------------------- | :----: | :----------------------------: | :--------------: |
29-
| Chat | ✅ | [Docs][Chat Docs] | [6.3.0] |
30-
| Date Range Picker | ✅ | [Docs][Date Range Picker Docs] | [6.1.0] |
31-
| Tooltip | ✅ | [Docs][Tooltip Docs] | [5.4.0] |
32-
| File Input | ✅ | [Docs][File Input Docs] | [5.4.0] |
33-
| Tile Manager | ✅ | [Docs][Tile Manager Docs] | [5.3.0] |
34-
| Carousel | ✅ | [Docs][Carousel Docs] | [5.1.0] |
35-
| Date picker | ✅ | [Docs][Date Picker Docs] | [4.10.0] |
36-
| Divider | ✅ | [Docs][Divider Docs] | [4.10.0] |
37-
| Banner | ✅ | [Docs][Banner Docs] | [4.10.0] |
38-
| Button group | ✅ | [Docs][Button Group Docs] | [4.5.0] |
39-
| Textarea | ✅ | [Docs][Textarea Docs] | [4.5.0] |
40-
| Combo | ✅ | [Docs][Combo Docs] | [4.1.0] |
41-
| Stepper | ✅ | [Docs][Stepper Docs] | [4.1.0] |
42-
| Select | ✅ | [Docs][Select Docs] | [3.4.0] |
43-
| Dialog | ✅ | [Docs][Dialog Docs] | [3.4.0] |
44-
| Date Time Input | ✅ | [Docs][Date Time Input Docs] | [3.3.0] |
45-
| Tabs | ✅ | [Docs][Tabs Docs] | [3.3.0] |
46-
| Accordion | ✅ | [Docs][Accordion Docs] | [3.3.0] |
47-
| Mask Input | ✅ | [Docs][Masked Input Docs] | [3.2.0] |
48-
| Expansion Panel | ✅ | [Docs][Expansion Panel Docs] | [3.2.0] |
49-
| Tree | ✅ | [Docs][Tree Docs] | [3.2.0] |
50-
| Drop Down | ✅ | [Docs][Dropdown Docs] | [2.2.0] |
51-
| Linear Progress | ✅ | [Docs][Linear Progress Docs] | [2.1.0] |
52-
| Circular Progress | ✅ | [Docs][Circular Progress Docs] | [2.1.0] |
53-
| Chip | ✅ | [Docs][Chip Docs] | [2.1.0] |
54-
| Snackbar | ✅ | [Docs][Snackbar Docs] | [2.1.0] |
55-
| Toast | ✅ | [Docs][Toast Docs] | [2.1.0] |
56-
| Rating | ✅ | [Docs][Rating Docs] | [2.1.0] |
57-
| Slider | ✅ | [Docs][Slider Docs] | [2.0.0] |
58-
| Range Slider | ✅ | [Docs][Slider Docs] | [2.0.0] |
59-
| Avatar | ✅ | [Docs][Avatar Docs] | [1.0.0] |
60-
| Badge | ✅ | [Docs][Badge Docs] | [1.0.0] |
61-
| Button | ✅ | [Docs][Button Docs] | [1.0.0] |
62-
| Calendar | ✅ | [Docs][Calendar Docs] | [1.0.0] |
63-
| Card | ✅ | [Docs][Card Docs] | [1.0.0] |
64-
| Checkbox | ✅ | [Docs][Checkbox Docs] | [1.0.0] |
65-
| Form | ✅ | [Docs][Form Docs] | [1.0.0] |
66-
| Icon | ✅ | [Docs][Icon Docs] | [1.0.0] |
67-
| Icon Button | ✅ | [Docs][Icon Button Docs] | [1.0.0] |
68-
| Input | ✅ | [Docs][Input Docs] | [1.0.0] |
69-
| List | ✅ | [Docs][List Docs] | [1.0.0] |
70-
| Navigation Bar (Navbar) | ✅ | [Docs][Navigation Bar Docs] | [1.0.0] |
71-
| Navigation Drawer | ✅ | [Docs][Navigation Drawer Docs] | [1.0.0] |
72-
| Radio | ✅ | [Docs][Radio Docs] | [1.0.0] |
73-
| Radio Group | ✅ | [Docs][Radio Docs] | [1.0.0] |
74-
| Ripple | ✅ | [Docs][Ripple Docs] | [1.0.0] |
75-
| Switch | ✅ | [Docs][Switch Docs] | [1.0.0] |
27+
| Components | Status | Documentation | Released Version | License |
28+
| :---------------------- | :----: | :----------------------------: | :--------------: | :---------: |
29+
| Chat | ✅ | [Docs][Chat Docs] | [6.3.0] | [MIT](LICENSE) |
30+
| Date Range Picker | ✅ | [Docs][Date Range Picker Docs] | [6.1.0] | [MIT](LICENSE) |
31+
| Tooltip | ✅ | [Docs][Tooltip Docs] | [5.4.0] | [MIT](LICENSE) |
32+
| File Input | ✅ | [Docs][File Input Docs] | [5.4.0] | [MIT](LICENSE) |
33+
| Tile Manager | ✅ | [Docs][Tile Manager Docs] | [5.3.0] | [MIT](LICENSE) |
34+
| Carousel | ✅ | [Docs][Carousel Docs] | [5.1.0] | [MIT](LICENSE) |
35+
| Date picker | ✅ | [Docs][Date Picker Docs] | [4.10.0] | [MIT](LICENSE) |
36+
| Divider | ✅ | [Docs][Divider Docs] | [4.10.0] | [MIT](LICENSE) |
37+
| Banner | ✅ | [Docs][Banner Docs] | [4.10.0] | [MIT](LICENSE) |
38+
| Button group | ✅ | [Docs][Button Group Docs] | [4.5.0] | [MIT](LICENSE) |
39+
| Textarea | ✅ | [Docs][Textarea Docs] | [4.5.0] | [MIT](LICENSE) |
40+
| Combo | ✅ | [Docs][Combo Docs] | [4.1.0] | [MIT](LICENSE) |
41+
| Stepper | ✅ | [Docs][Stepper Docs] | [4.1.0] | [MIT](LICENSE) |
42+
| Select | ✅ | [Docs][Select Docs] | [3.4.0] | [MIT](LICENSE) |
43+
| Dialog | ✅ | [Docs][Dialog Docs] | [3.4.0] | [MIT](LICENSE) |
44+
| Date Time Input | ✅ | [Docs][Date Time Input Docs] | [3.3.0] | [MIT](LICENSE) |
45+
| Tabs | ✅ | [Docs][Tabs Docs] | [3.3.0] | [MIT](LICENSE) |
46+
| Accordion | ✅ | [Docs][Accordion Docs] | [3.3.0] | [MIT](LICENSE) |
47+
| Mask Input | ✅ | [Docs][Masked Input Docs] | [3.2.0] | [MIT](LICENSE) |
48+
| Expansion Panel | ✅ | [Docs][Expansion Panel Docs] | [3.2.0] | [MIT](LICENSE) |
49+
| Tree | ✅ | [Docs][Tree Docs] | [3.2.0] | [MIT](LICENSE) |
50+
| Drop Down | ✅ | [Docs][Dropdown Docs] | [2.2.0] | [MIT](LICENSE) |
51+
| Linear Progress | ✅ | [Docs][Linear Progress Docs] | [2.1.0] | [MIT](LICENSE) |
52+
| Circular Progress | ✅ | [Docs][Circular Progress Docs] | [2.1.0] | [MIT](LICENSE) |
53+
| Chip | ✅ | [Docs][Chip Docs] | [2.1.0] | [MIT](LICENSE) |
54+
| Snackbar | ✅ | [Docs][Snackbar Docs] | [2.1.0] | [MIT](LICENSE) |
55+
| Toast | ✅ | [Docs][Toast Docs] | [2.1.0] | [MIT](LICENSE) |
56+
| Rating | ✅ | [Docs][Rating Docs] | [2.1.0] | [MIT](LICENSE) |
57+
| Slider | ✅ | [Docs][Slider Docs] | [2.0.0] | [MIT](LICENSE) |
58+
| Range Slider | ✅ | [Docs][Slider Docs] | [2.0.0] | [MIT](LICENSE) |
59+
| Avatar | ✅ | [Docs][Avatar Docs] | [1.0.0] | [MIT](LICENSE) |
60+
| Badge | ✅ | [Docs][Badge Docs] | [1.0.0] | [MIT](LICENSE) |
61+
| Button | ✅ | [Docs][Button Docs] | [1.0.0] | [MIT](LICENSE) |
62+
| Calendar | ✅ | [Docs][Calendar Docs] | [1.0.0] | [MIT](LICENSE) |
63+
| Card | ✅ | [Docs][Card Docs] | [1.0.0] | [MIT](LICENSE) |
64+
| Checkbox | ✅ | [Docs][Checkbox Docs] | [1.0.0] | [MIT](LICENSE) |
65+
| Form | ✅ | [Docs][Form Docs] | [1.0.0] | [MIT](LICENSE) |
66+
| Icon | ✅ | [Docs][Icon Docs] | [1.0.0] | [MIT](LICENSE) |
67+
| Icon Button | ✅ | [Docs][Icon Button Docs] | [1.0.0] | [MIT](LICENSE) |
68+
| Input | ✅ | [Docs][Input Docs] | [1.0.0] | [MIT](LICENSE) |
69+
| List | ✅ | [Docs][List Docs] | [1.0.0] | [MIT](LICENSE) |
70+
| Navigation Bar (Navbar) | ✅ | [Docs][Navigation Bar Docs] | [1.0.0] | [MIT](LICENSE) |
71+
| Navigation Drawer | ✅ | [Docs][Navigation Drawer Docs] | [1.0.0] | [MIT](LICENSE) |
72+
| Radio | ✅ | [Docs][Radio Docs] | [1.0.0] | [MIT](LICENSE) |
73+
| Radio Group | ✅ | [Docs][Radio Docs] | [1.0.0] | [MIT](LICENSE) |
74+
| Ripple | ✅ | [Docs][Ripple Docs] | [1.0.0] | [MIT](LICENSE) |
75+
| Switch | ✅ | [Docs][Switch Docs] | [1.0.0] | [MIT](LICENSE) |
7676

7777
</details>
7878

79-
## Components available in [Ignite UI for WebComponents Grids]
79+
## Components available in Ignite UI for WebComponents Grids & Grid Lite
8080

81-
| Components | Status | Documentation |
82-
| :---------------- | :----: | :----------------------------: |
83-
| Pivot Grid | ✅ | [Docs][Pivot Grid Docs] |
84-
| Data Grid | ✅ | [Docs][Data Grid Docs] |
85-
| Tree Grid | ✅ | [Docs][Tree Grid Docs] |
86-
| Hierarchical Grid | ✅ | [Docs][Hierarchical Grid Docs] |
81+
| Components | Status | Documentation | License | Package |
82+
| :---------------- | :----: | :----------------------------: | :---------: | :---------: |
83+
| Pivot Grid | ✅ | [Docs][Pivot Grid Docs] | [Commercial][Commercial] | [Ignite UI Web Components Grids][Ignite UI for WebComponents Grids] |
84+
| Data Grid | ✅ | [Docs][Data Grid Docs] | [Commercial][Commercial] | [Ignite UI Web Components Grids][Ignite UI for WebComponents Grids] |
85+
| Tree Grid | ✅ | [Docs][Tree Grid Docs] | [Commercial][Commercial] | [Ignite UI Web Components Grids][Ignite UI for WebComponents Grids] |
86+
| Hierarchical Grid | ✅ | [Docs][Hierarchical Grid Docs] | [Commercial][Commercial] | [Ignite UI Web Components Grids][Ignite UI for WebComponents Grids] |
87+
| Grid Lite | ✅ | [Docs][Grid Lite] | [MIT](LICENSE) | [Ignite UI Web Components Grid Lite][Ignite UI for WebComponents Grid Lite] |
8788

8889
### The Lightweight Web Components Data Grid and Data Table
8990

@@ -95,6 +96,10 @@ The Ignite UI for Web Components Data Grid and Table are both lightweight and de
9596

9697
Provide a complete windowing experience, splitting complex layouts into smaller, easier-to-manage panes.
9798

99+
- [Documentation](https://www.infragistics.com/products/ignite-ui-web-components/web-components/components/layouts/dock-manager)
100+
- License - [Commercial](https://www.infragistics.com/legal/license)
101+
- Package - [igniteui-dockmanager](https://www.npmjs.com/package/igniteui-dockmanager)
102+
98103
## Usage
99104

100105
In order to use the Ignite UI Web Components in your application you should install the `igniteui-webcomponents` package:
@@ -195,7 +200,9 @@ npm run storybook:build
195200
[Ignite UI for Web Components]: https://www.infragistics.com/products/ignite-ui-web-components
196201
[Indigo.Design Design System]: https://www.infragistics.com/products/appbuilder/ui-toolkit
197202
[Ignite UI for WebComponents Grids]: https://www.npmjs.com/package/igniteui-webcomponents-grids
203+
[Ignite UI for WebComponents Grids Lite] https://www.npmjs.com/package/igniteui-webcomponents-grid-lite
198204
[Dock Manager Picture]: https://github.com/IgniteUI/igniteui-webcomponents/assets/52001020/a9643f17-f1c2-4554-87aa-96c9daea13b0
205+
[Dock Manager NPM]: https://www.npmjs.com/package/igniteui-dockmanager
199206
[Custom Elements Manifest]: https://github.com/webcomponents/custom-elements-manifest
200207
[VSCode Custom Data Format]: https://github.com/microsoft/vscode-custom-data
201208
[Web Types]: https://plugins.jetbrains.com/docs/intellij/websymbols-web-types.html
@@ -258,6 +265,8 @@ npm run storybook:build
258265
[Tooltip Docs]: https://www.infragistics.com/products/ignite-ui-web-components/web-components/components/inputs/tooltip
259266
[Date Range Picker Docs]: https://www.infragistics.com/products/ignite-ui-web-components/web-components/components/scheduling/date-range-picker
260267
[Chat Docs]: https://www.infragistics.com/products/ignite-ui-web-components/web-components/components/interactivity/chat
268+
[Commercial]: https://www.infragistics.com/legal/license
269+
[Grid Lite]: https://www.infragistics.com/products/ignite-ui-web-components/web-components/components/grid-lite/overview
261270
[1.0.0]: https://github.com/IgniteUI/igniteui-webcomponents/releases/tag/1.0.0
262271
[2.0.0]: https://github.com/IgniteUI/igniteui-webcomponents/releases/tag/2.0.0
263272
[2.1.0]: https://github.com/IgniteUI/igniteui-webcomponents/releases/tag/2.1.0

0 commit comments

Comments
 (0)