Odpowiednik $ compile w Angular 2

136

Chcę ręcznie skompilować niektóre dyrektywy zawierające HTML. Jaki jest odpowiednik $compilew Angular 2?

Na przykład w Angular 1 mogłem dynamicznie skompilować fragment HTML i dołączyć go do DOM:

var e = angular.element('<div directive></div>');
element.append(e);
$compile(e)($scope);
bity pikseli
źródło
8
Większość tych odpowiedzi (z wyjątkiem jednej, która jest teraz przestarzała) NIE jest odpowiednikiem angular 1 $ compile. $ compile pobiera ciąg znaków HTML i kompiluje zawarte w nim komponenty i wyrażenia. Te odpowiedzi po prostu tworzą wstępnie zdefiniowane komponenty (które nie zostały jeszcze utworzone) dynamicznie i NIE MOGĄ pobrać argumentu w postaci łańcucha. To nie jest to samo. Czy ktoś zna prawdziwą odpowiedź na to pytanie?
danday74
Angular 4 wymyślił ComponentFactoryResolver, który jest odpowiednikiem $ compile w Angular 1.0. Zobacz moją odpowiedź stackoverflow.com/questions/34784778/ ...
Code-EZ
1
@ danday74 - Zgadzam się, że żadna z tych odpowiedzi nie zapewnia możliwości kompilowania dowolnych szablonów HTML, zamiast tego po prostu wybierają z zestawu wcześniej istniejących komponentów. Znalazłem tutaj prawdziwą odpowiedź, która działa przynajmniej w Angular 8: stackoverflow.com/questions/61137899/… . Zobacz jedną odpowiedź, która zawiera działający StackBlitz, który kompiluje dowolny szablon HTML generowany w czasie wykonywania.
EbenH

Odpowiedzi:

133

Angular 2.3.0 (07.12.2016)

Aby poznać szczegóły, sprawdź:

Aby zobaczyć to w akcji:

Dyrektorzy:

1) Utwórz szablon
2) Utwórz komponent
3) Utwórz moduł
4) Skompiluj moduł
5) Utwórz (i zapisz w pamięci podręcznej) ComponentFactory
6) użyj Target, aby utworzyć jego instancję

Krótkie omówienie sposobu tworzenia komponentu

createNewComponent (tmpl:string) {
  @Component({
      selector: 'dynamic-component',
      template: tmpl,
  })
  class CustomDynamicComponent  implements IHaveDynamicData {
      @Input()  public entity: any;
  };
  // a component for this particular template
  return CustomDynamicComponent;
}

Sposób na wprowadzenie komponentu do NgModule

createComponentModule (componentType: any) {
  @NgModule({
    imports: [
      PartsModule, // there are 'text-editor', 'string-editor'...
    ],
    declarations: [
      componentType
    ],
  })
  class RuntimeComponentModule
  {
  }
  // a module for just this Type
  return RuntimeComponentModule;
}

Fragment kodu, jak utworzyć ComponentFactory (i zapisać w pamięci podręcznej)

public createComponentFactory(template: string)
    : Promise<ComponentFactory<IHaveDynamicData>> {    
    let factory = this._cacheOfFactories[template];

    if (factory) {
        console.log("Module and Type are returned from cache")

        return new Promise((resolve) => {
            resolve(factory);
        });
    }

    // unknown template ... let's create a Type for it
    let type   = this.createNewComponent(template);
    let module = this.createComponentModule(type);

    return new Promise((resolve) => {
        this.compiler
            .compileModuleAndAllComponentsAsync(module)
            .then((moduleWithFactories) =>
            {
                factory = _.find(moduleWithFactories.componentFactories
                                , { componentType: type });

                this._cacheOfFactories[template] = factory;

                resolve(factory);
            });
    });
}

Fragment kodu, jak korzystać z powyższego wyniku

  // here we get Factory (just compiled or from cache)
  this.typeBuilder
      .createComponentFactory(template)
      .then((factory: ComponentFactory<IHaveDynamicData>) =>
    {
        // Target will instantiate and inject component (we'll keep reference to it)
        this.componentRef = this
            .dynamicComponentTarget
            .createComponent(factory);

        // let's inject @Inputs to component instance
        let component = this.componentRef.instance;

        component.entity = this.entity;
        //...
    });

