ngx-kit 2.1.0 → 3.1.0

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

@@ -0,0 +1,284 @@
+import * as i0 from '@angular/core';
+import { EnvironmentProviders, Injector, OnInit, AfterViewInit, ElementRef, ComponentRef, ApplicationRef, EnvironmentInjector } from '@angular/core';
+import * as rxjs from 'rxjs';
+import { SafeHtml, DomSanitizer } from '@angular/platform-browser';
+
+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' | 'loading';
+
+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 implements OnInit, AfterViewInit {
+    icon?: SafeHtml;
+    showIcon: i0.WritableSignal<boolean>;
+    options: IMessageOptions;
+    confetti: i0.Signal<ElementRef<HTMLDivElement> | undefined>;
+    index: number;
+    protected sanitizer: DomSanitizer;
+    protected doc: Document;
+    private readonly _onClose;
+    onClose: rxjs.Observable<{
+        index: number;
+        result: MessageResult<any>;
+    }>;
+    ngOnInit(): void;
+    ngAfterViewInit(): void;
+    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-shared.d.ts

@@ -174,6 +174,10 @@ declare const WINDOW: InjectionToken<Window | null>;
 
 declare function randomStrnig(extraLength?: number, useNumeric?: boolean): string;
 
+declare function IsRtl(doc: Document): boolean;
+
+declare function makeConfetti(doc: Document, wrap: HTMLElement): void;
+
 declare class BrowserService {
     private platformId;
     constructor(platformId: object);
@@ -270,5 +274,5 @@ interface OverlayInstance {
     cleanup: () => void;
 }
 
-export { BrowserService, DIALOG_OVERLAY_CLASSNAME, FOCUSABLE_SELECTOR, OverlayRef, OverlayService, RangeSliderComponent, SaturationComponent, SliderComponent, ValueModel, WINDOW, getOffsetPosition, randomStrnig };
+export { BrowserService, DIALOG_OVERLAY_CLASSNAME, FOCUSABLE_SELECTOR, IsRtl, OverlayRef, OverlayService, RangeSliderComponent, SaturationComponent, SliderComponent, ValueModel, WINDOW, getOffsetPosition, makeConfetti, randomStrnig };
 export type { Alignment, BaseOverlayOptions, IPosition, IValue, OverlayInstance, OverlayOptions, Placement, Point, TemplateOptions };