You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: projects/wml-angular-components-base/README.md
+16-2Lines changed: 16 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
1
# WML Angular Components Base
2
2
3
-
When working on web applications, there is no standard baseline. The Angular WML Components Base Library establishes a foundation for your application, ensuring consistency and scalability. The core of this library is the <codedir="auto">WMLUIProperty</code> , which represents the basic building block of every element in a web application. This property encapsulates all the essential features, and there are several subclasses like <codedir="auto">WMLRoute</code> for routes, <codedir="auto">WMLView</code> to leverage change detection, <codedir="auto">WMLImage</code> for images and <codedir="auto">WMLAngularMotionUIProperty</code> for CSS animations and transitions. Each class has properties and methods to optimize your work in those features of your application. You can use this package and leave out the rest of the library and you will get very far building very robust and scalable applications
3
+
WML Angular Components Base extends the WML Components Base by integrating it with Angular-specific features and functionality. It builds on the foundation provided by the core library and adds seamless integration with Angular’s framework, making it easier to work with Angular modules, change detection, and Angular-based services like ngx-translate.
4
+
5
+
While WML Components Base provides the essential UI building blocks, WML Angular Components Base enhances these components to work natively with Angular. This includes adding support for Angular’s dependency injection, change detection, routing, and lifecycle hooks.
4
6
5
7
6
8
@@ -68,4 +70,16 @@ WMLAngularCustomComponent from their orginal respective part which exlude “Ang
68
70
69
71
### v18.2.3100 [9/8/24]
70
72
71
-
updated package to reflect the version 18.2.3 of @angular/core package[](/Windmillcode-Angular-CDK-Docs/intro/wml-components-base)[](/Windmillcode-Angular-CDK-Docs/schematics/wml-schematics/)
73
+
updated package to reflect the version 18.2.3 of @angular/core package
74
+
75
+
### v18.2.3100 [9/8/24]
76
+
77
+
updated package to reflect the version 18.2.3 of @angular/core package
78
+
79
+
### v18.2.3100 [9/8/24]
80
+
81
+
updated package to reflect the version 18.2.3 of @angular/core package
82
+
83
+
### v18.2.3110 [9/10/24]
84
+
85
+
updated package to conform with @windmillcode/angular-wml-components-base[](/Windmillcode-Angular-CDK-Docs/intro/wml-components-base)[](/Windmillcode-Angular-CDK-Docs/schematics/wml-schematics/)
<table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>framework</td><td><codedir="auto">Framework</code></td><td>Holds the detected framework information.</td></tr></tbody></table>
50
+
51
+
<codedir="auto">framework</code> <table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>name</td><td><codedir="auto">WMLUIFrameworkType</code></td><td>The name of the detected UI framework.</td></tr></tbody></table>
52
+
53
+
54
+
47
55
### WMLEndpoint
48
56
49
57
<table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><codedir="auto">url</code></td><td><codedir="auto">Function</code></td><td>Function that defines the endpoint’s URL.</td></tr><tr><td><codedir="auto">automate</code></td><td><codedir="auto">boolean</code></td><td>Indicates whether to automate API requests for the endpoint.</td></tr></tbody></table>
@@ -138,7 +146,17 @@ Type Behavior<table><thead><tr><th>Condition</th><th>Behavior</th></tr></thead><
138
146
139
147
### Functions
140
148
141
-
<codedir="auto">detectFramework()</code> <table><thead><tr><th>Description</th></tr></thead><tbody><tr><td>Detects the current frontend framework being used (e.g., React, Angular, Vue.js, etc.). Returns the framework as a string. Not guaranteed to be accurate</td></tr></tbody></table>
149
+
<codedir="auto">updateGlobal</code> <table><thead><tr><th>Signature</th><th>Return Type</th><th>Description</th></tr></thead><tbody><tr><td><codedir="auto">updateGlobal(props: WMLDeepPartial<WMLUIGlobal & { propFrameworkName?: string }>)</code></td><td><codedir="auto">void</code></td><td>Updates the global <codedir="auto">WINDMILLCODE</code> object with provided properties and optionally changes framework name. useful if detectframework gets the framework name wrong</td></tr></tbody></table>
150
+
151
+
<codedir="auto">props</code> <table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>propFrameworkName</td><td><codedir="auto">string</code> (optional)</td><td>Optionally updates the framework name in the global object.</td></tr><tr><td>…rest</td><td><codedir="auto">WMLDeepPartial<WMLUIGlobal></code></td><td>All other properties of <codedir="auto">WMLUIGlobal</code> to be applied globally.</td></tr></tbody></table>
152
+
153
+
<codedir="auto">getGlobalObject</code> <table><thead><tr><th>Signature</th><th>Return Type</th><th>Description</th></tr></thead><tbody><tr><td><codedir="auto">getGlobalObject(): any</code></td><td><codedir="auto">any</code></td><td>Returns the appropriate global object based on the environment: <codedir="auto">globalThis</code>, <codedir="auto">window</code>, <codedir="auto">global</code>, or <codedir="auto">self</code>.</td></tr></tbody></table>
154
+
155
+
<codedir="auto">Return Object</code> <table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>globalThis</td><td><codedir="auto">any</code></td><td>Standard ECMAScript global object.</td></tr><tr><td>window</td><td><codedir="auto">any</code></td><td>Global object for browser environments.</td></tr><tr><td>global</td><td><codedir="auto">any</code></td><td>Global object for Node.js environments.</td></tr><tr><td>self</td><td><codedir="auto">any</code></td><td>Global object for Web Workers.</td></tr><tr><td></td><td><codedir="auto">Object</code></td><td>Fallback empty object if none of the above globals are available.</td></tr></tbody></table>
156
+
157
+
<codedir="auto">detectFramework</code> <table><thead><tr><th>Signature</th><th>Return Type</th><th>Description</th></tr></thead><tbody><tr><td><codedir="auto">detectFramework(): WMLUIFrameworkType</code></td><td><codedir="auto">WMLUIFrameworkType</code></td><td>Detects the framework used in the environment (React, Angular, Vue.js, etc.).</td></tr></tbody></table>
158
+
159
+
<codedir="auto">myWindow</code> <table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>myWindow</td><td><codedir="auto">any</code></td><td>Represents the global <codedir="auto">window</code> object or an empty object if <codedir="auto">window</code> is undefined.</td></tr></tbody></table>
142
160
143
161
<codedir="auto">generateUUID(prefix: string)</code> <table><thead><tr><th>Description</th></tr></thead><tbody><tr><td>Generates a UUID with an optional prefix and returns it as a string.</td></tr></tbody></table>
144
162
@@ -871,12 +889,24 @@ updated package to reflect the version 18.2.3 of @angular/core package
871
889
872
890
### v18.2.3100 [9/8/24]
873
891
874
-
[BREAKING CHANGE] seperated angular features from core librarly to angular-wml-components-base
892
+
[BREAKING CHANGE] seperated angular features from core library to angular-wml-components-base
875
893
moving WMLComponentBaseZeroPropsMixin, WMLComponentBaseZeroProps, WMLComponentBaseZero,addCustomComponent, WMLNGXTranslateLoader,WMLTestUtils to the angular base library
876
894
deleting WMLModuleForRootProps
877
895
896
+
### v18.2.3110 [9/10/2024 1:45:22 PM EST]
878
897
898
+
[UPDATE] Added new global object management functions <codedir="auto">updateGlobal</code> and <codedir="auto">getGlobalObject</code> in <codedir="auto">functions.ts</code> . This gives developers access to globally update and retrieve the framework’s global object easily.
879
899
880
-
### v18.2.3100 [9/8/24]
900
+
[UPDATE] Added a new <codedir="auto">WMLUIGlobal</code> class in <codedir="auto">models.ts</code> to represent the global configuration options for the library
901
+
902
+
[FIX] All references to <codedir="auto">WMLUIProperty.framework</code> have been replaced with <codedir="auto">getGlobalObject().WINDMILLCODE.framework.name</code> . Developers should now use the global framework object instead of relying on the static <codedir="auto">WMLUIProperty.framework</code> .
903
+
904
+
905
+
906
+
### v18.2.3110 [9/10/24]
907
+
908
+
updated package to conform with @windmillcode/angular-wml-components-base
909
+
910
+
### v18.2.3110 [9/10/24]
881
911
882
-
updated package to reflect the version 18.2.3 of @angular/core package[](/Windmillcode-Angular-CDK-Docs/intro/wml-angular-components-base)
912
+
updated package to conform with @windmillcode/angular-wml-components-base[](/Windmillcode-Angular-CDK-Docs/intro/wml-angular-components-base)
0 commit comments