@elderbyte/ngx-starter 18.7.1 → 18.8.0

package/lib/components/page/exit-guard/page-exit-guard.module.d.ts

@@ -0,0 +1,10 @@
+import * as i0 from "@angular/core";
+import * as i1 from "@angular/common";
+import * as i2 from "./page-exit-lock-indicator/page-exit-lock-indicator.component";
+export * from './page-exit-guard.service';
+export * from './page-exit-lock-indicator/page-exit-lock-indicator.component';
+export declare class PageExitGuardModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<PageExitGuardModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<PageExitGuardModule, never, [typeof i1.CommonModule, typeof i2.ElderPageExitLockIndicatorComponent], [typeof i2.ElderPageExitLockIndicatorComponent]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<PageExitGuardModule>;
+}

package/lib/components/page/exit-guard/page-exit-guard.service.d.ts

@@ -0,0 +1,77 @@
+import { Observable } from 'rxjs';
+import { ElderToastService } from '../../toasts/elder-toast.service';
+import * as i0 from "@angular/core";
+export declare class PageExitLock {
+    readonly message: string;
+    private lockService;
+    readonly id: string;
+    constructor(message: string, lockService: PageExitGuardServiceInternal);
+    release(): void;
+}
+export declare class PageExitGuardService {
+    private toast;
+    private internal;
+    constructor(toast: ElderToastService);
+    get locks$(): Observable<PageExitLock[]>;
+    get isPageExitBlocked$(): Observable<boolean>;
+    lock(message: string): PageExitLock;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PageExitGuardService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<PageExitGuardService>;
+}
+/***************************************************************************
+ *                                                                         *
+ * Internal                                                                *
+ *                                                                         *
+ **************************************************************************/
+declare class PageExitGuardServiceInternal {
+    private toast;
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    private readonly _beforeUnloadHandler;
+    private readonly _isPageExitBlocked$;
+    private readonly _lockMap$;
+    /***************************************************************************
+     *                                                                         *
+     * Properties                                                              *
+     *                                                                         *
+     **************************************************************************/
+    get locks$(): Observable<PageExitLock[]>;
+    get isPageExitBlocked$(): Observable<boolean>;
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    constructor(toast: ElderToastService);
+    /***************************************************************************
+     *                                                                         *
+     * Public methods                                                          *
+     *                                                                         *
+     **************************************************************************/
+    lock(message: string): PageExitLock;
+    unlock(lock: PageExitLock): void;
+    /***************************************************************************
+     *                                                                         *
+     * Private methods                                                         *
+     *                                                                         *
+     **************************************************************************/
+    /**
+     * starts an event listener that will prevent the user from immediately closing
+     * the tab / reloading, if it isn't already running.
+     *
+     * try to stop the alert service whenever you can to minimize the effect on
+     * performance.
+     * [more details here](https://developer.mozilla.org/en-US/docs/Web/API/Window/beforeunload_event#usage_notes)
+     *
+     */
+    private ensureListenerStarted;
+    /**
+     * removes the event listener, if the listener is running.
+     */
+    private ensureListenerStopped;
+    private preventDefaultAndWarnEvent;
+}
+export {};

package/lib/components/page/exit-guard/page-exit-lock/page-exit-lock.component.d.ts

@@ -0,0 +1,18 @@
+import { PageExitLock } from '../page-exit-guard.service';
+import * as i0 from "@angular/core";
+export declare class ElderPageExitLockComponent {
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    lock: import("@angular/core").InputSignal<PageExitLock>;
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    constructor();
+    static ɵfac: i0.ɵɵFactoryDeclaration<ElderPageExitLockComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ElderPageExitLockComponent, "elder-page-exit-lock", never, { "lock": { "alias": "lock"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+}

package/lib/components/page/exit-guard/page-exit-lock-indicator/page-exit-lock-indicator.component.d.ts

@@ -0,0 +1,21 @@
+import { Signal } from '@angular/core';
+import { PageExitGuardService, PageExitLock } from '../page-exit-guard.service';
+import * as i0 from "@angular/core";
+export declare class ElderPageExitLockIndicatorComponent {
+    private pageExitGuardService;
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    readonly isPageExitBlocked: Signal<boolean>;
+    readonly locks: Signal<PageExitLock[]>;
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    constructor(pageExitGuardService: PageExitGuardService);
+    static ɵfac: i0.ɵɵFactoryDeclaration<ElderPageExitLockIndicatorComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ElderPageExitLockIndicatorComponent, "elder-page-exit-lock-indicator", never, {}, {}, never, never, true, never>;
+}

package/lib/components/page/exit-guard/page-exit-lock-overview/page-exit-lock-overview.component.d.ts

@@ -0,0 +1,18 @@
+import { PageExitLock } from '../page-exit-guard.service';
+import * as i0 from "@angular/core";
+export declare class ElderPageExitLockOverviewComponent {
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    locks: import("@angular/core").InputSignal<PageExitLock[]>;
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    constructor();
+    static ɵfac: i0.ɵɵFactoryDeclaration<ElderPageExitLockOverviewComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ElderPageExitLockOverviewComponent, "elder-page-exit-lock-overview", never, { "locks": { "alias": "locks"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+}

package/lib/components/page/public_api.d.ts

@@ -0,0 +1 @@
+export * from './exit-guard/page-exit-guard.module';

package/lib/components/public_api.d.ts

@@ -39,3 +39,4 @@ export * from './errors/elder-error.module';
 export * from './auditing/elder-audit.module';
 export * from './tabs/elder-tab.module';
 export * from './badge/elder-badge.module';
+export * from './page/public_api';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elderbyte/ngx-starter",
-  "version": "18.7.1",
+  "version": "18.8.0",
   "peerDependencies": {
     "@angular/core": "^17.0.0 || ^18.0.0",
     "@angular/common": "^17.0.0 || ^18.0.0",

package/src/lib/components/page/exit-guard/page-exit-lock-indicator/page-exit-lock-indicator.component.scss

@@ -0,0 +1,10 @@
+.panel {
+  width: 250px;
+  height: 250px;
+  border-radius: 4px;
+  overflow: hidden;
+  box-shadow:
+    0 5px 5px -3px rgba(0, 0, 0, 0.2),
+    0 8px 10px 1px rgba(0, 0, 0, 0.14),
+    0 3px 14px 2px rgba(0, 0, 0, 0.12);
+}