Pełny opis ze wszystkimi szczegółami przeczytaj tutaj lub zobacz przykład roboczy

.

.

PRZESTARZAŁE - związane z Angular 2.0 RC5 (tylko RC5)

aby zobaczyć poprzednie rozwiązania dla poprzednich wersji RC, przeszukaj historię tego postu

Radim Köhler
źródło
2
Wielkie dzięki, szukałem działającego przykładu ComponentFactoryi ViewContainerRefzastąpienia przestarzałego DynamicComponentLoader.
Andre Loker
1
@maxou To jest odwołanie do lo-dash w index.html, po prostu dodaj to odniesienie i wszystko będzie działać
Radim Köhler
64
Czy to naprawdę takie trudne? Kiedyś mogłem po prostu zrobić coś takiego: $compile($element.contents())($scope.$new());a teraz są to setki linii kodu, wraz z tworzeniem NgModule ... To jest rodzaj rzeczy, która sprawia, że ​​chcę omijać NG2 i przejść do czegoś lepszego.
Karvapallo
2
Jaka jest zaleta używania, JitCompilerjeśli Twój przykład może działać z Compilerfrom @angular/core? plnkr.co/edit/UxgkiT?p=preview
yurzui
4
O mój Boże, ile wierszy kodu powinienem napisać tylko po to, aby skompilować mały element. Nie rozumiałem dobrze
Mr_Perfect
35

Uwaga: jak @BennyBottema wspomina w komentarzu, DynamicComponentLoader jest teraz przestarzały, stąd też ta odpowiedź.


Angular2 nie ma żadnego odpowiednika $ compile . Możesz używać DynamicComoponentLoaderi hakować z klasami ES6, aby dynamicznie kompilować swój kod (zobacz ten fragment ):

import {Component, DynamicComponentLoader, ElementRef, OnInit} from 'angular2/core'

function compileToComponent(template, directives) {
  @Component({ 
    selector: 'fake', 
    template , directives
  })
  class FakeComponent {};
  return FakeComponent;
}

@Component({
  selector: 'hello',
  template: '<h1>Hello, Angular!</h1>'
})
class Hello {}

@Component({
  selector: 'my-app',
  template: '<div #container></div>',
})
export class App implements OnInit {
  constructor(
    private loader: DynamicComponentLoader, 
    private elementRef: ElementRef,
  ) {}

  ngOnInit() {} {
    const someDynamicHtml = `<hello></hello><h2>${Date.now()}</h2>`;

    this.loader.loadIntoLocation(
      compileToComponent(someDynamicHtml, [Hello])
      this.elementRef,
      'container'
    );
  }
}

Ale będzie działać tylko do momentu, gdy parser html znajdzie się w rdzeniu angular2.

alexpods
źródło
Niesamowita sztuczka! ale w przypadku, gdy mój komponent dynamiczny ma pewne dane wejściowe, czy można również powiązać dane dynamiczne?
Eugene Gluhotorenko
2
odpowiadając na moje własne pytanie: jest to możliwe poprzez przekazanie danych do funkcji kompilującej. tutaj plunk plnkr.co/edit/dK6l7jiWt535jOw1Htct?p=preview
Eugene Gluhotorenko
To rozwiązanie działa tylko z wersją beta-0. Od wersji beta 1 do 15 przykładowy kod zwraca błąd. Błąd: nie ma dyrektywy komponentu w elemencie [obiekt obiektu]
Nicolas Forney
13
Odkąd rc1 DynamicComponentLoader stał się przestarzały
Benny Bottema
1
@BennyBottema, ponieważ DynamicComponentLoaderjest przestarzały, jak zrobimy to samo w Angular 2? Powiedzmy, że mam modalne okno dialogowe i chcę dynamicznie załadować nowy komponent w jego zawartości
Luke T O'Brien
16

