123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345 |
- import * as i2 from '@angular/cdk/overlay';
- import { OverlayRef, ComponentType } from '@angular/cdk/overlay';
- import { Subject, Observable } from 'rxjs';
- import * as i0 from '@angular/core';
- import { InjectionToken, ViewContainerRef, OnDestroy, ElementRef, ComponentRef, EmbeddedViewRef, TemplateRef } from '@angular/core';
- import * as i3 from '@angular/cdk/portal';
- import { BasePortalOutlet, CdkPortalOutlet, ComponentPortal, TemplatePortal, DomPortal } from '@angular/cdk/portal';
- import { AriaLivePoliteness } from '@angular/cdk/a11y';
- import { Direction } from '@angular/cdk/bidi';
- import { MatButtonModule } from '../button/index.js';
- import { M as MatCommonModule } from '../common-module.d-C8xzHJDr.js';
- import '../palette.d-BSSFKjO6.js';
- import '../ripple-loader.d-C3HznB6v.js';
- import '../index.d-DG9eDM2-.js';
- import '../ripple.d-BxTUZJt7.js';
- import '@angular/cdk/platform';
- /** Injection token that can be used to access the data that was passed in to a snack bar. */
- declare const MAT_SNACK_BAR_DATA: InjectionToken<any>;
- /** Possible values for horizontalPosition on MatSnackBarConfig. */
- type MatSnackBarHorizontalPosition = 'start' | 'center' | 'end' | 'left' | 'right';
- /** Possible values for verticalPosition on MatSnackBarConfig. */
- type MatSnackBarVerticalPosition = 'top' | 'bottom';
- /**
- * Configuration used when opening a snack-bar.
- */
- declare class MatSnackBarConfig<D = any> {
- /** The politeness level for the MatAriaLiveAnnouncer announcement. */
- politeness?: AriaLivePoliteness;
- /**
- * Message to be announced by the LiveAnnouncer. When opening a snackbar without a custom
- * component or template, the announcement message will default to the specified message.
- */
- announcementMessage?: string;
- /**
- * The view container that serves as the parent for the snackbar for the purposes of dependency
- * injection. Note: this does not affect where the snackbar is inserted in the DOM.
- */
- viewContainerRef?: ViewContainerRef;
- /** The length of time in milliseconds to wait before automatically dismissing the snack bar. */
- duration?: number;
- /** Extra CSS classes to be added to the snack bar container. */
- panelClass?: string | string[];
- /** Text layout direction for the snack bar. */
- direction?: Direction;
- /** Data being injected into the child component. */
- data?: D | null;
- /** The horizontal position to place the snack bar. */
- horizontalPosition?: MatSnackBarHorizontalPosition;
- /** The vertical position to place the snack bar. */
- verticalPosition?: MatSnackBarVerticalPosition;
- }
- /**
- * Internal component that wraps user-provided snack bar content.
- * @docs-private
- */
- declare class MatSnackBarContainer extends BasePortalOutlet implements OnDestroy {
- private _ngZone;
- private _elementRef;
- private _changeDetectorRef;
- private _platform;
- private _rendersRef;
- protected _animationsDisabled: boolean;
- snackBarConfig: MatSnackBarConfig<any>;
- private _document;
- private _trackedModals;
- private _enterFallback;
- private _exitFallback;
- private _renders;
- /** The number of milliseconds to wait before announcing the snack bar's content. */
- private readonly _announceDelay;
- /** The timeout for announcing the snack bar's content. */
- private _announceTimeoutId;
- /** Whether the component has been destroyed. */
- private _destroyed;
- /** The portal outlet inside of this container into which the snack bar content will be loaded. */
- _portalOutlet: CdkPortalOutlet;
- /** Subject for notifying that the snack bar has announced to screen readers. */
- readonly _onAnnounce: Subject<void>;
- /** Subject for notifying that the snack bar has exited from view. */
- readonly _onExit: Subject<void>;
- /** Subject for notifying that the snack bar has finished entering the view. */
- readonly _onEnter: Subject<void>;
- /** The state of the snack bar animations. */
- _animationState: string;
- /** aria-live value for the live region. */
- _live: AriaLivePoliteness;
- /**
- * Element that will have the `mdc-snackbar__label` class applied if the attached component
- * or template does not have it. This ensures that the appropriate structure, typography, and
- * color is applied to the attached view.
- */
- _label: ElementRef;
- /**
- * Role of the live region. This is only for Firefox as there is a known issue where Firefox +
- * JAWS does not read out aria-live message.
- */
- _role?: 'status' | 'alert';
- /** Unique ID of the aria-live element. */
- readonly _liveElementId: string;
- constructor(...args: unknown[]);
- /** Attach a component portal as content to this snack bar container. */
- attachComponentPortal<T>(portal: ComponentPortal<T>): ComponentRef<T>;
- /** Attach a template portal as content to this snack bar container. */
- attachTemplatePortal<C>(portal: TemplatePortal<C>): EmbeddedViewRef<C>;
- /**
- * Attaches a DOM portal to the snack bar container.
- * @deprecated To be turned into a method.
- * @breaking-change 10.0.0
- */
- attachDomPortal: (portal: DomPortal) => void;
- /** Handle end of animations, updating the state of the snackbar. */
- onAnimationEnd(animationName: string): void;
- /** Begin animation of snack bar entrance into view. */
- enter(): void;
- /** Begin animation of the snack bar exiting from view. */
- exit(): Observable<void>;
- /** Makes sure the exit callbacks have been invoked when the element is destroyed. */
- ngOnDestroy(): void;
- private _completeExit;
- /**
- * Called after the portal contents have been attached. Can be
- * used to modify the DOM once it's guaranteed to be in place.
- */
- private _afterPortalAttached;
- /**
- * Some browsers won't expose the accessibility node of the live element if there is an
- * `aria-modal` and the live element is outside of it. This method works around the issue by
- * pointing the `aria-owns` of all modals to the live element.
- */
- private _exposeToModals;
- /** Clears the references to the live element from any modals it was added to. */
- private _clearFromModals;
- /** Asserts that no content is already attached to the container. */
- private _assertNotAttached;
- /**
- * Starts a timeout to move the snack bar content to the live region so screen readers will
- * announce it.
- */
- private _screenReaderAnnounce;
- static ɵfac: i0.ɵɵFactoryDeclaration<MatSnackBarContainer, never>;
- static ɵcmp: i0.ɵɵComponentDeclaration<MatSnackBarContainer, "mat-snack-bar-container", never, {}, {}, never, never, true, never>;
- }
- /** Event that is emitted when a snack bar is dismissed. */
- interface MatSnackBarDismiss {
- /** Whether the snack bar was dismissed using the action button. */
- dismissedByAction: boolean;
- }
- /**
- * Reference to a snack bar dispatched from the snack bar service.
- */
- declare class MatSnackBarRef<T> {
- private _overlayRef;
- /** The instance of the component making up the content of the snack bar. */
- instance: T;
- /**
- * The instance of the component making up the content of the snack bar.
- * @docs-private
- */
- containerInstance: MatSnackBarContainer;
- /** Subject for notifying the user that the snack bar has been dismissed. */
- private readonly _afterDismissed;
- /** Subject for notifying the user that the snack bar has opened and appeared. */
- private readonly _afterOpened;
- /** Subject for notifying the user that the snack bar action was called. */
- private readonly _onAction;
- /**
- * Timeout ID for the duration setTimeout call. Used to clear the timeout if the snackbar is
- * dismissed before the duration passes.
- */
- private _durationTimeoutId;
- /** Whether the snack bar was dismissed using the action button. */
- private _dismissedByAction;
- constructor(containerInstance: MatSnackBarContainer, _overlayRef: OverlayRef);
- /** Dismisses the snack bar. */
- dismiss(): void;
- /** Marks the snackbar action clicked. */
- dismissWithAction(): void;
- /**
- * Marks the snackbar action clicked.
- * @deprecated Use `dismissWithAction` instead.
- * @breaking-change 8.0.0
- */
- closeWithAction(): void;
- /** Dismisses the snack bar after some duration */
- _dismissAfter(duration: number): void;
- /** Marks the snackbar as opened */
- _open(): void;
- /** Cleans up the DOM after closing. */
- private _finishDismiss;
- /** Gets an observable that is notified when the snack bar is finished closing. */
- afterDismissed(): Observable<MatSnackBarDismiss>;
- /** Gets an observable that is notified when the snack bar has opened and appeared. */
- afterOpened(): Observable<void>;
- /** Gets an observable that is notified when the snack bar action is called. */
- onAction(): Observable<void>;
- }
- /**
- * Interface for a simple snack bar component that has a message and a single action.
- */
- interface TextOnlySnackBar {
- data: {
- message: string;
- action: string;
- };
- snackBarRef: MatSnackBarRef<TextOnlySnackBar>;
- action: () => void;
- hasAction: boolean;
- }
- declare class SimpleSnackBar implements TextOnlySnackBar {
- snackBarRef: MatSnackBarRef<SimpleSnackBar>;
- data: any;
- constructor(...args: unknown[]);
- /** Performs the action on the snack bar. */
- action(): void;
- /** If the action button should be shown. */
- get hasAction(): boolean;
- static ɵfac: i0.ɵɵFactoryDeclaration<SimpleSnackBar, never>;
- static ɵcmp: i0.ɵɵComponentDeclaration<SimpleSnackBar, "simple-snack-bar", ["matSnackBar"], {}, {}, never, never, true, never>;
- }
- /** Directive that should be applied to the text element to be rendered in the snack bar. */
- declare class MatSnackBarLabel {
- static ɵfac: i0.ɵɵFactoryDeclaration<MatSnackBarLabel, never>;
- static ɵdir: i0.ɵɵDirectiveDeclaration<MatSnackBarLabel, "[matSnackBarLabel]", never, {}, {}, never, never, true, never>;
- }
- /** Directive that should be applied to the element containing the snack bar's action buttons. */
- declare class MatSnackBarActions {
- static ɵfac: i0.ɵɵFactoryDeclaration<MatSnackBarActions, never>;
- static ɵdir: i0.ɵɵDirectiveDeclaration<MatSnackBarActions, "[matSnackBarActions]", never, {}, {}, never, never, true, never>;
- }
- /** Directive that should be applied to each of the snack bar's action buttons. */
- declare class MatSnackBarAction {
- static ɵfac: i0.ɵɵFactoryDeclaration<MatSnackBarAction, never>;
- static ɵdir: i0.ɵɵDirectiveDeclaration<MatSnackBarAction, "[matSnackBarAction]", never, {}, {}, never, never, true, never>;
- }
- /**
- * @docs-private
- * @deprecated No longer used, will be removed.
- * @breaking-change 21.0.0
- */
- declare function MAT_SNACK_BAR_DEFAULT_OPTIONS_FACTORY(): MatSnackBarConfig;
- /** Injection token that can be used to specify default snack bar. */
- declare const MAT_SNACK_BAR_DEFAULT_OPTIONS: InjectionToken<MatSnackBarConfig<any>>;
- /**
- * Service to dispatch Material Design snack bar messages.
- */
- declare class MatSnackBar implements OnDestroy {
- private _overlay;
- private _live;
- private _injector;
- private _breakpointObserver;
- private _parentSnackBar;
- private _defaultConfig;
- /**
- * Reference to the current snack bar in the view *at this level* (in the Angular injector tree).
- * If there is a parent snack-bar service, all operations should delegate to that parent
- * via `_openedSnackBarRef`.
- */
- private _snackBarRefAtThisLevel;
- /** The component that should be rendered as the snack bar's simple component. */
- simpleSnackBarComponent: typeof SimpleSnackBar;
- /** The container component that attaches the provided template or component. */
- snackBarContainerComponent: typeof MatSnackBarContainer;
- /** The CSS class to apply for handset mode. */
- handsetCssClass: string;
- /** Reference to the currently opened snackbar at *any* level. */
- get _openedSnackBarRef(): MatSnackBarRef<any> | null;
- set _openedSnackBarRef(value: MatSnackBarRef<any> | null);
- constructor(...args: unknown[]);
- /**
- * Creates and dispatches a snack bar with a custom component for the content, removing any
- * currently opened snack bars.
- *
- * @param component Component to be instantiated.
- * @param config Extra configuration for the snack bar.
- */
- openFromComponent<T, D = any>(component: ComponentType<T>, config?: MatSnackBarConfig<D>): MatSnackBarRef<T>;
- /**
- * Creates and dispatches a snack bar with a custom template for the content, removing any
- * currently opened snack bars.
- *
- * @param template Template to be instantiated.
- * @param config Extra configuration for the snack bar.
- */
- openFromTemplate(template: TemplateRef<any>, config?: MatSnackBarConfig): MatSnackBarRef<EmbeddedViewRef<any>>;
- /**
- * Opens a snackbar with a message and an optional action.
- * @param message The message to show in the snackbar.
- * @param action The label for the snackbar action.
- * @param config Additional configuration options for the snackbar.
- */
- open(message: string, action?: string, config?: MatSnackBarConfig): MatSnackBarRef<TextOnlySnackBar>;
- /**
- * Dismisses the currently-visible snack bar.
- */
- dismiss(): void;
- ngOnDestroy(): void;
- /**
- * Attaches the snack bar container component to the overlay.
- */
- private _attachSnackBarContainer;
- /**
- * Places a new component or a template as the content of the snack bar container.
- */
- private _attach;
- /** Animates the old snack bar out and the new one in. */
- private _animateSnackBar;
- /**
- * Creates a new overlay and places it in the correct location.
- * @param config The user-specified snack bar config.
- */
- private _createOverlay;
- /**
- * Creates an injector to be used inside of a snack bar component.
- * @param config Config that was used to create the snack bar.
- * @param snackBarRef Reference to the snack bar.
- */
- private _createInjector;
- static ɵfac: i0.ɵɵFactoryDeclaration<MatSnackBar, never>;
- static ɵprov: i0.ɵɵInjectableDeclaration<MatSnackBar>;
- }
- declare class MatSnackBarModule {
- static ɵfac: i0.ɵɵFactoryDeclaration<MatSnackBarModule, never>;
- static ɵmod: i0.ɵɵNgModuleDeclaration<MatSnackBarModule, never, [typeof i2.OverlayModule, typeof i3.PortalModule, typeof MatButtonModule, typeof MatCommonModule, typeof SimpleSnackBar, typeof MatSnackBarContainer, typeof MatSnackBarLabel, typeof MatSnackBarActions, typeof MatSnackBarAction], [typeof MatCommonModule, typeof MatSnackBarContainer, typeof MatSnackBarLabel, typeof MatSnackBarActions, typeof MatSnackBarAction]>;
- static ɵinj: i0.ɵɵInjectorDeclaration<MatSnackBarModule>;
- }
- /**
- * Animations used by the Material snack bar.
- * @docs-private
- * @deprecated No longer used, will be removed.
- * @breaking-change 21.0.0
- */
- declare const matSnackBarAnimations: {
- readonly snackBarState: any;
- };
- export { MAT_SNACK_BAR_DATA, MAT_SNACK_BAR_DEFAULT_OPTIONS, MAT_SNACK_BAR_DEFAULT_OPTIONS_FACTORY, MatSnackBar, MatSnackBarAction, MatSnackBarActions, MatSnackBarConfig, MatSnackBarContainer, MatSnackBarLabel, MatSnackBarModule, MatSnackBarRef, SimpleSnackBar, matSnackBarAnimations };
- export type { MatSnackBarDismiss, MatSnackBarHorizontalPosition, MatSnackBarVerticalPosition, TextOnlySnackBar };
|