minahil 0.1.10 → 0.1.12
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/README.md +37 -7
- package/package.json +14 -6
- package/schematics/collection.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Minahil - Angular UI Component Library
|
|
2
2
|
|
|
3
3
|
A comprehensive Angular UI component library featuring a rich collection of customizable, accessible components. Built with modern Angular standards, this library provides everything you need to build beautiful and functional user interfaces.
|
|
4
4
|
|
|
@@ -6,11 +6,12 @@ A comprehensive Angular UI component library featuring a rich collection of cust
|
|
|
6
6
|
|
|
7
7
|
- 📦 **Comprehensive Component Library** - Rich set of UI components for common use cases
|
|
8
8
|
- ♿ **Accessible by Default** - WCAG compliant components with keyboard navigation and screen reader support
|
|
9
|
-
- 🚀 **Angular
|
|
9
|
+
- 🚀 **Angular 17-21 Support** - Built with modern Angular features and standalone components
|
|
10
10
|
- 📱 **Responsive Design** - Mobile-first components that work on all screen sizes
|
|
11
11
|
- 🎯 **Type-Safe** - Full TypeScript support with comprehensive type definitions
|
|
12
12
|
- ⚡ **Lightweight** - Tree-shakeable and optimized for performance
|
|
13
13
|
- 🎛️ **Highly Customizable** - Extensive configuration options for every component
|
|
14
|
+
- 🔧 **Easy Setup** - One-command installation with automatic dependency management
|
|
14
15
|
|
|
15
16
|
## 📚 Available Components
|
|
16
17
|
|
|
@@ -32,20 +33,49 @@ A fully accessible radio button component with Angular forms integration. Featur
|
|
|
32
33
|
|
|
33
34
|
_More components coming soon..._
|
|
34
35
|
|
|
35
|
-
##
|
|
36
|
+
## 🚀 Quick Start
|
|
37
|
+
|
|
38
|
+
### Automatic Installation (Recommended)
|
|
39
|
+
|
|
40
|
+
The easiest way to install Minahil is using Angular CLI's `ng add` command. This automatically installs the library along with matching versions of Angular CDK and other dependencies:
|
|
36
41
|
|
|
37
42
|
```bash
|
|
38
|
-
|
|
43
|
+
ng add minahil
|
|
39
44
|
```
|
|
40
45
|
|
|
41
|
-
|
|
46
|
+
This will:
|
|
47
|
+
|
|
48
|
+
- ✅ Detect your Angular version (17, 18, 19, 20, or 21)
|
|
49
|
+
- ✅ Install Minahil library
|
|
50
|
+
- ✅ Install matching @angular/cdk version
|
|
51
|
+
- ✅ Install moment.js dependency
|
|
52
|
+
- ✅ Configure everything automatically
|
|
53
|
+
|
|
54
|
+
### Manual Installation
|
|
55
|
+
|
|
56
|
+
If you prefer manual installation:
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
npm install minahil
|
|
60
|
+
```
|
|
42
61
|
|
|
43
|
-
|
|
62
|
+
**Important:** You must also install peer dependencies that match your Angular version:
|
|
44
63
|
|
|
45
64
|
```bash
|
|
46
|
-
|
|
65
|
+
# For Angular 19 projects
|
|
66
|
+
npm install @angular/cdk@^19.0.0 moment@^2.29.0
|
|
67
|
+
|
|
68
|
+
# For Angular 17 projects
|
|
69
|
+
npm install @angular/cdk@^17.0.0 moment@^2.29.0
|
|
70
|
+
|
|
71
|
+
# For Angular 21 projects
|
|
72
|
+
npm install @angular/cdk@^21.0.0 moment@^2.29.0
|
|
47
73
|
```
|
|
48
74
|
|
|
75
|
+
### Supported Angular Versions
|
|
76
|
+
|
|
77
|
+
Minahil supports Angular versions **17 through 21**. The library will automatically work with any Angular version in this range.
|
|
78
|
+
|
|
49
79
|
### Asset Configuration (Required)
|
|
50
80
|
|
|
51
81
|
After installing the library, you need to configure your `angular.json` to include the library's assets (icons, etc.). Add the following to your project's `assets` array in the `build` options:
|
package/package.json
CHANGED
|
@@ -1,12 +1,25 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "minahil",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.12",
|
|
4
|
+
"description": "A comprehensive Angular UI component library with calendar, checkbox, radio, and toggle components",
|
|
5
|
+
"schematics": "./schematics/collection.json",
|
|
6
|
+
"ng-add": {
|
|
7
|
+
"save": "dependencies"
|
|
8
|
+
},
|
|
4
9
|
"peerDependencies": {
|
|
5
10
|
"@angular/cdk": ">=17.0.0 <22.0.0",
|
|
6
11
|
"@angular/common": ">=17.0.0 <22.0.0",
|
|
7
12
|
"@angular/core": ">=17.0.0 <22.0.0",
|
|
8
13
|
"moment": "^2.29.0"
|
|
9
14
|
},
|
|
15
|
+
"peerDependenciesMeta": {
|
|
16
|
+
"@angular/cdk": {
|
|
17
|
+
"optional": true
|
|
18
|
+
},
|
|
19
|
+
"moment": {
|
|
20
|
+
"optional": true
|
|
21
|
+
}
|
|
22
|
+
},
|
|
10
23
|
"dependencies": {
|
|
11
24
|
"tslib": "^2.3.0"
|
|
12
25
|
},
|
|
@@ -21,10 +34,5 @@
|
|
|
21
34
|
"types": "./index.d.ts",
|
|
22
35
|
"default": "./fesm2022/minahil.mjs"
|
|
23
36
|
}
|
|
24
|
-
},
|
|
25
|
-
"schematics": "./schematics/collection.json",
|
|
26
|
-
"description": "A comprehensive Angular UI component library with calendar, checkbox, radio, and toggle components",
|
|
27
|
-
"ng-add": {
|
|
28
|
-
"save": "dependencies"
|
|
29
37
|
}
|
|
30
38
|
}
|