angular-toolbox 1.4.5 → 1.4.6

package/lib/framework/dialog/dialog-backdrop-type.enum.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+/**
+ * Defines the possible values used to assign properties of type of `DialogBackdrop`.
+ */
+export declare enum DialogBackdropType {
+    /**
+     * Indicates that the dialog element is of type of "static".
+     */
+    STATIC = "static",
+    /**
+     * Indicates that the dialog element is of type of "modal".
+     */
+    MODAL = "modal"
+}

package/lib/framework/dialog/dialog-backdrop.type.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+/**
+ * Indicates the type of a dialog backdrop element.
+ */
+export type DialogBackdrop = "modal" | "static";

package/lib/framework/dialog/dialog-default-config.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { DialogConfig } from './dialog.config';
+/**
+ * @private
+ */
+export declare const DEFAULT_CONFIG: DialogConfig;

package/lib/framework/dialog/dialog-outlet-event-type.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+/**
+ * Specifies the event type of `DialogOutletEvent` instances.
+ */
+export type DialogOutletEventType = "show" | "hide";

package/lib/framework/dialog/dialog-outlet.event.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { DialogOutletEventType } from "./dialog-outlet-event-type";
+import { DialogConfig } from "./dialog.config";
+/**
+ * Event that indicates the state changes of components managed by the `DialogService` service singleton.
+ */
+export declare class DialogOutletEvent {
+    /**
+     * The type of event dispatched each time the dialog element is displayed.
+     */
+    static readonly SHOW: DialogOutletEventType;
+    /**
+     * The type of event dispatched each time the dialog element is removed.
+     */
+    static readonly HIDE: DialogOutletEventType;
+    /**
+     * A `DialogOutletEventType` value that indicates the state of the dialog element.
+     */
+    readonly state: DialogOutletEventType;
+    /**
+     * The dialog element config associated with an event of type of `"show"`.
+     * `config` is set to  `null` when the event is of type of `"hide"`.
+     */
+    readonly config: DialogConfig | null;
+    /**
+     * @private
+     *
+     * Creates a new `DialogOutletEvent` instance.
+     *
+     * @param state The state of the dialog element.
+     * @param config  The dialog element config associated with this event.
+     */
+    constructor(state: DialogOutletEventType, config?: DialogConfig | null);
+}

package/lib/framework/dialog/dialog-service.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { ComponentRef, EventEmitter, ViewContainerRef } from "@angular/core";
+import { DialogOutletEvent } from "./dialog-outlet.event";
+import { DialogConfig } from "./dialog.config";
+import * as i0 from "@angular/core";
+/**
+ * The `DialogService` class manages injection of customs component into the
+ * HTML dialog element created by the ATX framework.
+ */
+export declare class DialogService {
+    /**
+     * Dispatches an event that indicates the state of the dialog element when a custom
+     * component is added to, or remove from it.
+     */
+    readonly dialogStateChange: EventEmitter<DialogOutletEvent>;
+    /**
+     * @private
+     */
+    protected viewContainerRef: ViewContainerRef;
+    /**
+     * Creates an instance of the `compRef` class, adds this instance to the HTML dialog element
+     * and displays the dialog element in front of all other components in the application.
+     *
+     * @param compRef The class that represents the component to display as a popup element.
+     * @param config The dialog element config associated with the new component instance to display.
+     *
+     * @returns The new `ComponentRef` which contains the component instance and the host view.
+     */
+    show<T>(compRef: any, config?: DialogConfig | null): ComponentRef<T>;
+    /**
+     * Indicates to the ATX framework to remove component instances previously created with
+     * the `show()` method.
+     */
+    hide(): void;
+    /**
+     * @private
+     */
+    __init__(viewContainerRef: ViewContainerRef): boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DialogService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DialogService>;
+}

package/lib/framework/dialog/dialog-service.error.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+/**
+ * The `DialogServiceError` class represents errors thrown by the ATX framework
+ * when a dialog error occurs.
+ */
+export declare class DialogServiceError extends Error {
+    /**
+     * Creates a new `DialogServiceError` instance.
+     *
+     * @param message The `message` data property is a human-readable description of this `DialogServiceError` instance.
+     */
+    constructor(message: string);
+}

package/lib/framework/dialog/dialog.config.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { DialogBackdropType } from "./dialog-backdrop-type.enum";
+import { DialogBackdrop } from "./dialog-backdrop.type";
+/**
+ * Defines the configuration associated with a custom component displayed through the Dialog API.
+ */
+export interface DialogConfig {
+    /**
+     * Indicates whether the dialog is modal, or static.
+     */
+    backdrop?: DialogBackdrop | DialogBackdropType;
+}

package/lib/framework/dialog/dialog.outlet.d.ts

@@ -0,0 +1,59 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { OnInit } from '@angular/core';
+import { DialogService } from './dialog-service';
+import * as i0 from "@angular/core";
+/**
+ * Acts as a placeholder that the ATX framework dynamically fills based on the component specified
+ * by the dialog service `show()` method.
+ */
+export declare class DialogOutlet implements OnInit {
+    private dialogSvc;
+    /**
+     * @private
+     */
+    private _dialog;
+    /**
+     * @private
+     */
+    private renderer;
+    /**
+     * @private
+     */
+    private _config;
+    /**
+     * @private
+     */
+    constructor(dialogSvc: DialogService);
+    /**
+     * @private
+     */
+    ngOnInit(): void;
+    /**
+     * @private
+     */
+    protected mouseupHandler(event: MouseEvent): void;
+    /**
+     * @private
+     */
+    protected onClose(event: Event): void;
+    /**
+     * @private
+     */
+    private stateChange;
+    /**
+     * @private
+     */
+    private show;
+    /**
+     * @private
+     */
+    private hide;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DialogOutlet, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DialogOutlet, "atx-dialog-outlet", never, {}, {}, never, never, true, never>;
+}

package/lib/framework/dialog/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+export * from "./dialog-backdrop-type.enum";
+export * from "./dialog-backdrop.type";
+export * from "./dialog-outlet-event-type";
+export * from "./dialog-outlet.event";
+export * from "./dialog.config";
+export * from "./dialog.outlet";
+export * from "./dialog-service";
+export * from "./dialog-service.error";

package/lib/framework/index.d.ts

@@ -2,3 +2,4 @@ export * from './mock/http';
 export * from './mock/http-monitoring-console';
 export * from './mock/documentation';
 export * from './logging';
+export * from './dialog';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-toolbox",
-  "version": "1.4.5",
+  "version": "1.4.6",
   "license": "SEE LICENSE IN LICENSE",
   "peerDependencies": {
     "@angular/common": "^18.0.0",