@angular/cdk 19.2.1 → 19.2.3

package/dialog/index.d.ts

@@ -1,43 +1,145 @@
-import { BasePortalOutlet } from '@angular/cdk/portal';
-import { CdkPortalOutlet } from '@angular/cdk/portal';
-import { ChangeDetectorRef } from '@angular/core';
-import { ComponentPortal } from '@angular/cdk/portal';
-import { ComponentRef } from '@angular/core';
-import { ComponentType } from '@angular/cdk/overlay';
-import { Direction } from '@angular/cdk/bidi';
-import { DomPortal } from '@angular/cdk/portal';
-import { ElementRef } from '@angular/core';
-import { EmbeddedViewRef } from '@angular/core';
-import { FocusOrigin } from '@angular/cdk/a11y';
-import { FocusTrapFactory } from '@angular/cdk/a11y';
+import * as i3 from '@angular/cdk/a11y';
+import { FocusTrapFactory, FocusOrigin } from '@angular/cdk/a11y';
+import * as i2 from '@angular/cdk/portal';
+import { BasePortalOutlet, CdkPortalOutlet, ComponentPortal, TemplatePortal, DomPortal } from '@angular/cdk/portal';
 import * as i0 from '@angular/core';
+import { ViewContainerRef, Injector, StaticProvider, Type, OnDestroy, ElementRef, NgZone, ChangeDetectorRef, ComponentRef, EmbeddedViewRef, TemplateRef, InjectionToken } from '@angular/core';
+import { Direction } from '@angular/cdk/bidi';
 import * as i1 from '@angular/cdk/overlay';
-import * as i2 from '@angular/cdk/portal';
-import * as i3 from '@angular/cdk/a11y';
-import { InjectionToken } from '@angular/core';
-import { Injector } from '@angular/core';
-import { NgZone } from '@angular/core';
-import { Observable } from 'rxjs';
-import { OnDestroy } from '@angular/core';
-import { Overlay } from '@angular/cdk/overlay';
-import { OverlayRef } from '@angular/cdk/overlay';
-import { PositionStrategy } from '@angular/cdk/overlay';
-import { ScrollStrategy } from '@angular/cdk/overlay';
-import { StaticProvider } from '@angular/core';
-import { Subject } from 'rxjs';
-import { TemplatePortal } from '@angular/cdk/portal';
-import { TemplateRef } from '@angular/core';
-import { Type } from '@angular/core';
-import { ViewContainerRef } from '@angular/core';
+import { PositionStrategy, ScrollStrategy, OverlayRef, ComponentType, Overlay } from '@angular/cdk/overlay';
+import { Observable, Subject } from 'rxjs';
 
 /** Options for where to set focus to automatically on dialog open */
