mirror of
https://github.com/angular/angular
synced 2026-05-24 09:28:37 +00:00
3ef73c2b19
Allow NgComponentOutlet to dynamically load a module, then load a component from that module. Useful for lazy loading code, then add the lazy loaded code to the page using NgComponentOutlet. Closes #14043
115 lines
4 KiB
TypeScript
115 lines
4 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google Inc. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
|
|
import {ComponentFactoryResolver, ComponentRef, Directive, Injector, Input, NgModuleFactory, NgModuleRef, OnChanges, OnDestroy, Provider, SimpleChanges, Type, ViewContainerRef} from '@angular/core';
|
|
|
|
|
|
|
|
/**
|
|
* Instantiates a single {@link Component} type and inserts its Host View into current View.
|
|
* `NgComponentOutlet` provides a declarative approach for dynamic component creation.
|
|
*
|
|
* `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:
|
|
*
|
|
* * `ngComponentOutletInjector`: Optional custom {@link Injector} that will be used as parent for
|
|
* the Component. Defaults to the injector of the current view container.
|
|
*
|
|
* * `ngComponentOutletProviders`: Optional injectable objects ({@link Provider}) that are visible
|
|
* to the component.
|
|
*
|
|
* * `ngComponentOutletContent`: Optional list of projectable nodes to insert into the content
|
|
* section of the component, if exists.
|
|
*
|
|
* * `ngComponentOutletNgModuleFactory`: Optional module factory to allow dynamically loading other
|
|
* module, then load a component from that module.
|
|
*
|
|
* ### Syntax
|
|
*
|
|
* Simple
|
|
* ```
|
|
* <ng-container *ngComponentOutlet="componentTypeExpression"></ng-container>
|
|
* ```
|
|
*
|
|
* Customized injector/content
|
|
* ```
|
|
* <ng-container *ngComponentOutlet="componentTypeExpression;
|
|
* injector: injectorExpression;
|
|
* content: contentNodesExpression;">
|
|
* </ng-container>
|
|
* ```
|
|
*
|
|
* Customized ngModuleFactory
|
|
* ```
|
|
* <ng-container *ngComponentOutlet="componentTypeExpression;
|
|
* ngModuleFactory: moduleFactory;">
|
|
* </ng-container>
|
|
* ```
|
|
* # Example
|
|
*
|
|
* {@example common/ngComponentOutlet/ts/module.ts region='SimpleExample'}
|
|
*
|
|
* A more complete example with additional options:
|
|
*
|
|
* {@example common/ngComponentOutlet/ts/module.ts region='CompleteExample'}
|
|
|
|
* A more complete example with ngModuleFactory:
|
|
*
|
|
* {@example common/ngComponentOutlet/ts/module.ts region='NgModuleFactoryExample'}
|
|
*
|
|
* @experimental
|
|
*/
|
|
@Directive({selector: '[ngComponentOutlet]'})
|
|
export class NgComponentOutlet implements OnChanges, OnDestroy {
|
|
@Input() ngComponentOutlet: Type<any>;
|
|
@Input() ngComponentOutletInjector: Injector;
|
|
@Input() ngComponentOutletContent: any[][];
|
|
@Input() ngComponentOutletNgModuleFactory: NgModuleFactory<any>;
|
|
|
|
private _componentRef: ComponentRef<any> = null;
|
|
private _moduleRef: NgModuleRef<any> = null;
|
|
|
|
constructor(private _viewContainerRef: ViewContainerRef) {}
|
|
|
|
ngOnChanges(changes: SimpleChanges) {
|
|
if (this._componentRef) {
|
|
this._viewContainerRef.remove(this._viewContainerRef.indexOf(this._componentRef.hostView));
|
|
}
|
|
this._viewContainerRef.clear();
|
|
this._componentRef = null;
|
|
|
|
if (this.ngComponentOutlet) {
|
|
let injector = this.ngComponentOutletInjector || this._viewContainerRef.parentInjector;
|
|
|
|
if ((changes as any).ngComponentOutletNgModuleFactory) {
|
|
if (this._moduleRef) this._moduleRef.destroy();
|
|
if (this.ngComponentOutletNgModuleFactory) {
|
|
this._moduleRef = this.ngComponentOutletNgModuleFactory.create(injector);
|
|
} else {
|
|
this._moduleRef = null;
|
|
}
|
|
}
|
|
if (this._moduleRef) {
|
|
injector = this._moduleRef.injector;
|
|
}
|
|
|
|
let componentFactory =
|
|
injector.get(ComponentFactoryResolver).resolveComponentFactory(this.ngComponentOutlet);
|
|
|
|
this._componentRef = this._viewContainerRef.createComponent(
|
|
componentFactory, this._viewContainerRef.length, injector, this.ngComponentOutletContent);
|
|
}
|
|
}
|
|
ngOnDestroy() {
|
|
if (this._moduleRef) this._moduleRef.destroy();
|
|
}
|
|
}
|