-
Notifications
You must be signed in to change notification settings - Fork 51
Angular native wrappers - #3933 #4206
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Angular native wrappers - #3933 #4206
Conversation
Adds references to the upcoming Angular packages to the build, commit and ci files. Also tweaks the contributing documentation slightly. re mi6#3933
…ive components Adds the angularOutputTarget plugin for stencil and includes relevant config so that the natively wrapped ICDS elements are output as a package. Also adds a pure output for the web components as an intermediary packaged within @ukic/web-components for the Angular plugin to make use of. ref mi6#3933
…ing the angular native wrappers Provides the underlying folders structure, npm config, scripts and such for publishing the Angular package. Also includes the 3.18.0 output from the stencil generator. closes mi6#3933
GCHQ-Developer-112
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is just an initial review, I will review this again most likely some time next week
| cd ../angular-community-supported | ||
| npm i --package-lock-only |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm worried that this will affect our usual releases
| dist/ | ||
| www/ | ||
| loader/ | ||
| components/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will mean changes to our components will not be committed - please remove this line
| "dist/", | ||
| "loader/", | ||
| "hydrate/", | ||
| "components/", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why has this been added?
| ### React & Angular | ||
|
|
||
| Stencil provides [plugins](https://stenciljs.com/docs/overview), which outputs wrapped framework agnostic components. During the build stage, React components are dynamically generated and are accessible from the React package. | ||
| Stencil provides [plugins](https://stenciljs.com/docs/overview), which outputs wrapped framework agnostic components. During the build stage, Native components for React and Angular are dynamically generated and are accessible from their respective packages. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please move the information about Angular into a separate heading and explain that this is a community supported package and what that means for the contributions
| "audit-expiry": "node check-audit-expiry.mjs", | ||
| "bootstrap": "lerna bootstrap", | ||
| "build": "lerna run build --scope=@ukic/web-components --scope=@ukic/fonts --scope=@ukic/docs --stream && lerna run build --scope=@ukic/react --stream", | ||
| "build": "lerna run build --scope=@ukic/web-components --scope=@ukic/fonts --scope=@ukic/docs --stream && lerna run build --scope=@ukic/react --stream && lerna run build --scope=@ukic/angular-community-supported --stream", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please create a separate build command for Angular and ensure that the build all command excludes angular
|
|
||
| This is a joint project led by [MI6](https://www.sis.gov.uk), working with [GCHQ](https://www.gchq.gov.uk), [MI5](https://www.mi5.gov.uk) and [HMGCC](https://www.hmgcc.gov.uk) (our national security partner). | ||
|
|
||
| <div style="border: 1px red solid; border-radius: 3px; background-color: red; color: white; padding:8px"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This styling doesn't seem to show up
| <div style="border: 1px red solid; border-radius: 3px; background-color: red; color: white; padding:8px"> |
| <div style="border: 1px red solid; border-radius: 3px; background-color: red; color: white; padding:8px"> | ||
|
|
||
| ### Support Info | ||
| **This Angular-native package is not maintained or supported by the core ICDS team and is entirely community-developed** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| **This Angular-native package is not maintained or supported by the core ICDS team and is entirely community-developed** | |
| > [!WARNING] | |
| > This Angular-native package is not maintained or supported by the core ICDS team and is entirely community-developed |
| ### Support Info | ||
| **This Angular-native package is not maintained or supported by the core ICDS team and is entirely community-developed** | ||
|
|
||
| </div> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| </div> |
GCHQ-Developer-299
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will review again when @GCHQ-Developer-112 's comments have been addressed
Summary of the changes
Set up new output targets in the stencil config to output native angular wrapper components in a similar vein to the react components. Versions have been included that will allow the integrating developers to import the components as standalone items one-by-one at need or as a whole module. This also required the addition/alteration of the custom-elements-dist output to create an internal package for the web-components that the angular output plugin could use.
The package is included in the pack all script and other checks. Also includes an Angular schematic in the package so users can install simply with "ng add".
Documentation has been updated to indicate installation and useage of the new package and components and to provide clarity that this is a community-developed and supported addition as per the ICDS team's request.
(This is a rebuild of #4180 )
Related issue
closes #3933
& ic-design-system 850
Checklist
General
Testing
Accessibility
Resize/zoom behaviour
System modes
Testing content extremes