@almoamendev/ngx-md3 0.3.7 → 0.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@almoamendev/ngx-md3",
-  "version": "0.3.7",
+  "version": "0.4.0",
   "description": "MD3-style Angular components & style library",
   "author": "Murtadha (Hussain) Almoamen",
   "license": "MIT",

package/types/almoamendev-ngx-md3.d.ts

@@ -1,11 +1,11 @@
 import * as _angular_core from '@angular/core';
 import { ViewContainerRef, Injector, ElementRef, AfterViewInit, OnDestroy, OnInit, Renderer2, Signal, InputSignal, InjectionToken, Type, AfterContentInit, ComponentRef, TemplateRef } from '@angular/core';
 import { FlexibleConnectedPositionStrategyOrigin, ConnectedPosition, OverlayRef } from '@angular/cdk/overlay';
+import { Observable } from 'rxjs';
 import * as i1 from '@angular/cdk/scrolling';
 import { AbstractControl } from '@angular/forms';
 import * as i1$1 from '@angular/router';
 import { CdkDialogContainer, DialogRef as DialogRef$1 } from '@angular/cdk/dialog';
-import { Observable } from 'rxjs';
 import { CdkPortalOutlet } from '@angular/cdk/portal';
 
 type TextSize = 'large' | 'medium' | 'small';
@@ -226,6 +226,34 @@ interface SideSheetContainer {
     setHidden(value: boolean): void;
 }
 
