Skip to content

Commit 2a6289d

Browse files
committed
'[CHECKPOINT]' updated package to conform with @windmillcode/angular-wml-components-base version 18.2.3111
1 parent 1ccd71c commit 2a6289d

File tree

4 files changed

+53
-9
lines changed

4 files changed

+53
-9
lines changed

projects/wml-angular-components-base/README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# WML Angular Components Base
22

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 <code dir="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 <code dir="auto">WMLRoute</code> for routes, <code dir="auto">WMLView</code> to leverage change detection, <code dir="auto">WMLImage</code> for images and <code dir="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.
46

57

68

@@ -68,4 +70,16 @@ WMLAngularCustomComponent from their orginal respective part which exlude “Ang
6870

6971
### v18.2.3100 [9/8/24]
7072

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/)

projects/wml-angular-components-base/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@
99
"peerDependencies": {
1010
"@angular/common": "^18.0.0",
1111
"@angular/core": "^18.0.0",
12-
"@windmillcode/wml-components-base": "^18.2.3110"
12+
"@windmillcode/wml-components-base": "^18.2.3111"
1313
},
1414
"private": false,
1515
"schematics": "",
1616
"scripts": {
1717
"build": "npx ng build"
1818
},
19-
"version": "18.2.3110"
19+
"version": "18.2.3111"
2020
}

projects/wml-components-base/README.md

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,14 @@ Methods<table><thead><tr><th>Method</th><th>Description</th></tr></thead><tbody>
4444

4545

4646

47+
### <code dir="auto">WMLUIGlobal</code>
48+
49+
<table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>framework</td><td><code dir="auto">Framework</code></td><td>Holds the detected framework information.</td></tr></tbody></table>
50+
51+
<code dir="auto">framework</code> <table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>name</td><td><code dir="auto">WMLUIFrameworkType</code></td><td>The name of the detected UI framework.</td></tr></tbody></table>
52+
53+
54+
4755
### WMLEndpoint
4856

4957
<table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code dir="auto">url</code></td><td><code dir="auto">Function</code></td><td>Function that defines the endpoint’s URL.</td></tr><tr><td><code dir="auto">automate</code></td><td><code dir="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><
138146

139147
### Functions
140148

141-
<code dir="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+
<code dir="auto">updateGlobal</code> <table><thead><tr><th>Signature</th><th>Return Type</th><th>Description</th></tr></thead><tbody><tr><td><code dir="auto">updateGlobal(props: WMLDeepPartial&lt;WMLUIGlobal &amp; { propFrameworkName?: string }&gt;)</code></td><td><code dir="auto">void</code></td><td>Updates the global <code dir="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+
<code dir="auto">props</code> <table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>propFrameworkName</td><td><code dir="auto">string</code> (optional)</td><td>Optionally updates the framework name in the global object.</td></tr><tr><td>…rest</td><td><code dir="auto">WMLDeepPartial&lt;WMLUIGlobal&gt;</code></td><td>All other properties of <code dir="auto">WMLUIGlobal</code> to be applied globally.</td></tr></tbody></table>
152+
153+
<code dir="auto">getGlobalObject</code> <table><thead><tr><th>Signature</th><th>Return Type</th><th>Description</th></tr></thead><tbody><tr><td><code dir="auto">getGlobalObject(): any</code></td><td><code dir="auto">any</code></td><td>Returns the appropriate global object based on the environment: <code dir="auto">globalThis</code>, <code dir="auto">window</code>, <code dir="auto">global</code>, or <code dir="auto">self</code>.</td></tr></tbody></table>
154+
155+
<code dir="auto">Return Object</code> <table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>globalThis</td><td><code dir="auto">any</code></td><td>Standard ECMAScript global object.</td></tr><tr><td>window</td><td><code dir="auto">any</code></td><td>Global object for browser environments.</td></tr><tr><td>global</td><td><code dir="auto">any</code></td><td>Global object for Node.js environments.</td></tr><tr><td>self</td><td><code dir="auto">any</code></td><td>Global object for Web Workers.</td></tr><tr><td></td><td><code dir="auto">Object</code></td><td>Fallback empty object if none of the above globals are available.</td></tr></tbody></table>
156+
157+
<code dir="auto">detectFramework</code> <table><thead><tr><th>Signature</th><th>Return Type</th><th>Description</th></tr></thead><tbody><tr><td><code dir="auto">detectFramework(): WMLUIFrameworkType</code></td><td><code dir="auto">WMLUIFrameworkType</code></td><td>Detects the framework used in the environment (React, Angular, Vue.js, etc.).</td></tr></tbody></table>
158+
159+
<code dir="auto">myWindow</code> <table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>myWindow</td><td><code dir="auto">any</code></td><td>Represents the global <code dir="auto">window</code> object or an empty object if <code dir="auto">window</code> is undefined.</td></tr></tbody></table>
142160

143161
<code dir="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>
144162

@@ -871,12 +889,24 @@ updated package to reflect the version 18.2.3 of @angular/core package
871889

872890
### v18.2.3100 [9/8/24]
873891

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
875893
moving WMLComponentBaseZeroPropsMixin, WMLComponentBaseZeroProps, WMLComponentBaseZero,addCustomComponent, WMLNGXTranslateLoader,WMLTestUtils to the angular base library
876894
deleting WMLModuleForRootProps
877895

896+
### v18.2.3110 [9/10/2024 1:45:22 PM EST]
878897

898+
[UPDATE] Added new global object management functions <code dir="auto">updateGlobal</code> and <code dir="auto">getGlobalObject</code> in <code dir="auto">functions.ts</code> . This gives developers access to globally update and retrieve the framework’s global object easily.
879899

880-
### v18.2.3100 [9/8/24]
900+
[UPDATE] Added a new <code dir="auto">WMLUIGlobal</code> class in <code dir="auto">models.ts</code> to represent the global configuration options for the library
901+
902+
[FIX] All references to <code dir="auto">WMLUIProperty.framework</code> have been replaced with <code dir="auto">getGlobalObject().WINDMILLCODE.framework.name</code> . Developers should now use the global framework object instead of relying on the static <code dir="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]
881911

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)

projects/wml-components-base/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@
1010
"scripts": {
1111
"build": "npx ng build"
1212
},
13-
"version": "18.2.3110"
13+
"version": "18.2.3111"
1414
}

0 commit comments

Comments
 (0)