Wersja kątowa, której używałem - Angular 4.2.0

Angular 4 został wymyślony z ComponentFactoryResolver do ładowania komponentów w czasie wykonywania. Jest to taka sama implementacja $ compile w Angular 1.0, która spełnia twoje potrzeby

W poniższym przykładzie ładuję komponent ImageWidget dynamicznie do DashboardTileComponent

Aby załadować komponent, potrzebujesz dyrektywy, którą możesz zastosować do ng-template, która pomoże umieścić komponent dynamiczny

WidgetHostDirective

 import { Directive, ViewContainerRef } from '@angular/core';

    @Directive({
      selector: '[widget-host]',
    })
    export class DashboardTileWidgetHostDirective {
      constructor(public viewContainerRef: ViewContainerRef) { 


      }
    }

ta dyrektywa wstrzykuje ViewContainerRef, aby uzyskać dostęp do kontenera widoku elementu, który będzie hostował dynamicznie dodawany składnik.

DashboardTileComponent (komponent zastępczy do renderowania komponentu dynamicznego)

Ten komponent akceptuje dane wejściowe pochodzące z komponentów nadrzędnych lub można je załadować z usługi na podstawie implementacji. Ten komponent pełni główną rolę w rozwiązywaniu komponentów w czasie wykonywania. W tej metodzie można również zobaczyć metodę o nazwie renderComponent (), która ostatecznie ładuje nazwę komponentu z usługi i rozwiązuje ją za pomocą ComponentFactoryResolver i ostatecznie ustawia dane na komponent dynamiczny.

import { Component, Input, OnInit, AfterViewInit, ViewChild, ComponentFactoryResolver, OnDestroy } from '@angular/core';
import { DashboardTileWidgetHostDirective } from './DashbardWidgetHost.Directive';
import { TileModel } from './Tile.Model';
import { WidgetComponentService } from "./WidgetComponent.Service";


@Component({
    selector: 'dashboard-tile',
    templateUrl: 'app/tile/DashboardTile.Template.html'
})

export class DashboardTileComponent implements OnInit {
    @Input() tile: any;
    @ViewChild(DashboardTileWidgetHostDirective) widgetHost: DashboardTileWidgetHostDirective;
    constructor(private _componentFactoryResolver: ComponentFactoryResolver,private widgetComponentService:WidgetComponentService) {

    }

    ngOnInit() {

    }
    ngAfterViewInit() {
        this.renderComponents();
    }
    renderComponents() {
        let component=this.widgetComponentService.getComponent(this.tile.componentName);
        let componentFactory = this._componentFactoryResolver.resolveComponentFactory(component);
        let viewContainerRef = this.widgetHost.viewContainerRef;
        let componentRef = viewContainerRef.createComponent(componentFactory);
        (<TileModel>componentRef.instance).data = this.tile;

    }
}

DashboardTileComponent.html

 <div class="col-md-2 col-lg-2 col-sm-2 col-default-margin col-default">        
                        <ng-template widget-host></ng-template>

          </div>

WidgetComponentService

Jest to fabryka usług, która rejestruje wszystkie komponenty, które chcesz rozwiązywać dynamicznie

import { Injectable }           from '@angular/core';
import { ImageTextWidgetComponent } from "../templates/ImageTextWidget.Component";
@Injectable()
export class WidgetComponentService {
  getComponent(componentName:string) {
          if(componentName==="ImageTextWidgetComponent"){
              return ImageTextWidgetComponent
          }
  }
}

ImageTextWidgetComponent (komponent, który ładujemy w czasie wykonywania)

import { Component, OnInit, Input } from '@angular/core';


@Component({
    selector: 'dashboard-imagetextwidget',
    templateUrl: 'app/templates/ImageTextWidget.html'
})

export class ImageTextWidgetComponent implements OnInit {
     @Input() data: any;
    constructor() { }

    ngOnInit() { }
}

Dodaj Na koniec dodaj ten ImageTextWidgetComponent do modułu aplikacji jako entryComponent

