Help Angular by taking a 1 minute survey!Go to surveyHome
API > @angular/common

NgComponentOutlet

Instantiates a single Component type and inserts its Host View into current View. NgComponentOutlet provides a declarative approach for dynamic component creation.

See more...

NgModule

Selectors

Properties

Property Description
@Input()
ngComponentOutlet: Type<any>
@Input()
ngComponentOutletInjector: Injector
@Input()
ngComponentOutletContent: any[][]
@Input()
ngComponentOutletNgModuleFactory: NgModuleFactory<any>

Description

NgComponentOutlet requires a component type, if a falsy value is set the view will clear and any existing component will get destroyed.

Fine tune control

You can control the component creation process by using the following optional attributes:

Syntax

Simple

<ng-container *ngComponentOutlet="componentTypeExpression"></ng-container> 
      
      <ng-container *ngComponentOutlet="componentTypeExpression"></ng-container>

Customized injector/content

<ng-container *ngComponentOutlet="componentTypeExpression; injector: injectorExpression; content: contentNodesExpression;"> </ng-container> 
      
      <ng-container *ngComponentOutlet="componentTypeExpression;
                                  injector: injectorExpression;
                                  content: contentNodesExpression;">
</ng-container>

Customized ngModuleFactory

<ng-container *ngComponentOutlet="componentTypeExpression; ngModuleFactory: moduleFactory;"> </ng-container> 
      
      <ng-container *ngComponentOutlet="componentTypeExpression;
                                  ngModuleFactory: moduleFactory;">
</ng-container>

A simple example

@Component({selector: 'hello-world', template: 'Hello World!'}) export class HelloWorld { } @Component({ selector: 'ng-component-outlet-simple-example', template: `<ng-container *ngComponentOutlet="HelloWorld"></ng-container>` }) export class NgTemplateOutletSimpleExample { // This field is necessary to expose HelloWorld to the template. HelloWorld = HelloWorld; } 
      
      
  1. @Component({selector: 'hello-world', template: 'Hello World!'})
  2. export class HelloWorld {
  3. }
  4.  
  5. @Component({
  6.   selector: 'ng-component-outlet-simple-example',
  7.   template: `<ng-container *ngComponentOutlet="HelloWorld"></ng-container>`
  8. })
  9. export class NgTemplateOutletSimpleExample {
  10.   // This field is necessary to expose HelloWorld to the template.
  11.   HelloWorld = HelloWorld;
  12. }

A more complete example with additional options:

@Injectable() export class Greeter { suffix = '!'; } @Component({ selector: 'complete-component', template: `Complete: <ng-content></ng-content> <ng-content></ng-content>{{ greeter.suffix }}` }) export class CompleteComponent { constructor(public greeter: Greeter) {} } @Component({ selector: 'ng-component-outlet-complete-example', template: ` <ng-container *ngComponentOutlet="CompleteComponent; injector: myInjector; content: myContent"></ng-container>` }) export class NgTemplateOutletCompleteExample { // This field is necessary to expose CompleteComponent to the template. CompleteComponent = CompleteComponent; myInjector: Injector; myContent = [[document.createTextNode('Ahoj')], [document.createTextNode('Svet')]]; constructor(injector: Injector) { this.myInjector = Injector.create({providers: [{provide: Greeter, deps: []}], parent: injector}); } } 
      
      
  1. @Injectable()
  2. export class Greeter {
  3.   suffix = '!';
  4. }
  5.  
  6. @Component({
  7.   selector: 'complete-component',
  8.   template: `Complete: <ng-content></ng-content> <ng-content></ng-content>{{ greeter.suffix }}`
  9. })
  10. export class CompleteComponent {
  11.   constructor(public greeter: Greeter) {}
  12. }
  13.  
  14. @Component({
  15.   selector: 'ng-component-outlet-complete-example',
  16.   template: `
  17.     <ng-container *ngComponentOutlet="CompleteComponent; 
  18.                                       injector: myInjector; 
  19.                                       content: myContent"></ng-container>`
  20. })
  21. export class NgTemplateOutletCompleteExample {
  22.   // This field is necessary to expose CompleteComponent to the template.
  23.   CompleteComponent = CompleteComponent;
  24.   myInjector: Injector;
  25.  
  26.   myContent = [[document.createTextNode('Ahoj')], [document.createTextNode('Svet')]];
  27.  
  28.   constructor(injector: Injector) {
  29.     this.myInjector =
  30.         Injector.create({providers: [{provide: Greeter, deps: []}], parent: injector});
  31.   }
  32. }

A more complete example with ngModuleFactory:

@Component({selector: 'other-module-component', template: `Other Module Component!`}) export class OtherModuleComponent { } @Component({ selector: 'ng-component-outlet-other-module-example', template: ` <ng-container *ngComponentOutlet="OtherModuleComponent; ngModuleFactory: myModule;"></ng-container>` }) export class NgTemplateOutletOtherModuleExample { // This field is necessary to expose OtherModuleComponent to the template. OtherModuleComponent = OtherModuleComponent; myModule: NgModuleFactory<any>; constructor(compiler: Compiler) { this.myModule = compiler.compileModuleSync(OtherModule); } } 
      
      
  1. @Component({selector: 'other-module-component', template: `Other Module Component!`})
  2. export class OtherModuleComponent {
  3. }
  4.  
  5. @Component({
  6.   selector: 'ng-component-outlet-other-module-example',
  7.   template: `
  8.     <ng-container *ngComponentOutlet="OtherModuleComponent;
  9.                                       ngModuleFactory: myModule;"></ng-container>`
  10. })
  11. export class NgTemplateOutletOtherModuleExample {
  12.   // This field is necessary to expose OtherModuleComponent to the template.
  13.   OtherModuleComponent = OtherModuleComponent;
  14.   myModule: NgModuleFactory<any>;
  15.  
  16.   constructor(compiler: Compiler) { this.myModule = compiler.compileModuleSync(OtherModule); }
  17. }

Methods

ngOnChanges()

ngOnChanges(changes: SimpleChanges)
      
      ngOnChanges(changes: SimpleChanges)
Parameters
changes SimpleChanges

ngOnDestroy()

ngOnDestroy()
      
      ngOnDestroy()
Parameters

There are no parameters.