+interface BottomSheetConfig<D = unknown> {
+    data?: D;
+    bindDataToInputs?: boolean;
+    /** Shows the MD3 drag handle centered above the sheet's content. */
+    handle?: boolean;
+    /** Lets the sheet be dragged down, and flung, to dismiss it. */
+    gestures?: boolean;
+    scheme?: 'inherit' | 'dark' | 'light';
+    direction?: null | 'ltr' | 'rtl';
+    viewContainerRef?: ViewContainerRef;
+    injector?: Injector;
+}
+/**
+ * What BottomSheetRef needs from the shell hosting a bottom sheet, mirroring
+ * DialogContainer: a bottom sheet is a CDK dialog container underneath, not a
+ * side-sheet-style outlet.
+ */
+interface BottomSheetContainer {
+    readonly surfaceElement: HTMLElement | null;
+    /** Emits when a drag gesture asks for the sheet to be dismissed. */
+    readonly dismissed: Observable<void>;
+    /** Emits how far a drag has taken the sheet towards being dismissed, from 0 to 1. */
+    readonly dragProgress: Observable<number>;
+    startEnterAnimation(): void;
+    setActive(value: boolean): void;
+    recaptureFocus(): void;
+}
+
 type SnackbarPoliteness = 'polite' | 'assertive';
 interface SnackbarConfig<D = unknown> {
     /**
@@ -1842,6 +1870,70 @@ declare class SideSheetActions {
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<SideSheetActions, "md3-side-sheet-actions", never, { "showDivider": { "alias": "show-divider"; "required": false; "isSignal": true; }; }, {}, never, ["*"], true, never>;
 }
 
+declare const BOTTOM_SHEET_DATA: InjectionToken<unknown>;
+declare const BOTTOM_SHEET_CONFIG: InjectionToken<BottomSheetConfig<unknown>>;
+declare const BOTTOM_SHEET_COMPONENT: InjectionToken<Type<unknown>>;
+/**
+ * A bottom sheet is a single modal overlay, not a stack like dialogs can be,
+ * so this is a smaller version of DialogRef: no hide/show, no full screen
+ * variant, closing is always the only way out.
+ */
+declare class BottomSheetRef<T = unknown, R = unknown> {
+    private readonly cdkRef;
+    private readonly closed;
+    private closeStarted;
+    private closeSettled;
+    /** Shell hosting the sheet. Filled by BottomSheetService once it is created. */
+    sheetInstance?: BottomSheetContainer;
+    /** Filled by BottomSheetService after the sheet component is attached. */
+    componentInstance?: T;
+    /** Overlay hosting the sheet, useful to reach the panel and the scrim. */
+    get overlayRef(): OverlayRef;
+    /** Whether the sheet started closing. */
+    get isClosing(): boolean;
+    constructor(cdkRef: DialogRef$1<R, T>);
+    /** Closes the sheet. The promise resolves once the exit animation is done. */
+    close(result?: R): Promise<void>;
+    afterClosed(): Observable<R | undefined>;
+    /**
+     * Wires the shell to this reference. Called by BottomSheetService, since the shell is
+     * created by the CDK before this reference exists and cannot reach it through DI.
+     */
+    attachContainer(container: BottomSheetContainer): void;
+    /** Fades the scrim along with the sheet being dragged, and hands it back to CSS on release. */
+    private trackDragProgress;
+    private connectCloseEvents;
+    private startCloseAnimation;
+    /** Resolves when the surface finished animating, with a timeout as a safety net. */
+    private waitForSurfaceAnimation;
+    /** Emits the result once the CDK reference is closed. Focus is restored by the container. */
+    private settle;
+}
+
+/**
+ * Opens bottom sheets as CDK dialogs anchored to the bottom of the viewport.
+ * A bottom sheet is always a modal overlay, the same way a regular dialog is
+ * always an overlay, so this mirrors DialogService rather than the side sheet
+ * outlet model: there is no docked variant and nothing to register from the
+ * scaffold.
+ */
+declare class BottomSheetService {
+    private readonly cdkDialog;
+    private readonly overlay;
+    private readonly injector;
+    /** Only one bottom sheet is ever open at a time. */
+    private ref?;
+    open<T, D = unknown, R = unknown>(component: Type<T>, config?: BottomSheetConfig<D>): BottomSheetRef<T, R>;
+    /** Closes the bottom sheet that is open, if there is one. */
+    close<R = unknown>(result?: R): void;
+    private startOpenAnimation;
+    private mergeConfig;
+    private bindDataToInputs;
+    private canBindDataToInputs;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<BottomSheetService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<BottomSheetService>;
+}
+
 declare class Snackbar implements OnInit, OnDestroy {
     private readonly el;
     private readonly snackbarRef;
@@ -1937,5 +2029,5 @@ declare class SnackbarService {
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<SnackbarService>;
 }
 
-export { AppBar, AppBarLogo, Avatar, Badge, Button, ButtonGroup, CAROUSEL_STRATEGIES, Card, Carousel, CarouselItem, Checkbox, ChipAvatar, Chips, CircularProgressIndicator, DIALOG_COMPONENT, DIALOG_CONFIG, DIALOG_DATA, Dialog, DialogActions, DialogBody, DialogHeader, DialogRef, DialogService, Divider, FloatingActionButton, FullScreenDialog, FullScreenDialogHeader, Grid, GridItem, IconButton, IconElement, InputElement, LayoutService, LinearProgressIndicator, List, ListItem, ListItemPrimaryAction, ListLeading, ListSlot, LoadingIndicator, MENU_COMPONENT, MENU_CONFIG, MENU_DATA, MaterialIcon, Menu, MenuGroup, MenuItem, MenuRef, MenuService, NavigationBar, NavigationGroup, NavigationItem, NavigationRail, RadioButton, SIDE_SHEET_COMPONENT, SIDE_SHEET_CONFIG, SIDE_SHEET_DATA, SNACKBAR_ACTION_LABEL, SNACKBAR_CONFIG, SNACKBAR_MESSAGE, Scaffold, ScaffoldBar, ScaffoldPane, ScaffoldRail, SheetsService, SideSheetActions, SideSheetBody, SideSheetHeader, SideSheetRef, Slider, Snackbar, SnackbarRef, SnackbarService, SplitButton, StateComponent, SupportingText, Switch, TextField, TypeBody, TypeDisplay, TypeHeadline, TypeLabel, TypeTitle, buildGeometry, clampIndex, indexForScrollOffset, multiBrowseStrategy, parseCarouselAspectRatio, resolveItemGeometry, resolveState, scrollOffsetForIndex, sizeBandFor };
-export type { AppBarScrollingStyle, AppBarType, ButtonGroupSelection, ButtonGroupType, ButtonSize, ButtonType, CardType, CarouselAlignment, CarouselArrangement, CarouselGeometry, CarouselItemGeometry, CarouselItemSize, CarouselKeyline, CarouselKeylineState, CarouselLayout, CarouselOrientation, CarouselStrategy, CarouselStrategyContext, ChipStyle, ChipType, DialogConfig, DialogContainer, DialogRole, FabSize, FabType, FullScreenDialogConfig, IconButtonType, IconButtonWidth, ListLeadingSize, ListLeadingType, Md3NavigationMode, MenuConfig, MenuPositionOrigin, MenuPositionX, MenuPositionY, MenuScrollStrategy, PreviousDialog, SideSheetConfig, SideSheetContainer, SideSheetSide, SideSheetType, SliderSize, SnackbarConfig, SnackbarDismiss, SnackbarDismissReason, SnackbarPoliteness, SplitButtonType, TextColor, TextSize };
+export { AppBar, AppBarLogo, Avatar, BOTTOM_SHEET_COMPONENT, BOTTOM_SHEET_CONFIG, BOTTOM_SHEET_DATA, Badge, BottomSheetRef, BottomSheetService, Button, ButtonGroup, CAROUSEL_STRATEGIES, Card, Carousel, CarouselItem, Checkbox, ChipAvatar, Chips, CircularProgressIndicator, DIALOG_COMPONENT, DIALOG_CONFIG, DIALOG_DATA, Dialog, DialogActions, DialogBody, DialogHeader, DialogRef, DialogService, Divider, FloatingActionButton, FullScreenDialog, FullScreenDialogHeader, Grid, GridItem, IconButton, IconElement, InputElement, LayoutService, LinearProgressIndicator, List, ListItem, ListItemPrimaryAction, ListLeading, ListSlot, LoadingIndicator, MENU_COMPONENT, MENU_CONFIG, MENU_DATA, MaterialIcon, Menu, MenuGroup, MenuItem, MenuRef, MenuService, NavigationBar, NavigationGroup, NavigationItem, NavigationRail, RadioButton, SIDE_SHEET_COMPONENT, SIDE_SHEET_CONFIG, SIDE_SHEET_DATA, SNACKBAR_ACTION_LABEL, SNACKBAR_CONFIG, SNACKBAR_MESSAGE, Scaffold, ScaffoldBar, ScaffoldPane, ScaffoldRail, SheetsService, SideSheetActions, SideSheetBody, SideSheetHeader, SideSheetRef, Slider, Snackbar, SnackbarRef, SnackbarService, SplitButton, StateComponent, SupportingText, Switch, TextField, TypeBody, TypeDisplay, TypeHeadline, TypeLabel, TypeTitle, buildGeometry, clampIndex, indexForScrollOffset, multiBrowseStrategy, parseCarouselAspectRatio, resolveItemGeometry, resolveState, scrollOffsetForIndex, sizeBandFor };
+export type { AppBarScrollingStyle, AppBarType, BottomSheetConfig, BottomSheetContainer, ButtonGroupSelection, ButtonGroupType, ButtonSize, ButtonType, CardType, CarouselAlignment, CarouselArrangement, CarouselGeometry, CarouselItemGeometry, CarouselItemSize, CarouselKeyline, CarouselKeylineState, CarouselLayout, CarouselOrientation, CarouselStrategy, CarouselStrategyContext, ChipStyle, ChipType, DialogConfig, DialogContainer, DialogRole, FabSize, FabType, FullScreenDialogConfig, IconButtonType, IconButtonWidth, ListLeadingSize, ListLeadingType, Md3NavigationMode, MenuConfig, MenuPositionOrigin, MenuPositionX, MenuPositionY, MenuScrollStrategy, PreviousDialog, SideSheetConfig, SideSheetContainer, SideSheetSide, SideSheetType, SliderSize, SnackbarConfig, SnackbarDismiss, SnackbarDismissReason, SnackbarPoliteness, SplitButtonType, TextColor, TextSize };