@ruc-lib/org-chart 2.0.4 → 3.1.0

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
@@ -27,6 +27,17 @@ A component for creating a org chart. There are various features like Downloadin
27
27
  If users only need the dataflow component, they can install it separately
28
28
  `npm install @ruc-lib/org-chart`
29
29
 
30
+ # Version Compatibility
31
+
32
+ Please ensure you install the correct version of `@ruc-lib/org-chart` based on your Angular version.
33
+
34
+ | Angular Version | Compatible `@ruc-lib/org-chart` Version |
35
+ |--------------------|---------------------------------------------|
36
+ | 15.x.x | `npm install @ruc-lib/org-chart@^3.0.0` |
37
+ | 16.x.x | `npm install @ruc-lib/org-chart@^3.0.0` |
38
+
39
+ **Note:** If you are facing any build/compile issue related to "primeng", then install "primeng" explicitly according to angular version.
40
+
30
41
  # Usage
31
42
 
32
43
  After installing the the required package successfully, we have to import the CSS in our style.scss file in following way.
@@ -56,7 +67,7 @@ for seperate package
56
67
  # use component selector
57
68
 
58
69
  ```
59
- <uxp-org-chart [rucInputData]="inputOrgData" [customTheme]="customTheme"></uxp-org-chart>
70
+ <uxp-ruclib-org-chart [rucInputData]="inputOrgData" [customTheme]="customTheme"></uxp-ruclib-org-chart>
60
71
  ```
61
72
 
62
73
 
@@ -194,9 +205,24 @@ const inputOrgData = {
194
205
 
195
206
  ```
196
207
 
208
+ > ⚠️ **IMPORTANT: Custom Theme Usage in Angular Material**
209
+
210
+ When implementing **custom themes**, such as:
211
+
212
+ ```scss
213
+ .custom-theme-1 {
214
+ @include angular-material-theme($custom-theme);
215
+ }
216
+
217
+ // You must also include the typography mixin to ensure text styles are applied correctly as shown below:
218
+ .custom-theme-1 {
219
+ @include angular-material-theme($custom-theme);
220
+ @include mat.typography-level($theme-custom-typography-name, body-1);
221
+ }
222
+ ```
197
223
 
198
224
  # Contribution
199
225
  Contributions are welcome! Feel free to open issues or pull requests for any enhancements or fixes.
200
226
 
201
227
  # Acknowledgements
202
- Thank you for choosing the Data flow Component Library. If you have any feedback or suggestions, please let us know!
228
+ Thank you for choosing the Data flow Component Library. If you have any feedback or suggestions, please let us know!