@NgModule({
    imports: [BrowserModule],
    providers: [WidgetComponentService],
    declarations: [
        MainApplicationComponent,
        DashboardHostComponent,
        DashboardGroupComponent,
        DashboardTileComponent,
        DashboardTileWidgetHostDirective,
        ImageTextWidgetComponent
        ],
    exports: [],
    entryComponents: [ImageTextWidgetComponent],
    bootstrap: [MainApplicationComponent]
})
export class DashboardModule {
    constructor() {

    }
}

TileModel

 export interface TileModel {
      data: any;
    }

Oryginalne odniesienie z mojego bloga

Oficjalna dokumentacja

Pobierz przykładowy kod źródłowy

Code-EZ
źródło
1
Zapomniałeś o tym wspomnieć entryComponents. Bez tego twoje rozwiązanie nie zadziała
yurzui
ComponentFactoryResolver był w angular2. I myślę, że nie jest to odpowiednik $ compile
yurzui,
@yurzui. Ale służy to potrzebie $ kompilacji, prawda?
Code-EZ
@yurzui I został użyty ten sam rodzaj implementacji, używając $ compile. Kiedy usuniemy komponenty wejściowe z modułu, zgłosi błąd ImageTextWidgetComponent nie jest załadowany. Ale aplikacja nadal działa
Code-EZ
1
@BecarioSenior jeśli nie jesteś rzutowany na żadną klasę modelu, będzie to domyślna dynamiczna. W tym przykładzie typ danych właściwości jest dowolny, co oznacza, że ​​można przekazać dowolne dane do komponentu dynamicznego jako dane wejściowe. Zapewnia większą czytelność kodu.
Code-EZ
9

ten pakiet npm ułatwił mi to: https://www.npmjs.com/package/ngx-dynamic-template

stosowanie:

<ng-template dynamic-template
             [template]="'some value:{{param1}}, and some component <lazy-component></lazy-component>'"
             [context]="{param1:'value1'}"
             [extraModules]="[someDynamicModule]"></ng-template>
aelbatal
źródło
3

Aby dynamicznie stworzyć instancję komponentu i dołączyć ją do swojego DOM możesz użyć poniższego skryptu i powinien działać w Angular RC :

szablon html:

<div>
  <div id="container"></div>
  <button (click)="viewMeteo()">Meteo</button>
  <button (click)="viewStats()">Stats</button>
</div>

Komponent ładujący

import { Component, DynamicComponentLoader, ElementRef, Injector } from '@angular/core';
import { WidgetMeteoComponent } from './widget-meteo';
import { WidgetStatComponent } from './widget-stat';

@Component({
  moduleId: module.id,
  selector: 'widget-loader',
  templateUrl: 'widget-loader.html',
})
export class WidgetLoaderComponent  {

  constructor( elementRef: ElementRef,
               public dcl:DynamicComponentLoader,
               public injector: Injector) { }

  viewMeteo() {
    this.dcl.loadAsRoot(WidgetMeteoComponent, '#container', this.injector);
  }

  viewStats() {
    this.dcl.loadAsRoot(WidgetStatComponent, '#container', this.injector);
  }

}
fabio_biondi
źródło
1
DynamicComponentLoader już nie istnieje: '(Po tym, jak został wycofany, istniał ComponentResolver. A teraz jest ComponentFactoryResolver ( blog.rangle.io/dynamically-creating-components-with-angular-2 )
MB
3

Angular TypeScript / ES6 (Angular 2+)

Współpracuje z AOT + JIT jednocześnie.

Jak go używać stworzyłem tutaj: https://github.com/patrikx3/angular-compile

npm install p3x-angular-compile

Komponent: Powinien mieć kontekst i pewne dane HTML ...

HTML:

<div [p3x-compile]="data" [p3x-compile-context]="ctx">loading ...</div>
Patrik Laszlo
źródło
1
Nie jest oczywiste, co oznacza tytuł „Angular TypeScript”. Czy rozwiązanie jest bezużyteczne dla ES5 i ES6? Przydałoby się podanie przykładu programowego wykorzystania tego pakietu, będącego bezpośrednim odpowiednikiem $compile(...)($scope). Nie ma na nim nic, nawet w repozytorium readme.
Estus Flask
0