-export declare type AutoFocusTarget = 'dialog' | 'first-tabbable' | 'first-heading';
+type AutoFocusTarget = 'dialog' | 'first-tabbable' | 'first-heading';
+/** Valid ARIA roles for a dialog. */
+type DialogRole = 'dialog' | 'alertdialog';
+/** Configuration for opening a modal dialog. */
+declare class DialogConfig<D = unknown, R = unknown, C extends BasePortalOutlet = BasePortalOutlet> {
+    /**
+     * Where the attached component should live in Angular's *logical* component tree.
+     * This affects what is available for injection and the change detection order for the
+     * component instantiated inside of the dialog. This does not affect where the dialog
+     * content will be rendered.
+     */
+    viewContainerRef?: ViewContainerRef;
+    /**
+     * Injector used for the instantiation of the component to be attached. If provided,
+     * takes precedence over the injector indirectly provided by `ViewContainerRef`.
+     */
+    injector?: Injector;
+    /** ID for the dialog. If omitted, a unique one will be generated. */
+    id?: string;
+    /** The ARIA role of the dialog element. */
+    role?: DialogRole;
+    /** Optional CSS class or classes applied to the overlay panel. */
+    panelClass?: string | string[];
+    /** Whether the dialog has a backdrop. */
+    hasBackdrop?: boolean;
+    /** Optional CSS class or classes applied to the overlay backdrop. */
+    backdropClass?: string | string[];
+    /** Whether the dialog closes with the escape key or pointer events outside the panel element. */
+    disableClose?: boolean;
+    /** Width of the dialog. */
+    width?: string;
+    /** Height of the dialog. */
+    height?: string;
+    /** Min-width of the dialog. If a number is provided, assumes pixel units. */
+    minWidth?: number | string;
+    /** Min-height of the dialog. If a number is provided, assumes pixel units. */
+    minHeight?: number | string;
+    /** Max-width of the dialog. If a number is provided, assumes pixel units. Defaults to 80vw. */
+    maxWidth?: number | string;
+    /** Max-height of the dialog. If a number is provided, assumes pixel units. */
+    maxHeight?: number | string;
+    /** Strategy to use when positioning the dialog. Defaults to centering it on the page. */
+    positionStrategy?: PositionStrategy;
+    /** Data being injected into the child component. */
+    data?: D | null;
+    /** Layout direction for the dialog's content. */
+    direction?: Direction;
+    /** ID of the element that describes the dialog. */
+    ariaDescribedBy?: string | null;
+    /** ID of the element that labels the dialog. */
+    ariaLabelledBy?: string | null;
+    /** Dialog label applied via `aria-label` */
+    ariaLabel?: string | null;
+    /**
+     * Whether this is a modal dialog. Used to set the `aria-modal` attribute. Off by default,
+     * because it can interfere with other overlay-based components (e.g. `mat-select`) and because
+     * it is redundant since the dialog marks all outside content as `aria-hidden` anyway.
+     */
+    ariaModal?: boolean;
+    /**
+     * Where the dialog should focus on open.
+     * @breaking-change 14.0.0 Remove boolean option from autoFocus. Use string or
+     * AutoFocusTarget instead.
+     */
+    autoFocus?: AutoFocusTarget | string | boolean;
+    /**
+     * Whether the dialog should restore focus to the previously-focused element upon closing.
+     * Has the following behavior based on the type that is passed in:
+     * - `boolean` - when true, will return focus to the element that was focused before the dialog
+     *    was opened, otherwise won't restore focus at all.
+     * - `string` - focus will be restored to the first element that matches the CSS selector.
+     * - `HTMLElement` - focus will be restored to the specific element.
+     */
+    restoreFocus?: boolean | string | HTMLElement;
+    /**
+     * Scroll strategy to be used for the dialog. This determines how
+     * the dialog responds to scrolling underneath the panel element.
+     */
+    scrollStrategy?: ScrollStrategy;
+    /**
+     * Whether the dialog should close when the user navigates backwards or forwards through browser
+     * history. This does not apply to navigation via anchor element unless using URL-hash based
+     * routing (`HashLocationStrategy` in the Angular router).
+     */
+    closeOnNavigation?: boolean;
+    /**
+     * Whether the dialog should close when the dialog service is destroyed. This is useful if
+     * another service is wrapping the dialog and is managing the destruction instead.
+     */
+    closeOnDestroy?: boolean;
+    /**
+     * Whether the dialog should close when the underlying overlay is detached. This is useful if
+     * another service is wrapping the dialog and is managing the destruction instead. E.g. an
+     * external detachment can happen as a result of a scroll strategy triggering it or when the
+     * browser location changes.
+     */
+    closeOnOverlayDetachments?: boolean;
+    /**
+     * Alternate `ComponentFactoryResolver` to use when resolving the associated component.
+     * @deprecated No longer used. Will be removed.
+     * @breaking-change 20.0.0
+     */
+    componentFactoryResolver?: unknown;
+    /**
+     * Providers that will be exposed to the contents of the dialog. Can also
+     * be provided as a function in order to generate the providers lazily.
+     */
+    providers?: StaticProvider[] | ((dialogRef: R, config: DialogConfig<D, R, C>, container: C) => StaticProvider[]);
+    /**
+     * Component into which the dialog content will be rendered. Defaults to `CdkDialogContainer`.
+     * A configuration object can be passed in to customize the providers that will be exposed
+     * to the dialog container.
+     */
+    container?: Type<C> | {
+        type: Type<C>;
+        providers: (config: DialogConfig<D, R, C>) => StaticProvider[];
+    };
+    /**
+     * Context that will be passed to template-based dialogs.
+     * A function can be passed in to resolve the context lazily.
+     */
+    templateContext?: Record<string, any> | (() => Record<string, any>);
+}
 
