@cute-widgets/base 20.0.1

package/snack-bar/index.d.ts

@@ -0,0 +1,374 @@
+import { OverlayRef, ComponentType } from '@angular/cdk/overlay';
+import { Subject, Observable } from 'rxjs';
+import * as i0 from '@angular/core';
+import { ViewContainerRef, InjectionToken, OnDestroy, ElementRef, WritableSignal, ComponentRef, EmbeddedViewRef, TemplateRef } from '@angular/core';
+import { BasePortalOutlet, CdkPortalOutlet, ComponentPortal, TemplatePortal, DomPortal } from '@angular/cdk/portal';
+import { AriaLivePoliteness } from '@angular/cdk/a11y';
+import { Direction } from '@angular/cdk/bidi';
+import { RichThemeColor } from '@cute-widgets/base/core';
+import { CuteLayoutControl } from '@cute-widgets/base/abstract';
+import * as i1 from '@angular/common';
+
+/**
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 CuteWidgets Team. All Rights Reserved.
+ *
+ * You may not use this file except in compliance with the License
+ * that can be found at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This code is a modification of the `@angular/material` original
+ * code licensed under MIT-style License (https://angular.dev/license).
+ */
+
+/** Injection token that can be used to access the data that was passed in to a snack bar. */
+declare const CUTE_SNACK_BAR_DATA: InjectionToken<any>;
+/** Possible values for horizontalPosition on CuteSnackBarConfig. */
+type CuteSnackBarHorizontalPosition = 'start' | 'center' | 'end' | 'left' | 'right';
+/** Possible values for verticalPosition on CuteSnackBarConfig. */
+type CuteSnackBarVerticalPosition = 'top' | 'bottom';
+/**
+ * Configuration used when opening a snack-bar.
+ */
+declare class CuteSnackBarConfig<D = any> {
+    /** The politeness level for the LiveAnnouncer 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?: CuteSnackBarHorizontalPosition;
+    /** The vertical position to place the snack bar. */
+    verticalPosition?: CuteSnackBarVerticalPosition;
+    /** Theme color for the snack bar. */
+    color?: RichThemeColor;
+    /** Adds a linear gradient as background image to the backgrounds */
+    gradientFill?: boolean;
+    /** Whether the user can dismiss the snack bar by clicking close button. */
+    dismissible?: boolean;
+}
+
+/**
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 CuteWidgets Team. All Rights Reserved.
+ *
+ * You may not use this file except in compliance with the License
+ * that can be found at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This code is a modification of the `@angular/material` original
+ * code licensed under MIT-style License (https://angular.dev/license).
+ */
+
+/**
+ * Internal component that wraps user-provided snack bar content.
+ */
+declare class CuteSnackBarContainer extends BasePortalOutlet implements OnDestroy {
+    private _ngZone;
+    readonly _elementRef: ElementRef<HTMLElement>;
+    private _changeDetectorRef;
+    private _platform;
+    protected _animationsDisabled: boolean;
+    snackBarConfig: CuteSnackBarConfig<any>;
+    private _document;
+    private _themeService;
+    private _trackedModals;
+    private _enterFallback;
+    private _exitFallback;
+    private _injector;
+    protected isLightTheme: WritableSignal<boolean>;
+    /** 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 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 `cute-snackbar__label` class applied if the attached component
+     * or template does not have it. This ensures that the appropriate structure, typography, and
+     * color are applied to the attached view.
+     */
+    _label: ElementRef | undefined;
+    /**
+     * Role of the live region. This is only for Firefox as there is a known issue where Firefox +
+     * JAWS does not read out an 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;
+    /**
+     * Removes the element in a microtask. Helps prevent errors where we end up
+     * removing an element which is in the middle of an animation.
+     */
+    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<CuteSnackBarContainer, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<CuteSnackBarContainer, "cute-snack-bar-container", never, {}, {}, never, never, true, never>;
+}
+
+/**
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 CuteWidgets Team. All Rights Reserved.
+ *
+ * You may not use this file except in compliance with the License
+ * that can be found at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This code is a modification of the `@angular/material` original
+ * code licensed under MIT-style License (https://angular.dev/license).
+ */
+
+/** Event that is emitted when a snack bar is dismissed. */
+interface CuteSnackBarDismiss {
+    /** 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 CuteSnackBarRef<T> {
+    private _overlayRef;
+    /** The instance of the component making up the content of the snack bar. */
+    instance: T | undefined;
+    /** The instance of the component making up the content of the snack bar. */
+    containerInstance: CuteSnackBarContainer;
+    /** 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: CuteSnackBarContainer, _overlayRef: OverlayRef);
+    /** Dismisses the snack bar. */
+    dismiss(): void;
+    /** Marks the snackbar action clicked. */
+    dismissWithAction(): 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 notified when the snack bar is finished closing. */
+    afterDismissed(): Observable<CuteSnackBarDismiss>;
+    /** Gets an observable notified when the snack bar has opened and appeared. */
+    afterOpened(): Observable<void>;
+    /** Gets an observable 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: CuteSnackBarRef<TextOnlySnackBar>;
+    action: () => void;
+    hasAction: boolean;
+}
+declare class SimpleSnackBar extends CuteLayoutControl implements TextOnlySnackBar {
+    snackBarRef: CuteSnackBarRef<SimpleSnackBar>;
+    data: any;
+    protected readonly config: CuteSnackBarConfig;
+    constructor(...args: unknown[]);
+    protected generateId(): string;
+    /** 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", ["cuteSnackBar"], {}, {}, never, never, true, never>;
+}
+
+/** Directive that should be applied to the element containing the snack bar's header elements. */
+declare class CuteSnackBarHeader {
+    static ɵfac: i0.ɵɵFactoryDeclaration<CuteSnackBarHeader, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<CuteSnackBarHeader, "cute-snack-bar-header", never, {}, {}, never, ["*"], true, never>;
+}
+/** Directive that should be applied to the element containing the snack bar's body elements. */
+declare class CuteSnackBarBody {
+    static ɵfac: i0.ɵɵFactoryDeclaration<CuteSnackBarBody, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<CuteSnackBarBody, "[cuteSnackBarBody]", never, {}, {}, never, never, true, never>;
+}
+/** Directive that should be applied to the text element to be rendered in the snack bar. */
+declare class CuteSnackBarLabel {
+    static ɵfac: i0.ɵɵFactoryDeclaration<CuteSnackBarLabel, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<CuteSnackBarLabel, "[cuteSnackBarLabel]", never, {}, {}, never, never, true, never>;
+}
+/** Directive that should be applied to the element containing the snack bar's action buttons. */
+declare class CuteSnackBarActions {
+    static ɵfac: i0.ɵɵFactoryDeclaration<CuteSnackBarActions, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<CuteSnackBarActions, "[cuteSnackBarActions]", never, {}, {}, never, never, true, never>;
+}
+/** Directive that should be applied to each of the snack bar's action buttons. */
+declare class CuteSnackBarAction {
+    static ɵfac: i0.ɵɵFactoryDeclaration<CuteSnackBarAction, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<CuteSnackBarAction, "[cuteSnackBarAction]", never, {}, {}, never, never, true, never>;
+}
+
+/** Injection token that can be used to specify the default snack bar. */
+declare const CUTE_SNACK_BAR_DEFAULT_OPTIONS: InjectionToken<CuteSnackBarConfig<any>>;
+/**
+ * Service to dispatch Cute snack bar messages.
+ */
+declare class CuteSnackBar implements OnDestroy {
+    private _live;
+    private _injector;
+    private _overlay;
+    private _breakpointObserver;
+    private _parentSnackBar;
+    private _defaultConfig;
+    private _animationsDisabled;
+    private _destroyRef;
+    /**
+     * 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. */
+    private _simpleSnackBarComponent;
+    /** The container component that attaches the provided template or component. */
+    snackBarContainerComponent: typeof CuteSnackBarContainer;
+    /** The CSS class to apply for handset mode. */
+    handsetCssClass: string;
+    /** Reference to the currently opened snackbar at *any* level. */
+    get _openedSnackBarRef(): CuteSnackBarRef<any> | null;
+    set _openedSnackBarRef(value: CuteSnackBarRef<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?: CuteSnackBarConfig<D>): CuteSnackBarRef<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?: CuteSnackBarConfig): CuteSnackBarRef<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?: CuteSnackBarConfig): CuteSnackBarRef<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<CuteSnackBar, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<CuteSnackBar>;
+}
+
+declare class CuteSnackbarModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<CuteSnackbarModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<CuteSnackbarModule, never, [typeof i1.CommonModule, typeof SimpleSnackBar, typeof CuteSnackBarContainer, typeof CuteSnackBarActions, typeof CuteSnackBarAction, typeof CuteSnackBarBody, typeof CuteSnackBarHeader, typeof CuteSnackBarLabel], [typeof CuteSnackBarContainer, typeof CuteSnackBarActions, typeof CuteSnackBarAction, typeof CuteSnackBarBody, typeof CuteSnackBarHeader, typeof CuteSnackBarLabel]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<CuteSnackbarModule>;
+}
+
+export { CUTE_SNACK_BAR_DATA, CUTE_SNACK_BAR_DEFAULT_OPTIONS, CuteSnackBar, CuteSnackBarAction, CuteSnackBarActions, CuteSnackBarBody, CuteSnackBarConfig, CuteSnackBarContainer, CuteSnackBarHeader, CuteSnackBarLabel, CuteSnackBarRef, CuteSnackbarModule, SimpleSnackBar };
+export type { CuteSnackBarDismiss, CuteSnackBarHorizontalPosition, CuteSnackBarVerticalPosition, TextOnlySnackBar };