|
| 1 | +## API Report File for "components-srcs" |
| 2 | + |
| 3 | +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). |
| 4 | +
|
| 5 | +```ts |
| 6 | + |
| 7 | +import { AfterViewInit } from '@angular/core'; |
| 8 | +import { BasePortalOutlet } from '@angular/cdk/portal'; |
| 9 | +import { CdkPortalOutlet } from '@angular/cdk/portal'; |
| 10 | +import { ComponentFactoryResolver } from '@angular/core'; |
| 11 | +import { ComponentPortal } from '@angular/cdk/portal'; |
| 12 | +import { ComponentRef } from '@angular/core'; |
| 13 | +import { ComponentType } from '@angular/cdk/overlay'; |
| 14 | +import { Direction } from '@angular/cdk/bidi'; |
| 15 | +import { DomPortal } from '@angular/cdk/portal'; |
| 16 | +import { ElementRef } from '@angular/core'; |
| 17 | +import { EmbeddedViewRef } from '@angular/core'; |
| 18 | +import { FocusMonitor } from '@angular/cdk/a11y'; |
| 19 | +import { FocusOrigin } from '@angular/cdk/a11y'; |
| 20 | +import { FocusTrapFactory } from '@angular/cdk/a11y'; |
| 21 | +import * as i0 from '@angular/core'; |
| 22 | +import * as i2 from '@angular/cdk/overlay'; |
| 23 | +import * as i3 from '@angular/cdk/portal'; |
| 24 | +import * as i4 from '@angular/cdk/a11y'; |
| 25 | +import { InjectionToken } from '@angular/core'; |
| 26 | +import { Injector } from '@angular/core'; |
| 27 | +import { InteractivityChecker } from '@angular/cdk/a11y'; |
| 28 | +import { NgZone } from '@angular/core'; |
| 29 | +import { Observable } from 'rxjs'; |
| 30 | +import { OnDestroy } from '@angular/core'; |
| 31 | +import { Overlay } from '@angular/cdk/overlay'; |
| 32 | +import { OverlayContainer } from '@angular/cdk/overlay'; |
| 33 | +import { OverlayRef } from '@angular/cdk/overlay'; |
| 34 | +import { PositionStrategy } from '@angular/cdk/overlay'; |
| 35 | +import { ScrollStrategy } from '@angular/cdk/overlay'; |
| 36 | +import { StaticProvider } from '@angular/core'; |
| 37 | +import { Subject } from 'rxjs'; |
| 38 | +import { TemplatePortal } from '@angular/cdk/portal'; |
| 39 | +import { TemplateRef } from '@angular/core'; |
| 40 | +import { Type } from '@angular/core'; |
| 41 | +import { ViewContainerRef } from '@angular/core'; |
| 42 | + |
| 43 | +// @public |
| 44 | +export type AutoFocusTarget = 'dialog' | 'first-tabbable' | 'first-heading'; |
| 45 | + |
| 46 | +// @public |
| 47 | +export class CdkDialogContainer<C extends DialogConfig = DialogConfig> extends BasePortalOutlet implements AfterViewInit, OnDestroy { |
| 48 | + constructor(_elementRef: ElementRef, _focusTrapFactory: FocusTrapFactory, _document: any, _config: C, _interactivityChecker: InteractivityChecker, _ngZone: NgZone, _overlayRef: OverlayRef, _focusMonitor?: FocusMonitor | undefined); |
| 49 | + _ariaLabelledBy: string | null; |
| 50 | + attachComponentPortal<T>(portal: ComponentPortal<T>): ComponentRef<T>; |
| 51 | + // @deprecated |
| 52 | + attachDomPortal: (portal: DomPortal) => void; |
| 53 | + attachTemplatePortal<T>(portal: TemplatePortal<T>): EmbeddedViewRef<T>; |
| 54 | + protected _captureInitialFocus(): void; |
| 55 | + _closeInteractionType: FocusOrigin | null; |
| 56 | + // (undocumented) |
| 57 | + readonly _config: C; |
| 58 | + // (undocumented) |
| 59 | + protected _document: Document; |
| 60 | + // (undocumented) |
| 61 | + protected _elementRef: ElementRef; |
| 62 | + // (undocumented) |
| 63 | + protected _focusTrapFactory: FocusTrapFactory; |
| 64 | + // (undocumented) |
| 65 | + ngAfterViewInit(): void; |
| 66 | + // (undocumented) |
| 67 | + ngOnDestroy(): void; |
| 68 | + _portalOutlet: CdkPortalOutlet; |
| 69 | + protected _trapFocus(): void; |
| 70 | + // (undocumented) |
| 71 | + static ɵcmp: i0.ɵɵComponentDeclaration<CdkDialogContainer<any>, "cdk-dialog-container", never, {}, {}, never, never>; |
| 72 | + // (undocumented) |
| 73 | + static ɵfac: i0.ɵɵFactoryDeclaration<CdkDialogContainer<any>, [null, null, { optional: true; }, null, null, null, null, null]>; |
| 74 | +} |
| 75 | + |
| 76 | +// @public |
| 77 | +export const DEFAULT_DIALOG_CONFIG: InjectionToken<DialogConfig<unknown, unknown, BasePortalOutlet>>; |
| 78 | + |
| 79 | +// @public (undocumented) |
| 80 | +export class Dialog implements OnDestroy { |
| 81 | + constructor(_overlay: Overlay, _injector: Injector, _defaultOptions: DialogConfig, _parentDialog: Dialog, _overlayContainer: OverlayContainer, scrollStrategy: any); |
| 82 | + readonly afterAllClosed: Observable<void>; |
| 83 | + get afterOpened(): Subject<DialogRef<any, any>>; |
| 84 | + closeAll(): void; |
| 85 | + getDialogById<R, C>(id: string): DialogRef<R, C> | undefined; |
| 86 | + // (undocumented) |
| 87 | + ngOnDestroy(): void; |
| 88 | + open<R = unknown, D = unknown, C = unknown>(component: ComponentType<C>, config?: DialogConfig<D, DialogRef<R, C>>): DialogRef<R, C>; |
| 89 | + open<R = unknown, D = unknown, C = unknown>(template: TemplateRef<C>, config?: DialogConfig<D, DialogRef<R, C>>): DialogRef<R, C>; |
| 90 | + // (undocumented) |
| 91 | + open<R = unknown, D = unknown, C = unknown>(componentOrTemplateRef: ComponentType<C> | TemplateRef<C>, config?: DialogConfig<D, DialogRef<R, C>>): DialogRef<R, C>; |
| 92 | + get openDialogs(): DialogRef<any, any>[]; |
| 93 | + // (undocumented) |
| 94 | + static ɵfac: i0.ɵɵFactoryDeclaration<Dialog, [null, null, { optional: true; }, { optional: true; skipSelf: true; }, null, null]>; |
| 95 | + // (undocumented) |
| 96 | + static ɵprov: i0.ɵɵInjectableDeclaration<Dialog>; |
| 97 | +} |
| 98 | + |
| 99 | +// @public |
| 100 | +export const DIALOG_DATA: InjectionToken<any>; |
| 101 | + |
| 102 | +// @public |
| 103 | +export const DIALOG_SCROLL_STRATEGY: InjectionToken<() => ScrollStrategy>; |
| 104 | + |
| 105 | +// @public |
| 106 | +export const DIALOG_SCROLL_STRATEGY_PROVIDER: { |
| 107 | + provide: InjectionToken<() => ScrollStrategy>; |
| 108 | + deps: (typeof Overlay)[]; |
| 109 | + useFactory: typeof DIALOG_SCROLL_STRATEGY_PROVIDER_FACTORY; |
| 110 | +}; |
| 111 | + |
| 112 | +// @public |
| 113 | +export function DIALOG_SCROLL_STRATEGY_PROVIDER_FACTORY(overlay: Overlay): () => ScrollStrategy; |
| 114 | + |
| 115 | +// @public |
| 116 | +export interface DialogCloseOptions { |
| 117 | + focusOrigin?: FocusOrigin; |
| 118 | +} |
| 119 | + |
| 120 | +// @public |
| 121 | +export class DialogConfig<D = unknown, R = unknown, C extends BasePortalOutlet = BasePortalOutlet> { |
| 122 | + ariaDescribedBy?: string | null; |
| 123 | + ariaLabel?: string | null; |
| 124 | + ariaLabelledBy?: string | null; |
| 125 | + ariaModal?: boolean; |
| 126 | + autoFocus?: AutoFocusTarget | string | boolean; |
| 127 | + backdropClass?: string | string[]; |
| 128 | + closeOnNavigation?: boolean; |
| 129 | + componentFactoryResolver?: ComponentFactoryResolver; |
| 130 | + container?: Type<C> | { |
| 131 | + type: Type<C>; |
| 132 | + providers: (config: DialogConfig<D, R, C>) => StaticProvider[]; |
| 133 | + }; |
| 134 | + data?: D | null; |
| 135 | + direction?: Direction; |
| 136 | + disableClose?: boolean; |
| 137 | + hasBackdrop?: boolean; |
| 138 | + height?: string; |
| 139 | + id?: string; |
| 140 | + injector?: Injector; |
| 141 | + maxHeight?: number | string; |
| 142 | + maxWidth?: number | string; |
| 143 | + minHeight?: number | string; |
| 144 | + minWidth?: number | string; |
| 145 | + panelClass?: string | string[]; |
| 146 | + positionStrategy?: PositionStrategy; |
| 147 | + providers?: StaticProvider[] | ((dialogRef: R, config: DialogConfig<D, R, C>, container: C) => StaticProvider[]); |
| 148 | + restoreFocus?: boolean; |
| 149 | + role?: DialogRole; |
| 150 | + scrollStrategy?: ScrollStrategy; |
| 151 | + templateContext?: Record<string, any> | (() => Record<string, any>); |
| 152 | + viewContainerRef?: ViewContainerRef; |
| 153 | + width?: string; |
| 154 | +} |
| 155 | + |
| 156 | +// @public (undocumented) |
| 157 | +export class DialogModule { |
| 158 | + // (undocumented) |
| 159 | + static ɵfac: i0.ɵɵFactoryDeclaration<DialogModule, never>; |
| 160 | + // (undocumented) |
| 161 | + static ɵinj: i0.ɵɵInjectorDeclaration<DialogModule>; |
| 162 | + // (undocumented) |
| 163 | + static ɵmod: i0.ɵɵNgModuleDeclaration<DialogModule, [typeof i1.CdkDialogContainer], [typeof i2.OverlayModule, typeof i3.PortalModule, typeof i4.A11yModule], [typeof i3.PortalModule, typeof i1.CdkDialogContainer]>; |
| 164 | +} |
| 165 | + |
| 166 | +// @public |
| 167 | +export class DialogRef<R = unknown, C = unknown> { |
| 168 | + constructor(overlayRef: OverlayRef, config: DialogConfig<any, DialogRef<R, C>, BasePortalOutlet>); |
| 169 | + addPanelClass(classes: string | string[]): this; |
| 170 | + readonly backdropClick: Observable<MouseEvent>; |
| 171 | + close(result?: R, options?: DialogCloseOptions): void; |
| 172 | + readonly closed: Observable<R | undefined>; |
| 173 | + componentInstance: C | null; |
| 174 | + // (undocumented) |
| 175 | + readonly config: DialogConfig<any, DialogRef<R, C>, BasePortalOutlet>; |
| 176 | + containerInstance: BasePortalOutlet & { |
| 177 | + _closeInteractionType?: FocusOrigin; |
| 178 | + }; |
| 179 | + disableClose: boolean | undefined; |
| 180 | + readonly id: string; |
| 181 | + readonly keydownEvents: Observable<KeyboardEvent>; |
| 182 | + readonly outsidePointerEvents: Observable<MouseEvent>; |
| 183 | + // (undocumented) |
| 184 | + readonly overlayRef: OverlayRef; |
| 185 | + removePanelClass(classes: string | string[]): this; |
| 186 | + updatePosition(): this; |
| 187 | + updateSize(width?: string, height?: string): this; |
| 188 | +} |
| 189 | + |
| 190 | +// @public |
| 191 | +export type DialogRole = 'dialog' | 'alertdialog'; |
| 192 | + |
| 193 | +// @public (undocumented) |
| 194 | +export function throwDialogContentAlreadyAttachedError(): void; |
| 195 | + |
| 196 | +// (No @packageDocumentation comment for this package) |
| 197 | + |
| 198 | +``` |
0 commit comments