+declare function throwDialogContentAlreadyAttachedError(): void;
 /**
  * Internal component that wraps user-provided dialog content.
  * @docs-private
  */
-export declare class CdkDialogContainer<C extends DialogConfig = DialogConfig> extends BasePortalOutlet implements OnDestroy {
+declare class CdkDialogContainer<C extends DialogConfig = DialogConfig> extends BasePortalOutlet implements OnDestroy {
     protected _elementRef: ElementRef<any>;
     protected _focusTrapFactory: FocusTrapFactory;
     readonly _config: C;
@@ -129,10 +231,67 @@ export declare class CdkDialogContainer<C extends DialogConfig = DialogConfig> e
     static ɵcmp: i0.ɵɵComponentDeclaration<CdkDialogContainer<any>, "cdk-dialog-container", never, {}, {}, never, never, true, never>;
 }
 
-/** Injection token that can be used to provide default options for the dialog module. */
-export declare const DEFAULT_DIALOG_CONFIG: InjectionToken<DialogConfig<unknown, unknown, BasePortalOutlet>>;
+/** Additional options that can be passed in when closing a dialog. */
+interface DialogCloseOptions {
+    /** Focus original to use when restoring focus. */
+    focusOrigin?: FocusOrigin;
+}
+/**
+ * Reference to a dialog opened via the Dialog service.
+ */
+declare class DialogRef<R = unknown, C = unknown> {
+    readonly overlayRef: OverlayRef;
+    readonly config: DialogConfig<any, DialogRef<R, C>, BasePortalOutlet>;
+    /**
+     * Instance of component opened into the dialog. Will be
+     * null when the dialog is opened using a `TemplateRef`.
+     */
+    readonly componentInstance: C | null;
+    /**
+     * `ComponentRef` of the component opened into the dialog. Will be
+     * null when the dialog is opened using a `TemplateRef`.
+     */
+    readonly componentRef: ComponentRef<C> | null;
+    /** Instance of the container that is rendering out the dialog content. */
+    readonly containerInstance: BasePortalOutlet & {
+        _closeInteractionType?: FocusOrigin;
+    };
+    /** Whether the user is allowed to close the dialog. */
+    disableClose: boolean | undefined;
+    /** Emits when the dialog has been closed. */
+    readonly closed: Observable<R | undefined>;
+    /** Emits when the backdrop of the dialog is clicked. */
+    readonly backdropClick: Observable<MouseEvent>;
+    /** Emits when on keyboard events within the dialog. */
+    readonly keydownEvents: Observable<KeyboardEvent>;
+    /** Emits on pointer events that happen outside of the dialog. */
+    readonly outsidePointerEvents: Observable<MouseEvent>;
+    /** Unique ID for the dialog. */
+    readonly id: string;
+    /** Subscription to external detachments of the dialog. */
+    private _detachSubscription;
+    constructor(overlayRef: OverlayRef, config: DialogConfig<any, DialogRef<R, C>, BasePortalOutlet>);
+    /**
+     * Close the dialog.
+     * @param result Optional result to return to the dialog opener.
+     * @param options Additional options to customize the closing behavior.
+     */
+    close(result?: R, options?: DialogCloseOptions): void;
+    /** Updates the position of the dialog based on the current position strategy. */
+    updatePosition(): this;
+    /**
+     * Updates the dialog's width and height.
+     * @param width New width of the dialog.
+     * @param height New height of the dialog.
+     */
+    updateSize(width?: string | number, height?: string | number): this;
+    /** Add a CSS class or an array of classes to the overlay pane. */
+    addPanelClass(classes: string | string[]): this;
+    /** Remove a CSS class or an array of classes from the overlay pane. */
+    removePanelClass(classes: string | string[]): this;
+}
 
-export declare class Dialog implements OnDestroy {
+declare class Dialog implements OnDestroy {
     private _overlay;
     private _injector;
     private _defaultOptions;
@@ -225,228 +384,33 @@ export declare class Dialog implements OnDestroy {
     static ɵprov: i0.ɵɵInjectableDeclaration<Dialog>;
 }
 
-/** Injection token for the Dialog's Data. */
-export declare const DIALOG_DATA: InjectionToken<any>;
+declare class DialogModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<DialogModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<DialogModule, never, [typeof i1.OverlayModule, typeof i2.PortalModule, typeof i3.A11yModule, typeof CdkDialogContainer], [typeof i2.PortalModule, typeof CdkDialogContainer]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<DialogModule>;
+}
 
 /** Injection token for the Dialog's ScrollStrategy. */
-export declare const DIALOG_SCROLL_STRATEGY: InjectionToken<() => ScrollStrategy>;
-
+declare const DIALOG_SCROLL_STRATEGY: InjectionToken<() => ScrollStrategy>;
+/** Injection token for the Dialog's Data. */
+declare const DIALOG_DATA: InjectionToken<any>;
+/** Injection token that can be used to provide default options for the dialog module. */
+declare const DEFAULT_DIALOG_CONFIG: InjectionToken<DialogConfig<unknown, unknown, i2.BasePortalOutlet>>;
 /**
  * @docs-private
  * @deprecated No longer used. To be removed.
  * @breaking-change 19.0.0
  */
-export declare const DIALOG_SCROLL_STRATEGY_PROVIDER: {
-    provide: InjectionToken<() => ScrollStrategy>;
-    deps: (typeof Overlay)[];
-    useFactory: typeof DIALOG_SCROLL_STRATEGY_PROVIDER_FACTORY;
-};
-
+declare function DIALOG_SCROLL_STRATEGY_PROVIDER_FACTORY(overlay: Overlay): () => ScrollStrategy;
 /**
  * @docs-private
  * @deprecated No longer used. To be removed.
  * @breaking-change 19.0.0
  */
-export declare function DIALOG_SCROLL_STRATEGY_PROVIDER_FACTORY(overlay: Overlay): () => ScrollStrategy;
-
-/** Additional options that can be passed in when closing a dialog. */
-export declare interface DialogCloseOptions {
-    /** Focus original to use when restoring focus. */
-    focusOrigin?: FocusOrigin;
-}
-
-/** Configuration for opening a modal dialog. */
-export declare class DialogConfig<D = unknown, R = unknown, C extends BasePortalOutlet = BasePortalOutlet> {
-    /**
-     * Where the attached component should live in Angular's *logical* component tree.
-     * This affects what is available for injection and the change detection order for the
-     * component instantiated inside of the dialog. This does not affect where the dialog
-     * content will be rendered.
-     */
-    viewContainerRef?: ViewContainerRef;
-    /**
-     * Injector used for the instantiation of the component to be attached. If provided,
-     * takes precedence over the injector indirectly provided by `ViewContainerRef`.
-     */
-    injector?: Injector;
-    /** ID for the dialog. If omitted, a unique one will be generated. */
-    id?: string;
-    /** The ARIA role of the dialog element. */
-    role?: DialogRole;
-    /** Optional CSS class or classes applied to the overlay panel. */
-    panelClass?: string | string[];
-    /** Whether the dialog has a backdrop. */
-    hasBackdrop?: boolean;
-    /** Optional CSS class or classes applied to the overlay backdrop. */
-    backdropClass?: string | string[];
-    /** Whether the dialog closes with the escape key or pointer events outside the panel element. */
-    disableClose?: boolean;
-    /** Width of the dialog. */
-    width?: string;
-    /** Height of the dialog. */
-    height?: string;
-    /** Min-width of the dialog. If a number is provided, assumes pixel units. */
-    minWidth?: number | string;
-    /** Min-height of the dialog. If a number is provided, assumes pixel units. */
-    minHeight?: number | string;
-    /** Max-width of the dialog. If a number is provided, assumes pixel units. Defaults to 80vw. */
-    maxWidth?: number | string;
-    /** Max-height of the dialog. If a number is provided, assumes pixel units. */
-    maxHeight?: number | string;
-    /** Strategy to use when positioning the dialog. Defaults to centering it on the page. */
-    positionStrategy?: PositionStrategy;
-    /** Data being injected into the child component. */
-    data?: D | null;
-    /** Layout direction for the dialog's content. */
-    direction?: Direction;
-    /** ID of the element that describes the dialog. */
-    ariaDescribedBy?: string | null;
-    /** ID of the element that labels the dialog. */
-    ariaLabelledBy?: string | null;
-    /** Dialog label applied via `aria-label` */
-    ariaLabel?: string | null;
-    /**
-     * Whether this is a modal dialog. Used to set the `aria-modal` attribute. Off by default,
-     * because it can interfere with other overlay-based components (e.g. `mat-select`) and because
-     * it is redundant since the dialog marks all outside content as `aria-hidden` anyway.
-     */
-    ariaModal?: boolean;
-    /**
-     * Where the dialog should focus on open.
-     * @breaking-change 14.0.0 Remove boolean option from autoFocus. Use string or
-     * AutoFocusTarget instead.
-     */
-    autoFocus?: AutoFocusTarget | string | boolean;
-    /**
-     * Whether the dialog should restore focus to the previously-focused element upon closing.
-     * Has the following behavior based on the type that is passed in:
-     * - `boolean` - when true, will return focus to the element that was focused before the dialog
-     *    was opened, otherwise won't restore focus at all.
-     * - `string` - focus will be restored to the first element that matches the CSS selector.
-     * - `HTMLElement` - focus will be restored to the specific element.
-     */
-    restoreFocus?: boolean | string | HTMLElement;
-    /**
-     * Scroll strategy to be used for the dialog. This determines how
-     * the dialog responds to scrolling underneath the panel element.
-     */
-    scrollStrategy?: ScrollStrategy;
-    /**
-     * Whether the dialog should close when the user navigates backwards or forwards through browser
-     * history. This does not apply to navigation via anchor element unless using URL-hash based
-     * routing (`HashLocationStrategy` in the Angular router).
-     */
-    closeOnNavigation?: boolean;
-    /**
-     * Whether the dialog should close when the dialog service is destroyed. This is useful if
-     * another service is wrapping the dialog and is managing the destruction instead.
-     */
-    closeOnDestroy?: boolean;
-    /**
-     * Whether the dialog should close when the underlying overlay is detached. This is useful if
-     * another service is wrapping the dialog and is managing the destruction instead. E.g. an
-     * external detachment can happen as a result of a scroll strategy triggering it or when the
-     * browser location changes.
-     */
-    closeOnOverlayDetachments?: boolean;
-    /**
-     * Alternate `ComponentFactoryResolver` to use when resolving the associated component.
-     * @deprecated No longer used. Will be removed.
-     * @breaking-change 20.0.0
-     */
-    componentFactoryResolver?: unknown;
-    /**
-     * Providers that will be exposed to the contents of the dialog. Can also
-     * be provided as a function in order to generate the providers lazily.
-     */
-    providers?: StaticProvider[] | ((dialogRef: R, config: DialogConfig<D, R, C>, container: C) => StaticProvider[]);
-    /**
-     * Component into which the dialog content will be rendered. Defaults to `CdkDialogContainer`.
-     * A configuration object can be passed in to customize the providers that will be exposed
-     * to the dialog container.
-     */
-    container?: Type<C> | {
-        type: Type<C>;
-        providers: (config: DialogConfig<D, R, C>) => StaticProvider[];
-    };
-    /**
-     * Context that will be passed to template-based dialogs.
-     * A function can be passed in to resolve the context lazily.
-     */
-    templateContext?: Record<string, any> | (() => Record<string, any>);
-}
-
-export declare class DialogModule {
-    static ɵfac: i0.ɵɵFactoryDeclaration<DialogModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<DialogModule, never, [typeof i1.OverlayModule, typeof i2.PortalModule, typeof i3.A11yModule, typeof i4.CdkDialogContainer], [typeof i2.PortalModule, typeof i4.CdkDialogContainer]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<DialogModule>;
-}
-
-/**
- * Reference to a dialog opened via the Dialog service.
- */
-export declare class DialogRef<R = unknown, C = unknown> {
-    readonly overlayRef: OverlayRef;
-    readonly config: DialogConfig<any, DialogRef<R, C>, BasePortalOutlet>;
-    /**
-     * Instance of component opened into the dialog. Will be
-     * null when the dialog is opened using a `TemplateRef`.
-     */
-    readonly componentInstance: C | null;
-    /**
-     * `ComponentRef` of the component opened into the dialog. Will be
-     * null when the dialog is opened using a `TemplateRef`.
-     */
-    readonly componentRef: ComponentRef<C> | null;
-    /** Instance of the container that is rendering out the dialog content. */
-    readonly containerInstance: BasePortalOutlet & {
-        _closeInteractionType?: FocusOrigin;
-    };
-    /** Whether the user is allowed to close the dialog. */
-    disableClose: boolean | undefined;
-    /** Emits when the dialog has been closed. */
-    readonly closed: Observable<R | undefined>;
-    /** Emits when the backdrop of the dialog is clicked. */
-    readonly backdropClick: Observable<MouseEvent>;
-    /** Emits when on keyboard events within the dialog. */
-    readonly keydownEvents: Observable<KeyboardEvent>;
-    /** Emits on pointer events that happen outside of the dialog. */
-    readonly outsidePointerEvents: Observable<MouseEvent>;
-    /** Unique ID for the dialog. */
-    readonly id: string;
-    /** Subscription to external detachments of the dialog. */
-    private _detachSubscription;
-    constructor(overlayRef: OverlayRef, config: DialogConfig<any, DialogRef<R, C>, BasePortalOutlet>);
-    /**
-     * Close the dialog.
-     * @param result Optional result to return to the dialog opener.
-     * @param options Additional options to customize the closing behavior.
-     */
-    close(result?: R, options?: DialogCloseOptions): void;
-    /** Updates the position of the dialog based on the current position strategy. */
-    updatePosition(): this;
-    /**
-     * Updates the dialog's width and height.
-     * @param width New width of the dialog.
-     * @param height New height of the dialog.
-     */
-    updateSize(width?: string | number, height?: string | number): this;
-    /** Add a CSS class or an array of classes to the overlay pane. */
-    addPanelClass(classes: string | string[]): this;
-    /** Remove a CSS class or an array of classes from the overlay pane. */
-    removePanelClass(classes: string | string[]): this;
-}
-
-/** Valid ARIA roles for a dialog. */
-export declare type DialogRole = 'dialog' | 'alertdialog';
-
-declare namespace i4 {
-    export {
-        throwDialogContentAlreadyAttachedError,
-        CdkDialogContainer
-    }
-}
-
-export declare function throwDialogContentAlreadyAttachedError(): void;
+declare const DIALOG_SCROLL_STRATEGY_PROVIDER: {
+    provide: InjectionToken<() => ScrollStrategy>;
+    deps: (typeof Overlay)[];
+    useFactory: typeof DIALOG_SCROLL_STRATEGY_PROVIDER_FACTORY;
+};
 
-export { }
+export { type AutoFocusTarget, CdkDialogContainer, DEFAULT_DIALOG_CONFIG, DIALOG_DATA, DIALOG_SCROLL_STRATEGY, DIALOG_SCROLL_STRATEGY_PROVIDER, DIALOG_SCROLL_STRATEGY_PROVIDER_FACTORY, Dialog, type DialogCloseOptions, DialogConfig, DialogModule, DialogRef, type DialogRole, throwDialogContentAlreadyAttachedError };