Wiem, że ten problem jest stary, ale spędziłem tygodnie, próbując wymyślić, jak to działa z włączonym AOT. Udało mi się skompilować obiekt, ale nigdy nie byłem w stanie wykonać istniejących komponentów. W końcu zdecydowałem się zmienić taktykę, ponieważ nie szukałem kompilacji kodu, a raczej wykonania niestandardowego szablonu. Pomyślałem o dodaniu kodu HTML, który każdy może zrobić, i pętli po istniejących fabrykach. Robiąc to, mogę wyszukać element / atrybut / itp. nazwy i wykonać komponent na tym HTMLElement. Udało mi się to uruchomić i pomyślałem, że powinienem się tym podzielić, aby zaoszczędzić komuś ogromną ilość czasu, który na to zmarnowałem.

@Component({
    selector: "compile",
    template: "",
    inputs: ["html"]
})
export class CompileHtmlComponent implements OnDestroy {
    constructor(
        private content: ViewContainerRef,
        private injector: Injector,
        private ngModRef: NgModuleRef<any>
    ) { }

    ngOnDestroy() {
        this.DestroyComponents();
    }

    private _ComponentRefCollection: any[] = null;
    private _Html: string;

    get Html(): string {
        return this._Html;
    }
    @Input("html") set Html(val: string) {
        // recompile when the html value is set
        this._Html = (val || "") + "";
        this.TemplateHTMLCompile(this._Html);
    }

    private DestroyComponents() { // we need to remove the components we compiled
        if (this._ComponentRefCollection) {
            this._ComponentRefCollection.forEach((c) => {
                c.destroy();
            });
        }
        this._ComponentRefCollection = new Array();
    }

    private TemplateHTMLCompile(html) {
        this.DestroyComponents();
        this.content.element.nativeElement.innerHTML = html;
        var ref = this.content.element.nativeElement;
        var factories = (this.ngModRef.componentFactoryResolver as any)._factories;
        // here we loop though the factories, find the element based on the selector
        factories.forEach((comp: ComponentFactory<unknown>) => {
            var list = ref.querySelectorAll(comp.selector);
            list.forEach((item) => {
                var parent = item.parentNode;
                var next = item.nextSibling;
                var ngContentNodes: any[][] = new Array(); // this is for the viewchild/viewchildren of this object

                comp.ngContentSelectors.forEach((sel) => {
                    var ngContentList: any[] = new Array();

                    if (sel == "*") // all children;
                    {
                        item.childNodes.forEach((c) => {
                            ngContentList.push(c);
                        });
                    }
                    else {
                        var selList = item.querySelectorAll(sel);

                        selList.forEach((l) => {
                            ngContentList.push(l);
                        });
                    }

                    ngContentNodes.push(ngContentList);
                });
                // here is where we compile the factory based on the node we have
                let component = comp.create(this.injector, ngContentNodes, item, this.ngModRef);

                this._ComponentRefCollection.push(component); // save for our destroy call
                // we need to move the newly compiled element, as it was appended to this components html
                if (next) parent.insertBefore(component.location.nativeElement, next);
                else parent.appendChild(component.location.nativeElement);

                component.hostView.detectChanges(); // tell the component to detectchanges
            });
        });
    }
}
Vince
źródło
-6

Jeśli chcesz wstrzyknąć dyrektywę html code use

<div [innerHtml]="htmlVar"></div>

Jeśli chcesz wczytać cały komponent w jakimś miejscu, użyj DynamicComponentLoader:

https://angular.io/docs/ts/latest/api/core/DynamicComponentLoader-class.html

Vlado Tesanovic
źródło
2
Chcę wstrzyknąć fragment kodu HTML jako ciąg i przekazać go do kompilatora składników, a następnie dołączyć ten składnik do mojego DOM. Czy możesz podać przykład, jak może działać każde z Twoich rozwiązań?
pixelbits
3
using innerHtml nie kompiluje żadnych komponentów wewnątrz htmlVar
Juanín