| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653 |
- /**
- * @license
- * Copyright Google LLC 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, Directive, EventEmitter, NgModule, Output, TemplateRef, ViewContainerRef } from '@angular/core';
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- /**
- * Throws an exception when attempting to attach a null portal to a host.
- * \@docs-private
- * @return {?}
- */
- function throwNullPortalError() {
- throw Error('Must provide a portal to attach');
- }
- /**
- * Throws an exception when attempting to attach a portal to a host that is already attached.
- * \@docs-private
- * @return {?}
- */
- function throwPortalAlreadyAttachedError() {
- throw Error('Host already has a portal attached');
- }
- /**
- * Throws an exception when attempting to attach a portal to an already-disposed host.
- * \@docs-private
- * @return {?}
- */
- function throwPortalOutletAlreadyDisposedError() {
- throw Error('This PortalOutlet has already been disposed');
- }
- /**
- * Throws an exception when attempting to attach an unknown portal type.
- * \@docs-private
- * @return {?}
- */
- function throwUnknownPortalTypeError() {
- throw Error('Attempting to attach an unknown Portal type. BasePortalOutlet accepts either ' +
- 'a ComponentPortal or a TemplatePortal.');
- }
- /**
- * Throws an exception when attempting to attach a portal to a null host.
- * \@docs-private
- * @return {?}
- */
- function throwNullPortalOutletError() {
- throw Error('Attempting to attach a portal to a null PortalOutlet');
- }
- /**
- * Throws an exception when attempting to detach a portal that is not attached.
- * \@docs-private
- * @return {?}
- */
- function throwNoPortalAttachedError() {
- throw Error('Attempting to detach a portal that is not attached to a host');
- }
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- /**
- * A `Portal` is something that you want to render somewhere else.
- * It can be attach to / detached from a `PortalOutlet`.
- * @abstract
- * @template T
- */
- class Portal {
- /**
- * Attach this portal to a host.
- * @param {?} host
- * @return {?}
- */
- attach(host) {
- if (host == null) {
- throwNullPortalOutletError();
- }
- if (host.hasAttached()) {
- throwPortalAlreadyAttachedError();
- }
- this._attachedHost = host;
- return (/** @type {?} */ (host.attach(this)));
- }
- /**
- * Detach this portal from its host
- * @return {?}
- */
- detach() {
- /** @type {?} */
- let host = this._attachedHost;
- if (host == null) {
- throwNoPortalAttachedError();
- }
- else {
- this._attachedHost = null;
- host.detach();
- }
- }
- /**
- * Whether this portal is attached to a host.
- * @return {?}
- */
- get isAttached() {
- return this._attachedHost != null;
- }
- /**
- * Sets the PortalOutlet reference without performing `attach()`. This is used directly by
- * the PortalOutlet when it is performing an `attach()` or `detach()`.
- * @param {?} host
- * @return {?}
- */
- setAttachedHost(host) {
- this._attachedHost = host;
- }
- }
- /**
- * A `ComponentPortal` is a portal that instantiates some Component upon attachment.
- * @template T
- */
- class ComponentPortal extends Portal {
- /**
- * @param {?} component
- * @param {?=} viewContainerRef
- * @param {?=} injector
- * @param {?=} componentFactoryResolver
- */
- constructor(component, viewContainerRef, injector, componentFactoryResolver) {
- super();
- this.component = component;
- this.viewContainerRef = viewContainerRef;
- this.injector = injector;
- this.componentFactoryResolver = componentFactoryResolver;
- }
- }
- /**
- * A `TemplatePortal` is a portal that represents some embedded template (TemplateRef).
- * @template C
- */
- class TemplatePortal extends Portal {
- /**
- * @param {?} template
- * @param {?} viewContainerRef
- * @param {?=} context
- */
- constructor(template, viewContainerRef, context) {
- super();
- this.templateRef = template;
- this.viewContainerRef = viewContainerRef;
- this.context = context;
- }
- /**
- * @return {?}
- */
- get origin() {
- return this.templateRef.elementRef;
- }
- /**
- * Attach the portal to the provided `PortalOutlet`.
- * When a context is provided it will override the `context` property of the `TemplatePortal`
- * instance.
- * @param {?} host
- * @param {?=} context
- * @return {?}
- */
- attach(host, context = this.context) {
- this.context = context;
- return super.attach(host);
- }
- /**
- * @return {?}
- */
- detach() {
- this.context = undefined;
- return super.detach();
- }
- }
- /**
- * Partial implementation of PortalOutlet that handles attaching
- * ComponentPortal and TemplatePortal.
- * @abstract
- */
- class BasePortalOutlet {
- constructor() {
- /**
- * Whether this host has already been permanently disposed.
- */
- this._isDisposed = false;
- }
- /**
- * Whether this host has an attached portal.
- * @return {?}
- */
- hasAttached() {
- return !!this._attachedPortal;
- }
- /**
- * Attaches a portal.
- * @param {?} portal
- * @return {?}
- */
- attach(portal) {
- if (!portal) {
- throwNullPortalError();
- }
- if (this.hasAttached()) {
- throwPortalAlreadyAttachedError();
- }
- if (this._isDisposed) {
- throwPortalOutletAlreadyDisposedError();
- }
- if (portal instanceof ComponentPortal) {
- this._attachedPortal = portal;
- return this.attachComponentPortal(portal);
- }
- else if (portal instanceof TemplatePortal) {
- this._attachedPortal = portal;
- return this.attachTemplatePortal(portal);
- }
- throwUnknownPortalTypeError();
- }
- /**
- * Detaches a previously attached portal.
- * @return {?}
- */
- detach() {
- if (this._attachedPortal) {
- this._attachedPortal.setAttachedHost(null);
- this._attachedPortal = null;
- }
- this._invokeDisposeFn();
- }
- /**
- * Permanently dispose of this portal host.
- * @return {?}
- */
- dispose() {
- if (this.hasAttached()) {
- this.detach();
- }
- this._invokeDisposeFn();
- this._isDisposed = true;
- }
- /**
- * \@docs-private
- * @param {?} fn
- * @return {?}
- */
- setDisposeFn(fn) {
- this._disposeFn = fn;
- }
- /**
- * @private
- * @return {?}
- */
- _invokeDisposeFn() {
- if (this._disposeFn) {
- this._disposeFn();
- this._disposeFn = null;
- }
- }
- }
- /**
- * @deprecated Use `BasePortalOutlet` instead.
- * \@breaking-change 9.0.0
- * @abstract
- */
- class BasePortalHost extends BasePortalOutlet {
- }
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- /**
- * A PortalOutlet for attaching portals to an arbitrary DOM element outside of the Angular
- * application context.
- */
- class DomPortalOutlet extends BasePortalOutlet {
- /**
- * @param {?} outletElement
- * @param {?} _componentFactoryResolver
- * @param {?} _appRef
- * @param {?} _defaultInjector
- */
- constructor(outletElement, _componentFactoryResolver, _appRef, _defaultInjector) {
- super();
- this.outletElement = outletElement;
- this._componentFactoryResolver = _componentFactoryResolver;
- this._appRef = _appRef;
- this._defaultInjector = _defaultInjector;
- }
- /**
- * Attach the given ComponentPortal to DOM element using the ComponentFactoryResolver.
- * @template T
- * @param {?} portal Portal to be attached
- * @return {?} Reference to the created component.
- */
- attachComponentPortal(portal) {
- /** @type {?} */
- const resolver = portal.componentFactoryResolver || this._componentFactoryResolver;
- /** @type {?} */
- const componentFactory = resolver.resolveComponentFactory(portal.component);
- /** @type {?} */
- let componentRef;
- // If the portal specifies a ViewContainerRef, we will use that as the attachment point
- // for the component (in terms of Angular's component tree, not rendering).
- // When the ViewContainerRef is missing, we use the factory to create the component directly
- // and then manually attach the view to the application.
- if (portal.viewContainerRef) {
- componentRef = portal.viewContainerRef.createComponent(componentFactory, portal.viewContainerRef.length, portal.injector || portal.viewContainerRef.injector);
- this.setDisposeFn((/**
- * @return {?}
- */
- () => componentRef.destroy()));
- }
- else {
- componentRef = componentFactory.create(portal.injector || this._defaultInjector);
- this._appRef.attachView(componentRef.hostView);
- this.setDisposeFn((/**
- * @return {?}
- */
- () => {
- this._appRef.detachView(componentRef.hostView);
- componentRef.destroy();
- }));
- }
- // At this point the component has been instantiated, so we move it to the location in the DOM
- // where we want it to be rendered.
- this.outletElement.appendChild(this._getComponentRootNode(componentRef));
- return componentRef;
- }
- /**
- * Attaches a template portal to the DOM as an embedded view.
- * @template C
- * @param {?} portal Portal to be attached.
- * @return {?} Reference to the created embedded view.
- */
- attachTemplatePortal(portal) {
- /** @type {?} */
- let viewContainer = portal.viewContainerRef;
- /** @type {?} */
- let viewRef = viewContainer.createEmbeddedView(portal.templateRef, portal.context);
- viewRef.detectChanges();
- // The method `createEmbeddedView` will add the view as a child of the viewContainer.
- // But for the DomPortalOutlet the view can be added everywhere in the DOM
- // (e.g Overlay Container) To move the view to the specified host element. We just
- // re-append the existing root nodes.
- viewRef.rootNodes.forEach((/**
- * @param {?} rootNode
- * @return {?}
- */
- rootNode => this.outletElement.appendChild(rootNode)));
- this.setDisposeFn(((/**
- * @return {?}
- */
- () => {
- /** @type {?} */
- let index = viewContainer.indexOf(viewRef);
- if (index !== -1) {
- viewContainer.remove(index);
- }
- })));
- // TODO(jelbourn): Return locals from view.
- return viewRef;
- }
- /**
- * Clears out a portal from the DOM.
- * @return {?}
- */
- dispose() {
- super.dispose();
- if (this.outletElement.parentNode != null) {
- this.outletElement.parentNode.removeChild(this.outletElement);
- }
- }
- /**
- * Gets the root HTMLElement for an instantiated component.
- * @private
- * @param {?} componentRef
- * @return {?}
- */
- _getComponentRootNode(componentRef) {
- return (/** @type {?} */ (((/** @type {?} */ (componentRef.hostView))).rootNodes[0]));
- }
- }
- /**
- * @deprecated Use `DomPortalOutlet` instead.
- * \@breaking-change 9.0.0
- */
- class DomPortalHost extends DomPortalOutlet {
- }
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- /**
- * Directive version of a `TemplatePortal`. Because the directive *is* a TemplatePortal,
- * the directive instance itself can be attached to a host, enabling declarative use of portals.
- */
- class CdkPortal extends TemplatePortal {
- /**
- * @param {?} templateRef
- * @param {?} viewContainerRef
- */
- constructor(templateRef, viewContainerRef) {
- super(templateRef, viewContainerRef);
- }
- }
- CdkPortal.decorators = [
- { type: Directive, args: [{
- selector: '[cdkPortal]',
- exportAs: 'cdkPortal',
- },] },
- ];
- /** @nocollapse */
- CdkPortal.ctorParameters = () => [
- { type: TemplateRef },
- { type: ViewContainerRef }
- ];
- /**
- * @deprecated Use `CdkPortal` instead.
- * \@breaking-change 9.0.0
- */
- class TemplatePortalDirective extends CdkPortal {
- }
- TemplatePortalDirective.decorators = [
- { type: Directive, args: [{
- selector: '[cdk-portal], [portal]',
- exportAs: 'cdkPortal',
- providers: [{
- provide: CdkPortal,
- useExisting: TemplatePortalDirective
- }]
- },] },
- ];
- /**
- * Directive version of a PortalOutlet. Because the directive *is* a PortalOutlet, portals can be
- * directly attached to it, enabling declarative use.
- *
- * Usage:
- * `<ng-template [cdkPortalOutlet]="greeting"></ng-template>`
- */
- class CdkPortalOutlet extends BasePortalOutlet {
- /**
- * @param {?} _componentFactoryResolver
- * @param {?} _viewContainerRef
- */
- constructor(_componentFactoryResolver, _viewContainerRef) {
- super();
- this._componentFactoryResolver = _componentFactoryResolver;
- this._viewContainerRef = _viewContainerRef;
- /**
- * Whether the portal component is initialized.
- */
- this._isInitialized = false;
- /**
- * Emits when a portal is attached to the outlet.
- */
- this.attached = new EventEmitter();
- }
- /**
- * Portal associated with the Portal outlet.
- * @return {?}
- */
- get portal() {
- return this._attachedPortal;
- }
- /**
- * @param {?} portal
- * @return {?}
- */
- set portal(portal) {
- // Ignore the cases where the `portal` is set to a falsy value before the lifecycle hooks have
- // run. This handles the cases where the user might do something like `<div cdkPortalOutlet>`
- // and attach a portal programmatically in the parent component. When Angular does the first CD
- // round, it will fire the setter with empty string, causing the user's content to be cleared.
- if (this.hasAttached() && !portal && !this._isInitialized) {
- return;
- }
- if (this.hasAttached()) {
- super.detach();
- }
- if (portal) {
- super.attach(portal);
- }
- this._attachedPortal = portal;
- }
- /**
- * Component or view reference that is attached to the portal.
- * @return {?}
- */
- get attachedRef() {
- return this._attachedRef;
- }
- /**
- * @return {?}
- */
- ngOnInit() {
- this._isInitialized = true;
- }
- /**
- * @return {?}
- */
- ngOnDestroy() {
- super.dispose();
- this._attachedPortal = null;
- this._attachedRef = null;
- }
- /**
- * Attach the given ComponentPortal to this PortalOutlet using the ComponentFactoryResolver.
- *
- * @template T
- * @param {?} portal Portal to be attached to the portal outlet.
- * @return {?} Reference to the created component.
- */
- attachComponentPortal(portal) {
- portal.setAttachedHost(this);
- // If the portal specifies an origin, use that as the logical location of the component
- // in the application tree. Otherwise use the location of this PortalOutlet.
- /** @type {?} */
- const viewContainerRef = portal.viewContainerRef != null ?
- portal.viewContainerRef :
- this._viewContainerRef;
- /** @type {?} */
- const resolver = portal.componentFactoryResolver || this._componentFactoryResolver;
- /** @type {?} */
- const componentFactory = resolver.resolveComponentFactory(portal.component);
- /** @type {?} */
- const ref = viewContainerRef.createComponent(componentFactory, viewContainerRef.length, portal.injector || viewContainerRef.injector);
- super.setDisposeFn((/**
- * @return {?}
- */
- () => ref.destroy()));
- this._attachedPortal = portal;
- this._attachedRef = ref;
- this.attached.emit(ref);
- return ref;
- }
- /**
- * Attach the given TemplatePortal to this PortlHost as an embedded View.
- * @template C
- * @param {?} portal Portal to be attached.
- * @return {?} Reference to the created embedded view.
- */
- attachTemplatePortal(portal) {
- portal.setAttachedHost(this);
- /** @type {?} */
- const viewRef = this._viewContainerRef.createEmbeddedView(portal.templateRef, portal.context);
- super.setDisposeFn((/**
- * @return {?}
- */
- () => this._viewContainerRef.clear()));
- this._attachedPortal = portal;
- this._attachedRef = viewRef;
- this.attached.emit(viewRef);
- return viewRef;
- }
- }
- CdkPortalOutlet.decorators = [
- { type: Directive, args: [{
- selector: '[cdkPortalOutlet]',
- exportAs: 'cdkPortalOutlet',
- inputs: ['portal: cdkPortalOutlet']
- },] },
- ];
- /** @nocollapse */
- CdkPortalOutlet.ctorParameters = () => [
- { type: ComponentFactoryResolver },
- { type: ViewContainerRef }
- ];
- CdkPortalOutlet.propDecorators = {
- attached: [{ type: Output }]
- };
- /**
- * @deprecated Use `CdkPortalOutlet` instead.
- * \@breaking-change 9.0.0
- */
- class PortalHostDirective extends CdkPortalOutlet {
- }
- PortalHostDirective.decorators = [
- { type: Directive, args: [{
- selector: '[cdkPortalHost], [portalHost]',
- exportAs: 'cdkPortalHost',
- inputs: ['portal: cdkPortalHost'],
- providers: [{
- provide: CdkPortalOutlet,
- useExisting: PortalHostDirective
- }]
- },] },
- ];
- class PortalModule {
- }
- PortalModule.decorators = [
- { type: NgModule, args: [{
- exports: [CdkPortal, CdkPortalOutlet, TemplatePortalDirective, PortalHostDirective],
- declarations: [CdkPortal, CdkPortalOutlet, TemplatePortalDirective, PortalHostDirective],
- },] },
- ];
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- /**
- * Custom injector to be used when providing custom
- * injection tokens to components inside a portal.
- * \@docs-private
- */
- class PortalInjector {
- /**
- * @param {?} _parentInjector
- * @param {?} _customTokens
- */
- constructor(_parentInjector, _customTokens) {
- this._parentInjector = _parentInjector;
- this._customTokens = _customTokens;
- }
- /**
- * @param {?} token
- * @param {?=} notFoundValue
- * @return {?}
- */
- get(token, notFoundValue) {
- /** @type {?} */
- const value = this._customTokens.get(token);
- if (typeof value !== 'undefined') {
- return value;
- }
- return this._parentInjector.get(token, notFoundValue);
- }
- }
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- export { Portal, ComponentPortal, TemplatePortal, BasePortalOutlet, BasePortalHost, DomPortalOutlet, DomPortalHost, CdkPortal, TemplatePortalDirective, CdkPortalOutlet, PortalHostDirective, PortalModule, PortalInjector };
- //# sourceMappingURL=portal.js.map
|