README.md
[//]: #@corifeus-header
[](https://www.npmjs.com/package/p3x-angular-compile/)
[](https://paypal.me/patrikx3) [](https://www.patrikx3.com/en/front/contact) [](https://www.facebook.com/corifeus.software) [](https://travis-ci.com/patrikx3/angular-compile)
[](https://uptimerobot.patrikx3.com/)
# 🆖 Angular Dynamic Compile - Convert strings to Angular components v2020.10.165
**Bugs are evident™ - MATRIX️**
### NodeJs LTS Version Requirement
```txt
>=12.13.0
```
### Built on NodeJs
```txt
v14.15.3
```
The ```async``` and ```await``` keywords are required. Only the latest LTS variant is supported.
Install NodeJs:
https://nodejs.org/en/download/package-manager/
# Built on Angular
```text
11.0.5
```
# Description
[//]: #@corifeus-header:end
# Use case
Dynamically compile standard strings to fully functional Angular components. Supports imports, exports, and standard context.
## Install
```bash
npm install --save p3x-angular-compile lodash @types/lodash
# or
yarn add p3x-angular-compile lodash @types/lodash
```
## Check out how it works and code
https://angular-compile.corifeus.com
https://github.com/patrikx3/angular-compile/blob/master/src/app/app.component.ts
## IMPORTANT
Make sure Ivy is disabled and allow synthetic default imports in the `tsconfig.json`:
```json
"compilerOptions": {
"allowSyntheticDefaultImports": true
},
"angularCompilerOptions": {
"enableIvy": false
}
```
Make sure AOT is disabled and allow `lodash` `CommonJs` in the `angular.json`:
```json
{
"architect": {
"build": {
"builder": "@angular-devkit/build-angular:browser",
"options": {
"outputPath": "dist/workspace",
"index": "src/index.html",
"main": "src/main.ts",
"polyfills": "src/polyfills.ts",
"tsConfig": "tsconfig.app.json",
"aot-info": "make sure it is false",
"aot": false,
"allowedCommonJsDependencies-info": "allow lodash common js dependencies",
"allowedCommonJsDependencies": ["lodash"],
"assets": [
"src/favicon.ico",
"src/assets"
],
"styles": [
"src/styles.scss"
],
"scripts": []
}
}
}
```
## Usage
```typescript
import { CompileModule} from "p3x-angular-compile"
// the module settings
@NgModule({
imports: [
CorifeusWebMaterialModule, // Optional
CompileModule, // Required
],
declarations: [
Page,
],
providers: [
],
bootstrap: [ Page ]
})
export class Module { };
```
#### Template
```html
<span
<!--- Not required -->
*ngIf="isEnabled"
<!--- Required -->
[p3x-compile]="template"
<!--- Required -->
[p3x-compile-ctx]="this"
<!--- Not required, will just throw the component's exception if not provided -->
[p3x-compile-error-handler]="handleCompileErrorHandler"
<!--- Not required -->
[p3x-compile-module]="dataModule"
>
</span>
```
#### Code
```typescript
// A page example
export class Page {
isEnabled: boolean = true;
dataModule : any = {
//schemas: [CUSTOM_ELEMENTS_SCHEMA],
//declarations: [],
imports: [
MatButtonModule
],
exports: [
]
}
template: string = "<button mat-button mat-raised-button (click)="context.alert()">Dynamic template</button>";
handleCompileErrorHandler(error: Error) {
console.error(error)
}
alert() {
alert('ok');
}
}
```
<!--
#### Actual used dynamic compiler
I use a dynamic Markdown page with ```p3x-angular-compile```:
[Module](https://github.com/patrikx3/corifeus-app-web-pages/blob/master/src/angular/module.ts) , [Example page](https://github.com/patrikx3/corifeus-app-web-pages/blob/master/src/angular/modules/cory-page.ts)
#### Service
[Please refer to use an a service](https://github.com/patrikx3/angular-compile/blob/master/test/angular-webpack/angular/page.ts)
```typescript
export interface CompileOptions {
// cached by template
template: string;
container: ViewContainerRef;
context?: any,
// you can customize here any you want to
// CommonModule, BrowserModule are auto added
// (like *ngIf and angular default directives)
// though CompileModule.forRoot is usually enough
// so you do not need to use it
module?: NgModule;
onCompiled?: Function,
onError?: Function;
}
```
-->
### Options
[Reference for the Angular module settings which are available.](
https://github.com/angular/angular/blob/master/packages/core/src/metadata/ng_module.ts)
<!--
The templates are cached.
-->
<!--
### Deployed example
[Corifeus Pages (JIT + AOT at once)](https://corifeus.com)
#### For now, until there is no options in Angular to use JIT, I just use AOT, so I don't use this component
[Corifeus Pages (AOT)](https://corifeus.com)
[https://github.com/patrikx3/angular-compile/blob/master/src/app/app.component.ts](https://github.com/patrikx3/angular-compile/blob/master/src/app/app.component.ts)
-->
## Dev environment end test
```bash
npm install -g yarn
git clone https://github.com/patrikx3/angular-compile.git
cd angular-compile
npm install
npm run start
```
[http://localhost:4200](http://localhost:4200)
# Errors
## Type x is part of the declarations of 2 modules
Basically, you need a shared component.
https://stackoverflow.com/questions/42993580/angular-2-type-childcomponent-is-a-part-of-the-declarations-of-2-modules-par
## AOT + JIT
### Since Angular 5.x.x +
We cannot use AOT + JIT at once.
#### Info
https://github.com/angular/angular/issues/20156#issuecomment-341767899
On the issue, you can see:
```text
To reduce the payload, we do not ship the compiler in AOT.
```
So right now, it is not possible.
Although, there are some hacks, but you are on your own...
https://github.com/angular/angular/issues/20156#issuecomment-468686933
<!---
### Angular 4.x.x
It is not working out of the box (the default is either JIT or AOT, not both), but the apps become 10 folds faster. The ``@ngtools/webpack`` is AOT and the ```awesome-typescript-loader``` is JIT only.
The solution can be architect with the ```@angular/compiler``` and the ```awesome-typescript-loader``` together. A miracle!
Example here (since I am using Angular 5 not, it is not AOT + JIT anymore, but if you are on Angular 4, you can do it):
[More info about AOT + JIT](https://corifeus.com/github/corifeus-builder-angular/artifacts/readme/skeleton.html)
-->
### Size
If you want very small bundle, use ```gzip```.
[//]: #@corifeus-footer
---
🙏 This is an open-source project. Star this repository, if you like it, or even donate to maintain the servers and the development. Thank you so much!
Possible, this server, rarely, is down, please, hang on for 15-30 minutes and the server will be back up.
All my domains ([patrikx3.com](https://patrikx3.com) and [corifeus.com](https://corifeus.com)) could have minor errors, since I am developing in my free time. However, it is usually stable.
**Note about versioning:** Versions are cut in Major.Minor.Patch schema. Major is always the current year. Minor is either 4 (January - June) or 10 (July - December). Patch is incremental by every build. If there is a breaking change, it should be noted in the readme.
---
[**P3X-ANGULAR-COMPILE**](https://corifeus.com/angular-compile) Build v2020.10.165
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QZVM4V6HVZJW6) [](https://www.patrikx3.com/en/front/contact) [](https://www.facebook.com/corifeus.software)
## P3X Sponsor
[IntelliJ - The most intelligent Java IDE](https://www.jetbrains.com/?from=patrikx3)
[](https://www.jetbrains.com/?from=patrikx3)
[//]: #@corifeus-footer:end
