ngx-kit 2.0.2 → 3.0.0

package/types/ngx-kit-message.d.ts

@@ -0,0 +1,276 @@
+import * as i0 from '@angular/core';
+import { EnvironmentProviders, Injector, ComponentRef, ApplicationRef, EnvironmentInjector } from '@angular/core';
+import * as rxjs from 'rxjs';
+
+declare class MessageOptions implements IMessageOptions {
+    private config?;
+    constructor(config?: IMessageOptions | undefined);
+    /**
+     * add popover manual to set alert dialog container to top layer
+     * - usefull when using alert modal in angular material dialog
+     *
+     */
+    useOverlay?: boolean;
+    title?: string;
+    text?: string;
+    html?: string | HTMLElement;
+    backdrop?: boolean;
+    icon?: MessageIcon;
+    width?: number | string;
+    allowOutsideClick?: boolean;
+    allowEscapeKey?: boolean;
+    allowEnterKey?: boolean;
+    showConfirmButton?: boolean;
+    showDenyButton?: boolean;
+    showCancelButton?: boolean;
+    confirmButtonText: string;
+    denyButtonText?: string;
+    cancelButtonText?: string;
+    confirmButtonColor?: string;
+    denyButtonColor?: string;
+    cancelButtonColor?: string;
+    confirmButtonAriaLabel?: string;
+    denyButtonAriaLabel?: string;
+    cancelButtonAriaLabel?: string;
+    reverseButtons?: boolean;
+    showCloseButton?: boolean;
+    containerClass?: string;
+}
+
+type MessageIcon = 'None' | 'success' | 'error' | 'warning' | 'info' | 'question';
+
+interface IMessageOptions {
+    /**
+     * add popover manual to set alert dialog container to top layer
+     * - usefull when using alert modal in angular material dialog
+     *
+     */
+    useOverlay?: boolean;
+    /**
+     * The title of the popup
+     *
+     * @default ''
+     */
+    title?: string;
+    /**
+     * A description for the popup.
+     *
+     * @default ''
+     */
+    text?: string;
+    /**
+     * A HTML description for the popup.
+     *
+     * [Security] we does NOT sanitize this parameter. It is the developer's responsibility
+     * to escape any user input when using the `html` option, so XSS attacks would be prevented.
+     *
+     * @default ''
+     */
+    html?: string | HTMLElement;
+    /**
+     * Whether or not  should show a full screen click-to-dismiss backdrop.
+     * Either a boolean value or a css background value (hex, rgb, rgba, url, etc.)
+     *
+     * @default true
+     */
+    backdrop?: boolean;
+    icon?: MessageIcon;
+    /**
+     * Popup width, including paddings (`box-sizing: border-box`).
+     *
+     * @default undefined
+     * @description ❌⚠️NOT Implemented!⚠️❌
+     */
+    width?: number | string;
+    /**
+     * If set to `false`, the user can't dismiss the popup by clicking outside it.
+     *
+     * @default true
+     */
+    allowOutsideClick?: boolean;
+    /**
+     * If set to `false`, the user can't dismiss the popup by pressing the Escape key.
+     *
+     * @default true
+     */
+    allowEscapeKey?: boolean;
+    /**
+     * If set to `false`, the user can't confirm the popup by pressing the Enter or Space keys,
+     * unless they manually focus the confirm button.
+     *
+     * @default true
+     */
+    allowEnterKey?: boolean;
+    /**
+     * If set to `false`, the "Confirm" button will not be shown.
+     *
+     * @default true
+     */
+    showConfirmButton?: boolean;
+    /**
+     * If set to `true`, the "Deny" button will be shown, which the user can click on to deny the popup.
+     *
+     * @default false
+     */
+    showDenyButton?: boolean;
+    /**
+     * If set to `true`, the "Cancel" button will be shown, which the user can click on to dismiss the popup.
+     *
+     * @default false
+     */
+    showCancelButton?: boolean;
+    /**
+     * Use this to change the text on the "Confirm" button.
+     *
+     * @default 'OK'
+     */
+    confirmButtonText?: string;
+    /**
+     * Use this to change the text on the "Confirm" button.
+     *
+     * @default 'No'
+     */
+    denyButtonText?: string;
+    /**
+     * Use this to change the text on the "Cancel" button.
+     *
+     * @default 'Cancel'
+     */
+    cancelButtonText?: string;
+    /**
+     * Use this to change the background color of the "Confirm" button.
+     *
+     * @default undefined
+     * @description ❌⚠️NOT Implemented!⚠️❌
+     */
+    confirmButtonColor?: string;
+    /**
+     * Use this to change the background color of the "Deny" button.
+     *
+     * @default undefined
+     * @description ❌⚠️NOT Implemented!⚠️❌
+     */
+    denyButtonColor?: string;
+    /**
+     * Use this to change the background color of the "Cancel" button.
+     *
+     * @default undefined
+     * @description ❌⚠️NOT Implemented!⚠️❌
+     */
+    cancelButtonColor?: string;
+    /**
+     * Use this to change the `aria-label` for the "Confirm" button.
+     *
+     * @default ''
+     */
+    confirmButtonAriaLabel?: string;
+    /**
+     * Use this to change the `aria-label` for the "Deny" button.
+     *
+     * @default ''
+     */
+    denyButtonAriaLabel?: string;
+    /**
+     * Use this to change the `aria-label` for the "Cancel" button.
+     *
+     * @default ''
+     */
+    cancelButtonAriaLabel?: string;
+    /**
+     * Set to `true` if you want to invert default buttons positions.
+     *
+     * @default false
+     * @description ❌⚠️NOT Implemented!⚠️❌
+     */
+    reverseButtons?: boolean;
+    /**
+     * Set to `true` to show close button.
+     *
+     * @default false
+     */
+    showCloseButton?: boolean;
+    containerClass?: string;
+}
+
+declare function provideMessage(options?: IMessageOptions): EnvironmentProviders;
+
+interface MessageResult<T = any> {
+    readonly isConfirmed: boolean;
+    readonly isDenied: boolean;
+    readonly isDismissed: boolean;
+    /**
+     * @description ❌⚠️NOT Implemented!⚠️❌
+     */
+    readonly value?: T;
+    readonly dismiss?: DismissReason;
+}
+/**
+ * An enum of possible reasons that can explain an alert dismissal.
+ */
+declare enum DismissReason {
+    cancel = 0,
+    backdrop = 1,
+    close = 2,
+    /**
+  * @description ❌⚠️NOT Implemented!⚠️❌
+  */
+    esc = 3,
+    /**
+  * @description ❌⚠️NOT Implemented!⚠️❌
+  */
+    timer = 4
+}
+
+/**
+ * Static facade so call sites can use: MSG.warn('msg', opts)
+ * Module will set the service instance in its constructor.
+ */
+declare class MSG {
+    static injector: Injector;
+    static show(options?: IMessageOptions): Promise<MessageResult<any>>;
+    static fire(options?: IMessageOptions): Promise<MessageResult<any>>;
+    static info(title: string, text?: string, options?: IMessageOptions): Promise<MessageResult<any>>;
+    static success(title: string, text?: string, options?: IMessageOptions): Promise<MessageResult<any>>;
+    static warning(title: string, text?: string, options?: IMessageOptions): Promise<MessageResult<any>>;
+    static error(title: string, text?: string, options?: IMessageOptions): Promise<MessageResult<any>>;
+}
+
+declare class NgxMessageComponent {
+    options: IMessageOptions;
+    index: number;
+    private readonly _onClose;
+    onClose: rxjs.Observable<{
+        index: number;
+        result: MessageResult<any>;
+    }>;
+    onScapeKey(event: Event): void;
+    onEnterKey(event: Event): void;
+    onConfirm(): void;
+    onCancel(): void;
+    onDeny(): void;
+    close(): void;
+    onOutSideClick(): void;
+    innerOnClick(ev: Event): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgxMessageComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<NgxMessageComponent, "ngx-message", never, {}, {}, never, never, true, never>;
+}
+
+declare class NgxMessageService {
+    private appRef;
+    private injector;
+    private envInjector;
+    private _doc;
+    currentAdIndex: number;
+    alerts: ComponentRef<NgxMessageComponent>[];
+    insertedId: number;
+    constructor(appRef: ApplicationRef, injector: Injector, envInjector: EnvironmentInjector, _doc: Document);
+    show(c?: IMessageOptions): Promise<MessageResult<any>>;
+    private removeDialogComponentFromBody;
+    private appendDialogComponentToBody;
+    closeAll(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgxMessageService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<NgxMessageService>;
+}
+
+export { DismissReason, MSG, MessageOptions, NgxMessageService, provideMessage };
+export type { IMessageOptions, MessageResult };

package/types/ngx-kit-notify.d.ts

@@ -1,4 +1,22 @@
-import { EnvironmentProviders, Injector } from '@angular/core';
+import * as _angular_core from '@angular/core';
+import { EventEmitter, EnvironmentProviders, Injector, OnInit, OnDestroy, ElementRef, ChangeDetectorRef, InjectionToken } from '@angular/core';
+import { SafeHtml, DomSanitizer } from '@angular/platform-browser';
+
+type NgxNotifyType = 'success' | 'error' | 'warning' | 'info';
+type NgxNotifyPositionType = 'center' | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'top-center' | 'bottom-center';
+interface NgxNotifyPayload {
+    id: string;
+    message: string;
+    description?: string;
+    type: NgxNotifyType;
+    options: NgxNotifyOptions;
+    onClose: EventEmitter<INotifyEnd>;
+    onFinish: EventEmitter<INotifyEnd>;
+}
+interface INotifyEnd {
+    id: string;
+    el: HTMLElement;
+}
 
 interface NgxNotifyOptions {
     /**
@@ -10,7 +28,7 @@ interface NgxNotifyOptions {
      * Notify position
      * @default top-center
      */
-    position?: 'center' | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'top-center' | 'bottom-center';
+    position?: NgxNotifyPositionType;
     /**
      * How many visible at once
      * queued, prevents overlap
@@ -32,6 +50,11 @@ interface NgxNotifyOptions {
      * @default true
      */
     dismissible?: boolean;
+    /**
+     * close on tap notify
+     * @default true
+     */
+    closeOnTap?: boolean;
     /**
      * Additional container class
      */
@@ -50,11 +73,72 @@ declare function provideNotify(options?: NgxNotifyOptions): EnvironmentProviders
  */
 declare class Notify {
     static injector: Injector;
-    static show(message: string, type?: 'info' | 'success' | 'warning' | 'error', options?: NgxNotifyOptions): void;
-    static info(message: string, options?: NgxNotifyOptions): void;
-    static success(message: string, options?: NgxNotifyOptions): void;
-    static warning(message: string, options?: NgxNotifyOptions): void;
-    static error(message: string, options?: NgxNotifyOptions): void;
+    static show(type: "info" | "success" | "warning" | "error" | undefined, message: string, description?: string, options?: NgxNotifyOptions): NgxNotifyPayload;
+    static info(message: string, description?: string, options?: NgxNotifyOptions): NgxNotifyPayload;
+    static success(message: string, description?: string, options?: NgxNotifyOptions): NgxNotifyPayload;
+    static warning(message: string, description?: string, options?: NgxNotifyOptions): NgxNotifyPayload;
+    static error(message: string, description?: string, options?: NgxNotifyOptions): NgxNotifyPayload;
 }
 
-export { Notify, provideNotify };
+declare class NgxNotificationComponent implements OnInit, OnDestroy {
+    payload: _angular_core.InputSignal<NgxNotifyPayload>;
+    containerClass: string;
+    bar: _angular_core.Signal<ElementRef<HTMLElement> | undefined>;
+    onClose: _angular_core.OutputEmitterRef<INotifyEnd>;
+    onFinish: _angular_core.OutputEmitterRef<INotifyEnd>;
+    private _rafId;
+    private _duration;
+    private _remaining;
+    private _endTs;
+    private _paused;
+    safeMessage: SafeHtml | string;
+    safeDescription: SafeHtml | string;
+    showClass: _angular_core.WritableSignal<string>;
+    protected doc: Document;
+    protected el: ElementRef<any>;
+    protected sanitizer: DomSanitizer;
+    protected chdr: ChangeDetectorRef;
+    constructor();
+    ngOnInit(): void;
+    ngOnDestroy(): void;
+    startTimer(ms: number): void;
+    pauseTimer(): void;
+    resumeTimer(): void;
+    private clearTimer;
+    private animateProgress;
+    close(ev?: Event): void;
+    onMouseEnter(): void;
+    onMouseLeave(): void;
+    onTap(): void;
+    escapeHtml(input?: string): string;
+    ngOnDestroyCleanup(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgxNotificationComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<NgxNotificationComponent, "ngx-notification", never, { "payload": { "alias": "payload"; "required": true; "isSignal": true; }; "containerClass": { "alias": "containerClass"; "required": false; }; }, { "onClose": "onClose"; "onFinish": "onFinish"; }, never, never, true, never>;
+}
+
+declare class NgxNotifyService {
+    private queue;
+    private visible;
+    private container;
+    private envInjector;
+    private appRef;
+    private doc;
+    private win;
+    private defaultOptions;
+    constructor();
+    configureContainer(position: NgxNotifyOptions['position'], containerClass: string): void;
+    show(message: string, description?: string, type?: NgxNotifyType, options?: NgxNotifyOptions): NgxNotifyPayload;
+    private _createAndShow;
+    private removeNode;
+    private removeEl;
+    private _showNextIfPossible;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgxNotifyService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<NgxNotifyService>;
+}
+
+declare const NGX_NOTIFY_CONFIG: InjectionToken<NgxNotifyOptions>;
+declare const NGX_NOTIFY_API: InjectionToken<NgxNotifyService>;
+declare const NGX_NOTIFY_DEFAULTS: Required<NgxNotifyOptions>;
+
+export { NGX_NOTIFY_API, NGX_NOTIFY_CONFIG, NGX_NOTIFY_DEFAULTS, NgxNotificationComponent, Notify, provideNotify };
+export type { INotifyEnd, NgxNotifyOptions, NgxNotifyPayload, NgxNotifyPositionType, NgxNotifyType };