@n-isi-platform/design-system 1.0.18 → 1.0.20
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
CHANGED
|
@@ -1,109 +1,109 @@
|
|
|
1
|
-
# N-ISI Design System
|
|
2
|
-
|
|
3
|
-
> Supporting UI component library for the **N-ISI** project
|
|
4
|
-
> *(Novi informacijski sistem inšpektorjev — New Information System for Inspectors)*
|
|
5
|
-
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## 📦 About
|
|
9
|
-
|
|
10
|
-
This package contains shared, reusable **standalone Angular components** and **UI building blocks** for all N-ISI frontend applications.
|
|
11
|
-
It is based on [PrimeNG](https://www.primefaces.org/primeng/) and fully supports **Angular 19+**, **Module Federation**, and **lazy-loaded microfrontends**.
|
|
12
|
-
|
|
13
|
-
---
|
|
14
|
-
|
|
15
|
-
## 🚀 Usage
|
|
16
|
-
|
|
17
|
-
Install the package via npm:
|
|
18
|
-
|
|
19
|
-
```bash
|
|
20
|
-
npm install @n-isi-platform/design-system
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
Then import and use the components in your Angular module or standalone component:
|
|
24
|
-
|
|
25
|
-
```ts
|
|
26
|
-
import { FancyButtonComponent } from '@n-isi-platform/design-system';
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
---
|
|
30
|
-
|
|
31
|
-
## 🧩 Features
|
|
32
|
-
|
|
33
|
-
- ✅ Angular 19+ support
|
|
34
|
-
- ✅ PrimeNG-based standalone components
|
|
35
|
-
- ✅ Module Federation compatible (`singleton`, `strictVersion`)
|
|
36
|
-
- ✅ Lazy-loadable components
|
|
37
|
-
- ✅ Custom theming integration (optional)
|
|
38
|
-
|
|
39
|
-
---
|
|
40
|
-
|
|
41
|
-
## 🛠️ Development
|
|
42
|
-
|
|
43
|
-
To build the package locally:
|
|
44
|
-
|
|
45
|
-
```bash
|
|
46
|
-
npm run build:design-system
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
Or directly via `ng-packagr`:
|
|
50
|
-
|
|
51
|
-
```bash
|
|
52
|
-
npx ng-packagr -p projects/design-system/ng-package.json
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
To test the local build in another Angular project:
|
|
56
|
-
|
|
57
|
-
```bash
|
|
58
|
-
npm install file:../dist/design-system
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
---
|
|
62
|
-
|
|
63
|
-
## 📁 Project Structure
|
|
64
|
-
|
|
65
|
-
```
|
|
66
|
-
projects/
|
|
67
|
-
└── design-system/
|
|
68
|
-
├── src/
|
|
69
|
-
│ ├── lib/
|
|
70
|
-
│ │ └── [components]/
|
|
71
|
-
│ └── public-api.ts
|
|
72
|
-
├── package.json
|
|
73
|
-
├── ng-package.json
|
|
74
|
-
└── README.md
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
---
|
|
78
|
-
|
|
79
|
-
## 🔒 Dependencies
|
|
80
|
-
|
|
81
|
-
This package defines Angular, PrimeNG and others as `peerDependencies`.
|
|
82
|
-
The host application must provide matching versions:
|
|
83
|
-
|
|
84
|
-
```json
|
|
85
|
-
"peerDependencies": {
|
|
86
|
-
"@angular/core": "19.2.6",
|
|
87
|
-
"@angular/common": "19.2.6",
|
|
88
|
-
"primeng": "19.1.3"
|
|
89
|
-
}
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
---
|
|
93
|
-
|
|
94
|
-
## 📦 Publishing
|
|
95
|
-
|
|
96
|
-
After building the package:
|
|
97
|
-
|
|
98
|
-
```bash
|
|
99
|
-
cd dist/design-system
|
|
100
|
-
npm publish --access public
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
For scoped or private registry publishing, make sure `.npmrc` is configured accordingly.
|
|
104
|
-
|
|
105
|
-
---
|
|
106
|
-
|
|
107
|
-
## 👨💻 Authors
|
|
108
|
-
|
|
109
|
-
- Endava (@marko.kovacic)
|
|
1
|
+
# N-ISI Design System
|
|
2
|
+
|
|
3
|
+
> Supporting UI component library for the **N-ISI** project
|
|
4
|
+
> *(Novi informacijski sistem inšpektorjev — New Information System for Inspectors)*
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## 📦 About
|
|
9
|
+
|
|
10
|
+
This package contains shared, reusable **standalone Angular components** and **UI building blocks** for all N-ISI frontend applications.
|
|
11
|
+
It is based on [PrimeNG](https://www.primefaces.org/primeng/) and fully supports **Angular 19+**, **Module Federation**, and **lazy-loaded microfrontends**.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## 🚀 Usage
|
|
16
|
+
|
|
17
|
+
Install the package via npm:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm install @n-isi-platform/design-system
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Then import and use the components in your Angular module or standalone component:
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import { FancyButtonComponent } from '@n-isi-platform/design-system';
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## 🧩 Features
|
|
32
|
+
|
|
33
|
+
- ✅ Angular 19+ support
|
|
34
|
+
- ✅ PrimeNG-based standalone components
|
|
35
|
+
- ✅ Module Federation compatible (`singleton`, `strictVersion`)
|
|
36
|
+
- ✅ Lazy-loadable components
|
|
37
|
+
- ✅ Custom theming integration (optional)
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## 🛠️ Development
|
|
42
|
+
|
|
43
|
+
To build the package locally:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
npm run build:design-system
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Or directly via `ng-packagr`:
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
npx ng-packagr -p projects/design-system/ng-package.json
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
To test the local build in another Angular project:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
npm install file:../dist/design-system
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## 📁 Project Structure
|
|
64
|
+
|
|
65
|
+
```
|
|
66
|
+
projects/
|
|
67
|
+
└── design-system/
|
|
68
|
+
├── src/
|
|
69
|
+
│ ├── lib/
|
|
70
|
+
│ │ └── [components]/
|
|
71
|
+
│ └── public-api.ts
|
|
72
|
+
├── package.json
|
|
73
|
+
├── ng-package.json
|
|
74
|
+
└── README.md
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## 🔒 Dependencies
|
|
80
|
+
|
|
81
|
+
This package defines Angular, PrimeNG and others as `peerDependencies`.
|
|
82
|
+
The host application must provide matching versions:
|
|
83
|
+
|
|
84
|
+
```json
|
|
85
|
+
"peerDependencies": {
|
|
86
|
+
"@angular/core": "19.2.6",
|
|
87
|
+
"@angular/common": "19.2.6",
|
|
88
|
+
"primeng": "19.1.3"
|
|
89
|
+
}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## 📦 Publishing
|
|
95
|
+
|
|
96
|
+
After building the package:
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
cd dist/design-system
|
|
100
|
+
npm publish --access public
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
For scoped or private registry publishing, make sure `.npmrc` is configured accordingly.
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
## 👨💻 Authors
|
|
108
|
+
|
|
109
|
+
- Endava (@marko.kovacic)
|