@ethlete/cdk 4.10.1 → 4.11.1

package/lib/components/filter/public-api/index.d.ts

@@ -1,13 +1,3 @@
-export * from '../filter-overlay/components/filter-overlay-page-outlet';
-export * from '../filter-overlay/constants';
-export * from '../filter-overlay/directives/filter-overlay-back-or-close';
-export * from '../filter-overlay/directives/filter-overlay-link';
-export * from '../filter-overlay/directives/filter-overlay-reset';
-export * from '../filter-overlay/directives/filter-overlay-submit';
-export * from '../filter-overlay/filter-overlay.imports';
-export * from '../filter-overlay/services';
-export * from '../filter-overlay/types';
-export * from '../filter-overlay/utils';
 export * from '../rich-filter/components/rich-filter-host';
 export * from '../rich-filter/directives/rich-filter-button';
 export * from '../rich-filter/directives/rich-filter-button-slot';

package/lib/components/overlay/components/overlay/components/overlay-container/overlay-container.component.d.ts

@@ -9,7 +9,6 @@ import * as i0 from "@angular/core";
 import * as i1 from "@ethlete/core";
 import * as i2 from "@ethlete/theming";
 export declare class OverlayContainerComponent extends CdkDialogContainer<OverlayConfig> {
-    private readonly _destroy$;
     private readonly _swipeHandlerService;
     private readonly _dragToDismissStop$;
     readonly _themeProvider: ProvideThemeDirective;
@@ -19,18 +18,7 @@ export declare class OverlayContainerComponent extends CdkDialogContainer<Overla
     readonly cdkOverlayRef: CdkOverlayRef;
     overlayRef: OverlayRef | null;
     readonly elementRef: ElementRef<any>;
-    private readonly _layoutHasHeader;
-    private readonly _layoutHasBody;
-    private readonly _layoutHasFooter;
-    readonly hostClassBindings: {
-        remove: (...tokens: string[]) => void;
-        removeMany: (tokens: string[]) => void;
-        has: (token: string) => boolean;
-        push: (tokenString: string, signal: import("@angular/core").Signal<unknown>) => void;
-        pushMany: (map: Record<string, import("@angular/core").Signal<unknown>>) => void;
-    };
     constructor();
-    afterOverlayRefInit(): void;
     protected _contentAttached(): void;
     protected _captureInitialFocus(): void;
     protected _openAnimationDone(): void;

package/lib/components/overlay/components/overlay/overlay.imports.d.ts

@@ -1,11 +1,20 @@
 import { Dialog } from '@angular/cdk/dialog';
+import { OverlayBackOrCloseDirective } from './partials/overlay-back-or-close';
 import { OverlayBodyComponent } from './partials/overlay-body';
 import { OverlayCloseDirective } from './partials/overlay-close';
 import { OverlayFooterDirective } from './partials/overlay-footer';
 import { OverlayHeaderDirective } from './partials/overlay-header';
+import { OverlayHeaderTemplateDirective } from './partials/overlay-header-template';
+import { OverlayMainDirective } from './partials/overlay-main';
+import { OverlayRouteHeaderTemplateOutletComponent } from './partials/overlay-route-header-template-outlet';
+import { OverlayRouterLinkDirective } from './partials/overlay-router-link';
+import { OverlayRouterOutletComponent } from './partials/overlay-router-outlet';
+import { OverlaySidebarComponent } from './partials/overlay-sidebar';
 import { OverlayTitleDirective } from './partials/overlay-title';
 import { OverlayService } from './services';
-export declare const OverlayImports: readonly [typeof OverlayCloseDirective, typeof OverlayTitleDirective, typeof OverlayHeaderDirective, typeof OverlayBodyComponent, typeof OverlayFooterDirective];
+export declare const OverlayImports: readonly [typeof OverlayCloseDirective, typeof OverlayTitleDirective, typeof OverlayHeaderDirective, typeof OverlayBodyComponent, typeof OverlayFooterDirective, typeof OverlayMainDirective];
+export declare const OverlayWithRoutingImports: readonly [typeof OverlayCloseDirective, typeof OverlayTitleDirective, typeof OverlayHeaderDirective, typeof OverlayBodyComponent, typeof OverlayFooterDirective, typeof OverlayMainDirective, typeof OverlayHeaderTemplateDirective, typeof OverlayRouterOutletComponent, typeof OverlayRouterLinkDirective, typeof OverlayRouteHeaderTemplateOutletComponent, typeof OverlayBackOrCloseDirective];
+export declare const OverlayWithSidebarImports: readonly [typeof OverlayCloseDirective, typeof OverlayTitleDirective, typeof OverlayHeaderDirective, typeof OverlayBodyComponent, typeof OverlayFooterDirective, typeof OverlayMainDirective, typeof OverlayHeaderTemplateDirective, typeof OverlayRouterOutletComponent, typeof OverlayRouterLinkDirective, typeof OverlayRouteHeaderTemplateOutletComponent, typeof OverlayBackOrCloseDirective, typeof OverlaySidebarComponent];
 export declare const provideOverlay: () => ({
     provide: import("@angular/core").InjectionToken<() => import("@angular/cdk/overlay").ScrollStrategy>;
     deps: (typeof import("@angular/cdk/scrolling").ViewportRuler | typeof import("@ethlete/core").RouterStateService)[];

package/lib/components/overlay/components/overlay/partials/overlay-back-or-close/index.d.ts

@@ -0,0 +1 @@
+export * from './overlay-back-or-close.directive';

package/lib/components/overlay/components/overlay/partials/overlay-back-or-close/overlay-back-or-close.directive.d.ts

@@ -0,0 +1,19 @@
+import { InjectionToken } from '@angular/core';
+import { OverlayRef, OverlayRouterService } from '../../utils';
+import * as i0 from "@angular/core";
+export declare const OVERLAY_BACK_OR_CLOSE_TOKEN: InjectionToken<OverlayBackOrCloseDirective>;
+export declare class OverlayBackOrCloseDirective {
+    overlayRef: OverlayRef<any, any>;
+    router: OverlayRouterService;
+    disabled: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+    hostClassBindings: {
+        remove: (...tokens: string[]) => void;
+        removeMany: (tokens: string[]) => void;
+        has: (token: string) => boolean;
+        push: (tokenString: string, signal: import("@angular/core").Signal<unknown>) => void;
+        pushMany: (map: Record<string, import("@angular/core").Signal<unknown>>) => void;
+    };
+    constructor();
+    static ɵfac: i0.ɵɵFactoryDeclaration<OverlayBackOrCloseDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<OverlayBackOrCloseDirective, "[etOverlayBackOrClose]", never, { "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}

package/lib/components/overlay/components/overlay/partials/overlay-body/overlay-body.component.d.ts

@@ -1,18 +1,16 @@
-import { ElementRef, InjectionToken, OnDestroy, OnInit } from '@angular/core';
+import { ElementRef, InjectionToken, OnInit } from '@angular/core';
 import * as i0 from "@angular/core";
 import * as i1 from "@ethlete/core";
 export declare const OVERLAY_BODY_TOKEN: InjectionToken<OverlayBodyComponent>;
 export type OverlayBodyDividerType = 'static' | 'dynamic' | false;
-export declare class OverlayBodyComponent implements OnInit, OnDestroy {
+export declare class OverlayBodyComponent implements OnInit {
     private _overlayRef;
     private readonly _elementRef;
     private readonly _overlayService;
     set __dividers(value: OverlayBodyDividerType);
     protected readonly dividers: import("@angular/core").WritableSignal<OverlayBodyDividerType>;
-    private set _firstElement(value);
-    readonly firstElement: import("@angular/core").WritableSignal<ElementRef<HTMLElement> | null>;
-    private set _lastElement(value);
-    readonly lastElement: import("@angular/core").WritableSignal<ElementRef<HTMLElement> | null>;
+    readonly firstElement: import("@angular/core").Signal<ElementRef<HTMLElement> | null | undefined>;
+    readonly lastElement: import("@angular/core").Signal<ElementRef<HTMLElement> | null | undefined>;
     private readonly _dividersEnabled;
     private readonly _dynamicDividersEnabled;
     private readonly containerScrollState;
@@ -33,7 +31,6 @@ export declare class OverlayBodyComponent implements OnInit, OnDestroy {
     };
     constructor();
     ngOnInit(): void;
-    ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<OverlayBodyComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<OverlayBodyComponent, "[et-overlay-body], et-overlay-body", never, { "__dividers": { "alias": "dividers"; "required": false; }; }, {}, never, ["*"], true, [{ directive: typeof i1.RootBoundaryDirective; inputs: {}; outputs: {}; }]>;
 }

package/lib/components/overlay/components/overlay/partials/overlay-footer/overlay-footer.directive.d.ts

@@ -1,12 +1,11 @@
-import { InjectionToken, OnDestroy, OnInit } from '@angular/core';
+import { InjectionToken, OnInit } from '@angular/core';
 import * as i0 from "@angular/core";
 export declare const OVERLAY_FOOTER_TOKEN: InjectionToken<OverlayFooterDirective>;
-export declare class OverlayFooterDirective implements OnInit, OnDestroy {
+export declare class OverlayFooterDirective implements OnInit {
     private _overlayRef;
     private readonly _elementRef;
     private readonly _overlayService;
     ngOnInit(): void;
-    ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<OverlayFooterDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<OverlayFooterDirective, "[etOverlayFooter], et-overlay-footer", never, {}, {}, never, never, true, never>;
 }

package/lib/components/overlay/components/overlay/partials/overlay-header/overlay-header.directive.d.ts

@@ -1,12 +1,11 @@
-import { InjectionToken, OnDestroy, OnInit } from '@angular/core';
+import { InjectionToken, OnInit } from '@angular/core';
 import * as i0 from "@angular/core";
 export declare const OVERLAY_HEADER_TOKEN: InjectionToken<OverlayHeaderDirective>;
-export declare class OverlayHeaderDirective implements OnInit, OnDestroy {
+export declare class OverlayHeaderDirective implements OnInit {
     private _overlayRef;
     private readonly _elementRef;
     private readonly _overlayService;
     ngOnInit(): void;
-    ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<OverlayHeaderDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<OverlayHeaderDirective, "[etOverlayHeader], et-overlay-header", never, {}, {}, never, never, true, never>;
 }

package/lib/components/overlay/components/overlay/partials/overlay-header-template/index.d.ts

@@ -0,0 +1 @@
+export * from './overlay-header-template.directive';

package/lib/components/overlay/components/overlay/partials/overlay-header-template/overlay-header-template.directive.d.ts

@@ -0,0 +1,14 @@
+import { InjectionToken, OnDestroy, OnInit, TemplateRef } from '@angular/core';
+import * as i0 from "@angular/core";
+export declare const OVERLAY_HEADER_TEMPLATE_TOKEN: InjectionToken<OverlayHeaderTemplateDirective>;
+export declare class OverlayHeaderTemplateDirective implements OnInit, OnDestroy {
+    private _overlayRef;
+    private readonly _elementRef;
+    private readonly _overlayService;
+    template: TemplateRef<any>;
+    constructor();
+    ngOnInit(): void;
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<OverlayHeaderTemplateDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<OverlayHeaderTemplateDirective, "ng-template[etOverlayHeaderTemplate]", never, {}, {}, never, never, true, never>;
+}

package/lib/components/overlay/components/overlay/partials/overlay-main/index.d.ts

@@ -0,0 +1 @@
+export * from './overlay-main.directive';

package/lib/components/overlay/components/overlay/partials/overlay-main/overlay-main.directive.d.ts

@@ -0,0 +1,12 @@
+import { InjectionToken, OnInit } from '@angular/core';
+import * as i0 from "@angular/core";
+export declare const OVERLAY_MAIN_TOKEN: InjectionToken<OverlayMainDirective>;
+export declare class OverlayMainDirective implements OnInit {
+    private _parent;
+    private _overlayRef;
+    private readonly _elementRef;
+    private readonly _overlayService;
+    ngOnInit(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<OverlayMainDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<OverlayMainDirective, "[etOverlayMain], et-overlay-main", never, {}, {}, never, never, true, never>;
+}

package/lib/components/overlay/components/overlay/partials/overlay-route-header-template-outlet/index.d.ts

@@ -0,0 +1 @@
+export * from './overlay-route-header-template-outlet.component';

package/lib/components/overlay/components/overlay/partials/overlay-route-header-template-outlet/overlay-route-header-template-outlet.component.d.ts

@@ -0,0 +1,17 @@
+import { AnimatedLifecycleDirective } from '@ethlete/core';
+import { OverlayRef, OverlayRouterService } from '../../utils';
+import * as i0 from "@angular/core";
+export declare class OverlayRouteHeaderTemplateOutletComponent {
+    router: OverlayRouterService;
+    overlay: OverlayRef<any, any>;
+    animatedLifecycle: import("@angular/core").Signal<AnimatedLifecycleDirective>;
+    hostClassBindings: {
+        remove: (...tokens: string[]) => void;
+        removeMany: (tokens: string[]) => void;
+        has: (token: string) => boolean;
+        push: (tokenString: string, signal: import("@angular/core").Signal<unknown>) => void;
+        pushMany: (map: Record<string, import("@angular/core").Signal<unknown>>) => void;
+    };
+    static ɵfac: i0.ɵɵFactoryDeclaration<OverlayRouteHeaderTemplateOutletComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<OverlayRouteHeaderTemplateOutletComponent, "et-overlay-route-header-template-outlet", never, {}, {}, never, never, true, never>;
+}

package/lib/components/overlay/components/overlay/partials/overlay-router-link/index.d.ts

@@ -0,0 +1 @@
+export * from './overlay-router-link.directive';

package/lib/components/overlay/components/overlay/partials/overlay-router-link/overlay-router-link.directive.d.ts

@@ -0,0 +1,19 @@
+import { InjectionToken } from '@angular/core';
+import { OverlayRouterService } from '../../utils';
+import * as i0 from "@angular/core";
+export declare const OVERLAY_ROUTER_LINK_TOKEN: InjectionToken<OverlayRouterLinkDirective>;
+export declare class OverlayRouterLinkDirective {
+    router: OverlayRouterService;
+    path: import("@angular/core").InputSignal<string | (string | number)[]>;
+    disabled: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+    hostClassBindings: {
+        remove: (...tokens: string[]) => void;
+        removeMany: (tokens: string[]) => void;
+        has: (token: string) => boolean;
+        push: (tokenString: string, signal: import("@angular/core").Signal<unknown>) => void;
+        pushMany: (map: Record<string, import("@angular/core").Signal<unknown>>) => void;
+    };
+    constructor();
+    static ɵfac: i0.ɵɵFactoryDeclaration<OverlayRouterLinkDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<OverlayRouterLinkDirective, "[etOverlayRouterLink]", never, { "path": { "alias": "etOverlayRouterLink"; "required": true; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}

package/lib/components/overlay/components/overlay/partials/overlay-router-outlet/index.d.ts

@@ -0,0 +1 @@
+export * from './overlay-router-outlet.component';

package/lib/components/overlay/components/overlay/partials/overlay-router-outlet/overlay-router-outlet.component.d.ts

@@ -0,0 +1,14 @@
+import { OverlayRouterService } from '../../utils';
+import * as i0 from "@angular/core";
+export declare class OverlayRouterOutletComponent {
+    router: OverlayRouterService;
+    hostClassBindings: {
+        remove: (...tokens: string[]) => void;
+        removeMany: (tokens: string[]) => void;
+        has: (token: string) => boolean;
+        push: (tokenString: string, signal: import("@angular/core").Signal<unknown>) => void;
+        pushMany: (map: Record<string, import("@angular/core").Signal<unknown>>) => void;
+    };
+    static ɵfac: i0.ɵɵFactoryDeclaration<OverlayRouterOutletComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<OverlayRouterOutletComponent, "et-overlay-router-outlet", never, {}, {}, never, never, true, never>;
+}

package/lib/components/overlay/components/overlay/partials/overlay-sidebar/index.d.ts

@@ -0,0 +1 @@
+export * from './overlay-sidebar.component';

package/lib/components/overlay/components/overlay/partials/overlay-sidebar/overlay-sidebar.component.d.ts

@@ -0,0 +1,18 @@
+import { TemplateRef } from '@angular/core';
+import { SidebarOverlayService } from '../../utils';
+import * as i0 from "@angular/core";
+export declare class OverlaySidebarComponent {
+    sidebarContent: import("@angular/core").Signal<TemplateRef<unknown>>;
+    sidebarHeaderContent: import("@angular/core").Signal<import("../overlay-header-template").OverlayHeaderTemplateDirective | undefined>;
+    sidebar: SidebarOverlayService;
+    hostClassBindings: {
+        remove: (...tokens: string[]) => void;
+        removeMany: (tokens: string[]) => void;
+        has: (token: string) => boolean;
+        push: (tokenString: string, signal: import("@angular/core").Signal<unknown>) => void;
+        pushMany: (map: Record<string, import("@angular/core").Signal<unknown>>) => void;
+    };
+    constructor();
+    static ɵfac: i0.ɵɵFactoryDeclaration<OverlaySidebarComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<OverlaySidebarComponent, "et-overlay-sidebar", never, {}, {}, ["sidebarHeaderContent"], ["*"], true, never>;
+}

package/lib/components/overlay/components/overlay/partials/overlay-sidebar-page/index.d.ts

@@ -0,0 +1 @@
+export * from './overlay-sidebar-page.component';

package/lib/components/overlay/components/overlay/partials/overlay-sidebar-page/overlay-sidebar-page.component.d.ts

@@ -0,0 +1,10 @@
+import { TemplateRef } from '@angular/core';
+import { OverlayHeaderTemplateDirective } from '../overlay-header-template';
+import * as i0 from "@angular/core";
+import * as i1 from "../overlay-main/overlay-main.directive";
+export declare class OverlaySidebarPageComponent {
+    headerTemplate: import("@angular/core").InputSignal<OverlayHeaderTemplateDirective | null>;
+    bodyTemplate: import("@angular/core").InputSignal<TemplateRef<unknown> | null>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<OverlaySidebarPageComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<OverlaySidebarPageComponent, "et-overlay-sidebar-page", never, { "headerTemplate": { "alias": "headerTemplate"; "required": true; "isSignal": true; }; "bodyTemplate": { "alias": "bodyTemplate"; "required": true; "isSignal": true; }; }, {}, never, never, true, [{ directive: typeof i1.OverlayMainDirective; inputs: {}; outputs: {}; }]>;
+}

package/lib/components/overlay/components/overlay/utils/filter-overlay.d.ts

@@ -0,0 +1,66 @@
+import { ComponentType } from '@angular/cdk/portal';
+import { InjectionToken } from '@angular/core';
+import { FormGroup } from '@angular/forms';
+import { AnyQuery, QueryResponseOf, QueryState } from '@ethlete/query';
+import { OverlayRef } from './overlay-ref';
+import * as i0 from "@angular/core";
+export declare const FILTER_OVERLAY_CONFIG: InjectionToken<FilterOverlayConfig<FormGroup<any>, AnyQuery>>;
+export type FilterOverlayConfig<F extends FormGroup<any> = FormGroup<any>, Q extends AnyQuery = AnyQuery> = {
+    /**
+     * The form to use.
+     */
+    form: F;
+    /**
+     * The default form value. Used when the form is reset.
+     */
+    defaults?: ReturnType<F['getRawValue']>;
+    /**
+     * A function to create a query based on the form value.
+     */
+    searchPreviewQueryFn?: (formValue: ReturnType<F['getRawValue']>) => Q;
+    /**
+     * A function to extract the total hits from the response.
+     * @default `response.totalHits`
+     */
+    totalHitsExtractorFn?: (response: QueryResponseOf<Q>) => number;
+    /**
+     * A function to create the submit button config based on the query state and the total hits.
+     * If a german translation is needed, manually provide the `defaultSubmitButtonConfigFn` and set the locale to `de`.
+     * @default defaultSubmitButtonConfigFn()
+     */
+    submitButtonConfigFn?: (config: DefaultSubmitButtonConfigFnConfig<QueryResponseOf<Q>>) => FilterOverlaySubmitButtonConfig;
+};
+export type FilterOverlaySubmitButtonConfig = {
+    label: string;
+    disabled: boolean;
+};
+export type DefaultSubmitButtonConfigFnConfig<ResponseType = unknown> = {
+    queryState: QueryState<ResponseType> | null;
+    totalHits: number | null;
+    locale?: 'en' | 'de';
+};
+export declare const defaultSubmitButtonConfigFn: (config: DefaultSubmitButtonConfigFnConfig) => FilterOverlaySubmitButtonConfig;
+export type FilterOverlayResult<FormValue = unknown> = {
+    didUpdate: false;
+} | {
+    didUpdate: true;
+    formValue: FormValue;
+};
+export declare class FilterOverlayService<F extends FormGroup, C extends ComponentType<unknown>> {
+    config: FilterOverlayConfig<F, AnyQuery>;
+    overlayRef: OverlayRef<C, FilterOverlayResult<unknown>>;
+    form: F;
+    searchPreviewQuery: import("@angular/core").Signal<AnyQuery | null>;
+    searchPreviewQueryState: import("@angular/core").Signal<QueryState<any> | null>;
+    searchPreviewTotalHits: import("@angular/core").Signal<number | null>;
+    submitButtonConfig: import("@angular/core").Signal<FilterOverlaySubmitButtonConfig>;
+    submit(): void;
+    reset(): void;
+    close(data?: FilterOverlayResult): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FilterOverlayService<any, any>, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<FilterOverlayService<any, any>>;
+}
+export declare const provideFilterOverlayConfig: (config: FilterOverlayConfig) => (typeof FilterOverlayService | {
+    provide: InjectionToken<FilterOverlayConfig<FormGroup<any>, AnyQuery>>;
+    useValue: FilterOverlayConfig<FormGroup<any>, AnyQuery>;
+})[];

package/lib/components/overlay/components/overlay/utils/index.d.ts

@@ -1,4 +1,7 @@
+export * from './filter-overlay';
 export * from './overlay-config';
 export * from './overlay-position-builder';
 export * from './overlay-ref';
+export * from './overlay-router';
 export * from './overlay.utils';
+export * from './sidebar-overlay';

package/lib/components/overlay/components/overlay/utils/overlay-position-builder.d.ts

@@ -91,6 +91,10 @@ export declare class OverlayPositionBuilder {
         fullScreenDialog?: OverlayBreakpointConfig;
         rightSheet?: OverlayBreakpointConfig;
     }): OverlayBreakpointConfigEntry[];
+    transformingFullScreenDialogToDialog(customConfig?: {
+        fullScreenDialog?: OverlayBreakpointConfig;
+        dialog?: OverlayBreakpointConfig;
+    }): OverlayBreakpointConfigEntry[];
     dialog(customConfig?: OverlayBreakpointConfig): OverlayBreakpointConfigEntry[];
     fullScreenDialog(customConfig?: OverlayBreakpointConfig): OverlayBreakpointConfigEntry[];
     bottomSheet(customConfig?: OverlayBreakpointConfig): OverlayBreakpointConfigEntry[];

package/lib/components/overlay/components/overlay/utils/overlay-ref.d.ts

@@ -1,7 +1,6 @@
 import { FocusOrigin } from '@angular/cdk/a11y';
 import { DialogRef as CdkDialogRef } from '@angular/cdk/dialog';
-import { ComponentRef } from '@angular/core';
-import { BehaviorSubject } from 'rxjs';
+import { ComponentRef, TemplateRef } from '@angular/core';
 import { OverlayContainerComponent } from '../components/overlay-container';
 import { OverlayConfig, OverlayPosition, OverlayState } from '../types';
 export interface OverlayCloseCallEvent<R = any> {
@@ -13,6 +12,10 @@ export interface OverlayLayout {
     hasBody: boolean;
     hasFooter: boolean;
 }
+export interface OverlayHeaderTemplates {
+    current: TemplateRef<unknown> | null;
+    previous: TemplateRef<unknown> | null;
+}
 export declare class OverlayRef<T = any, R = any> {
     private _ref;
     _containerInstance: OverlayContainerComponent;
@@ -41,13 +44,10 @@ export declare class OverlayRef<T = any, R = any> {
      * @internal
      */
     _isCloseFnCloseControlledExternally: boolean;
-    /**
-     * @internal
-     */
-    readonly _layout$: BehaviorSubject<OverlayLayout>;
     private _disableCloseFromInternalInitiators;
     get _internalDisableClose(): boolean;
     get _cdkRef(): CdkDialogRef<R, T>;
+    headerTemplate: import("@angular/core").WritableSignal<TemplateRef<unknown> | null>;
     constructor(_ref: CdkDialogRef<R, T>, config: OverlayConfig, _containerInstance: OverlayContainerComponent);
     close(result?: R, force?: boolean): void;
     afterOpened(): import("rxjs").Observable<void>;
@@ -65,5 +65,5 @@ export declare class OverlayRef<T = any, R = any> {
     _closeOverlayVia(interactionType: FocusOrigin, result?: R, force?: boolean): void;
     _addInternalBackdropCloseInitiator(initiatorId: string | number): void;
     _removeInternalBackdropCloseInitiator(initiatorId: string | number): void;
-    _updateLayout(layout: Partial<OverlayLayout>): void;
+    _setCurrentHeaderTemplate(template: TemplateRef<unknown> | null): void;
 }

package/lib/components/overlay/components/overlay/utils/overlay-router.d.ts

@@ -0,0 +1,96 @@
+import { ComponentType } from '@angular/cdk/portal';
+import { InjectionToken } from '@angular/core';
+import * as i0 from "@angular/core";
+export declare const OVERLAY_ROUTER_CONFIG_TOKEN: InjectionToken<OverlayRouterConfig>;
+export type OverlayRoute = {
+    /**
+     * The component to render.
+     */
+    component: ComponentType<unknown>;
+    /**
+     * The route of the page.
+     *
+     * @example
+     * "/" // The root route
+     * "/two" // The route "two"
+     */
+    path: `/${string}`;
+    /**
+     * The inputs to pass to the component.
+     */
+    inputs?: Record<string, unknown>;
+};
+export type OverlayRouterConfig = {
+    /**
+     * The routes to be able to navigate to.
+     */
+    routes: OverlayRoute[];
+    /**
+     * The route on which to start.
+     * @default "" // The root route
+     * @default routes[0].path // The first route if no root route is defined
+     */
+    initialRoute?: string;
+};
+export type OverlayRouterNavigationDirection = 'forward' | 'backward';
+export declare class OverlayRouterService {
+    config: OverlayRouterConfig;
+    syncCurrentRoute: import("@angular/core").WritableSignal<string>;
+    currentRoute: import("@angular/core").Signal<string>;
+    routeHistory: import("@angular/core").WritableSignal<string[]>;
+    rootHistoryItem: import("@angular/core").WritableSignal<string | null>;
+    extraRoutes: import("@angular/core").WritableSignal<OverlayRoute[]>;
+    routes: import("@angular/core").Signal<{
+        inputs: Record<string, unknown>;
+        /**
+         * The component to render.
+         */
+        component: ComponentType<unknown>;
+        /**
+         * The route of the page.
+         *
+         * @example
+         * "/" // The root route
+         * "/two" // The route "two"
+         */
+        path: `/${string}`;
+    }[]>;
+    currentPage: import("@angular/core").Signal<{
+        inputs: Record<string, unknown>;
+        /**
+         * The component to render.
+         */
+        component: ComponentType<unknown>;
+        /**
+         * The route of the page.
+         *
+         * @example
+         * "/" // The root route
+         * "/two" // The route "two"
+         */
+        path: `/${string}`;
+    } | null>;
+    lastPage: import("@angular/core").Signal<string | null | undefined>;
+    canGoBack: import("@angular/core").Signal<number>;
+    navigationDirection: import("@angular/core").WritableSignal<OverlayRouterNavigationDirection>;
+    constructor();
+    navigate(route: string | (string | number)[]): void;
+    back(): void;
+    resolvePath(route: string | (string | number)[]): {
+        readonly route: string;
+        readonly type: "forward" | "back" | "replace-current" | "absolute" | "unknown";
+    };
+    addRoute(route: OverlayRoute): void;
+    removeRoute(path: string): void;
+    _updateCurrentRoute(route: string, config?: {
+        updateHistory?: boolean;
+    }): void;
+    _removeItemFromHistory(item: string): void;
+    _navigateToInitialRoute(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<OverlayRouterService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<OverlayRouterService>;
+}
+export declare const provideOverlayRouterConfig: (config: OverlayRouterConfig) => (typeof OverlayRouterService | {
+    provide: InjectionToken<OverlayRouterConfig>;
+    useValue: OverlayRouterConfig;
+})[];

package/lib/components/overlay/components/overlay/utils/sidebar-overlay.d.ts

@@ -0,0 +1,35 @@
+import { InjectionToken, TemplateRef } from '@angular/core';
+import { Breakpoint, ViewportService } from '@ethlete/core';
+import { OverlayHeaderTemplateDirective } from '../partials/overlay-header-template';
+import { OverlayRouterService } from './overlay-router';
+import * as i0 from "@angular/core";
+export declare const SIDEBAR_OVERLAY_CONFIG: InjectionToken<SidebarOverlayConfig>;
+export type SidebarOverlayConfig = {
+    /**
+     * On mobile devices, the sidebar will be shown as a separate page that can be navigated to.
+     * This is the route to the sidebar page.
+     *
+     * @default "/sidebar"
+     */
+    sidebarPageRoute?: `/${string}`;
+    /**
+     * The breakpoint from which to render the sidebar. Can be a breakpoint or a number representing the pixel width.
+     * @default "md"
+     */
+    renderSidebarFrom?: Breakpoint | number;
+};
+export declare class SidebarOverlayService {
+    config: SidebarOverlayConfig;
+    viewportService: ViewportService;
+    router: OverlayRouterService;
+    renderSidebar: import("@angular/core").Signal<boolean>;
+    sidebarContentTemplate: import("@angular/core").WritableSignal<TemplateRef<unknown> | null>;
+    sidebarHeaderTemplate: import("@angular/core").WritableSignal<OverlayHeaderTemplateDirective | null>;
+    constructor();
+    static ɵfac: i0.ɵɵFactoryDeclaration<SidebarOverlayService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SidebarOverlayService>;
+}
+export declare const provideSidebarOverlayConfig: (config: SidebarOverlayConfig) => (typeof SidebarOverlayService | {
+    provide: InjectionToken<SidebarOverlayConfig>;
+    useValue: SidebarOverlayConfig;
+})[];

package/lib/components/overlay/public-api/index.d.ts

@@ -31,10 +31,18 @@ export * from '../components/menu-deprecated';
 export * from '../components/overlay/components/overlay-container';
 export * from '../components/overlay/constants';
 export * from '../components/overlay/overlay.imports';
+export * from '../components/overlay/partials/overlay-back-or-close';
 export * from '../components/overlay/partials/overlay-body';
 export * from '../components/overlay/partials/overlay-close';
 export * from '../components/overlay/partials/overlay-footer';
 export * from '../components/overlay/partials/overlay-header';
+export * from '../components/overlay/partials/overlay-header-template';
+export * from '../components/overlay/partials/overlay-main';
+export * from '../components/overlay/partials/overlay-route-header-template-outlet';
+export * from '../components/overlay/partials/overlay-router-link';
+export * from '../components/overlay/partials/overlay-router-outlet';
+export * from '../components/overlay/partials/overlay-sidebar';
+export * from '../components/overlay/partials/overlay-sidebar-page';
 export * from '../components/overlay/partials/overlay-title';
 export * from '../components/overlay/services';
 export * from '../components/overlay/types';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethlete/cdk",
-  "version": "4.10.1",
+  "version": "4.11.1",
   "exports": {
     ".": {
       "css": "./src/lib/styles/index.css",
@@ -14,13 +14,13 @@
     }
   },
   "peerDependencies": {
-    "@angular/animations": "17.3.0",
-    "@angular/cdk": "17.2.2",
-    "@angular/common": "17.3.0",
-    "@angular/core": "17.3.0",
-    "@angular/forms": "17.3.0",
-    "@angular/platform-browser": "17.3.0",
-    "@angular/router": "17.3.0",
+    "@angular/animations": "17.3.1",
+    "@angular/cdk": "17.3.1",
+    "@angular/common": "17.3.1",
+    "@angular/core": "17.3.1",
+    "@angular/forms": "17.3.1",
+    "@angular/platform-browser": "17.3.1",
+    "@angular/router": "17.3.1",
     "@ethlete/core": "^4.0.3",
     "@ethlete/query": "^5.0.3",
     "@ethlete/theming": "^2.3.1",