@inpageedit/core 0.8.0 → 0.8.1

package/dist/services/ModalService/IPEModal.d.ts

@@ -1,235 +0,0 @@
-export type SsiModalSizeClass = 'dialog' | 'small' | 'smallToMedium' | 'medium' | 'mediumToLarge' | 'large' | 'full' | 'auto';
-export type IPEModalAnimation = string | {
-    /** animation name when showing; set false to disable */
-    show?: string | false;
-    /** animation name when hiding; set false to disable */
-    hide?: string | false;
-} | false;
-export type AnyContent = string | Node | any;
-export interface IPEModalButtonOptions {
-    /** Button label content (text node by default; not parsed as HTML). */
-    label: AnyContent;
-    /** Render as <button> (default) or <a>. */
-    type?: 'button' | 'link';
-    /** Extra class names. */
-    className?: string;
-    /** Enable the button after N ms; set false to skip. */
-    enableAfter?: number | false;
-    /** Element id attribute. */
-    id?: string;
-    /** Click handler; `this` is the element; receives mouse event and modal instance. */
-    method?: (this: HTMLButtonElement | HTMLAnchorElement, event: MouseEvent, modal: IPEModal) => void;
-    /** Button group side within footer. */
-    side?: 'left' | 'right';
-    /** Keyboard shortcut for this button (e.g. 'Enter' | 'Escape' | 'y'). */
-    keyPress?: string;
-    /** Close modal after N ms once the button is clicked; set false to skip. */
-    closeAfter?: number | false;
-    /** Only for type:'link'. */
-    href?: string;
-}
-export interface IPEModalOptions {
-    /** Extra class names applied to the window element. */
-    className?: string;
-    /** Predefined size class. */
-    sizeClass?: SsiModalSizeClass;
-    /** Center the modal (adds .is-centered on host). */
-    center?: boolean;
-    /** Keep a fixed height (px) or enable fixed-height mode; layout via CSS. */
-    fixedHeight?: boolean | number;
-    /** Fullscreen layout helper. */
-    fitScreen?: boolean;
-    /** Render icon-style buttons in header (styling only). */
-    iconButtons?: boolean;
-    /** Show close (×) icon in header. */
-    closeIcon?: boolean;
-    title?: AnyContent;
-    content?: AnyContent;
-    buttons?: Partial<IPEModalButtonOptions>[];
-    /**
-     * Backdrop behavior:
-     * - true (default): dedicated backdrop per modal
-     * - 'shared' or 'byKindShared': reserved for external coordination
-     * - false: no backdrop (floating window)
-     */
-    backdrop?: boolean | 'shared' | 'byKindShared';
-    /**
-     * Close when clicking on the backdrop. Ignored when `backdrop === false`.
-     */
-    outSideClose?: boolean;
-    /**
-     * Allow body scrolling while the modal is open. Default: **false** (lock scroll).
-     */
-    bodyScroll?: boolean;
-    /** Stack behavior placeholder (kept for parity). */
-    stack?: boolean;
-    /** Navigation placeholder (kept for parity). */
-    navigation?: boolean;
-    /** Enable drag only when `backdrop === false`. */
-    draggable?: boolean;
-    /** Window animation (or legacy `animation`). */
-    animation?: IPEModalAnimation;
-    /** Preferred: animation for modal window element. */
-    modalAnimation?: IPEModalAnimation;
-    /** Animation for backdrop element. */
-    backdropAnimation?: IPEModalAnimation;
-    /**
-     * Fallback duration (ms) used when CSS events are not observable.
-     */
-    animationSpeed?: number;
-    /** Auto-close options. */
-    closeAfter?: {
-        /**
-         * Close the modal/toast after `time` ms. For toast: defaults to 3000ms.
-         */
-        time: number;
-        /** Not used by library (reserved for UI display). */
-        displayTime?: number;
-        /** Reset countdown when hovered. */
-        resetOnHover?: boolean;
-    } | number;
-    /** Kept for parity; CSS controls actual layout. */
-    position?: 'right top' | 'right bottom' | 'left top' | 'left bottom' | 'center top' | 'center bottom';
-    /** Return false to cancel showing. */
-    beforeShow?: (modal: IPEModal) => boolean | void;
-    onShow?: (modal: IPEModal) => void;
-    /** Return false to cancel closing. */
-    beforeClose?: (modal: IPEModal) => boolean | void;
-    onClose?: (modal: IPEModal) => void;
-    /**
-     * Called when clicking the close icon. If a function returns false or value is `false`,
-     * the modal will NOT close. If value is `true` or omitted, it closes as usual.
-     */
-    onClickClose?: boolean | ((modal: IPEModal) => boolean | void);
-}
-export type IPEModalNotifyType = 'default' | 'info' | 'success' | 'warning' | 'error' | 'confirm' | string;
-export type IPEModalNotifyPosition = 'top right' | 'top left' | 'bottom right' | 'bottom left';
-export declare enum IPEModalEvent {
-    Init = "modal.init",
-    BeforeShow = "modal.beforeShow",
-    Show = "modal.show",
-    BeforeClose = "modal.beforeClose",
-    Close = "modal.close",
-    Destroy = "modal.destroy",
-    ToastShow = "toast.show",
-    ToastClose = "toast.close"
-}
-export type IPEModalHook = (ev: CustomEvent<IPEModal>) => boolean | void;
-declare global {
-    interface HTMLElementEventMap {
-        'modal.init': CustomEvent<IPEModal>;
-        'modal.beforeShow': CustomEvent<IPEModal>;
-        'modal.show': CustomEvent<IPEModal>;
-        'modal.beforeClose': CustomEvent<IPEModal>;
-        'modal.close': CustomEvent<IPEModal>;
-        'modal.destroy': CustomEvent<IPEModal>;
-        'toast.show': CustomEvent<IPEModal>;
-        'toast.close': CustomEvent<IPEModal>;
-    }
-}
-export declare class IPEModal {
-    readonly backdropId: string;
-    readonly modalId: string;
-    readonly numberId: string;
-    private _isDestroyed;
-    get isDestroyed(): boolean;
-    options: IPEModalOptions;
-    /** Logical grouping for stack ops (e.g., 'toast'). */
-    pluginName: string;
-    private $backdrop?;
-    private $modal?;
-    private $window?;
-    private $header?;
-    private $title?;
-    private $icons?;
-    private $content?;
-    private $footer?;
-    private $buttonsLeft?;
-    private $buttonsRight?;
-    private buttonElsLeft;
-    private buttonElsRight;
-    private keyMap;
-    private isOpen;
-    private lastFocused?;
-    private closeTimer?;
-    private isToast;
-    private isDragging;
-    private dragStartX;
-    private dragStartY;
-    private modalStartX;
-    private modalStartY;
-    Event: typeof IPEModalEvent;
-    DEFAULT_OPTIONS: IPEModalOptions;
-    constructor(options?: Partial<IPEModalOptions>);
-    init(): this;
-    show(): this;
-    close(): this;
-    /** Immediately removes DOM and listeners */
-    destroy(): this;
-    get$backdrop(): HTMLDivElement | undefined;
-    get$modal(): HTMLDivElement;
-    get$window(): HTMLDivElement;
-    get$header(): HTMLDivElement;
-    get$title(): HTMLHeadingElement;
-    get$content(): HTMLDivElement;
-    get$icons(): HTMLDivElement;
-    get$buttons(type?: 'buttons' | 'leftButtons' | 'rightButtons'): HTMLDivElement;
-    setTitle(title: AnyContent): this;
-    setContent(content: AnyContent, method?: 'replace' | 'append' | 'prepend'): this;
-    setIcons(icons: {
-        className: string;
-        method: () => void;
-    }[]): this;
-    setButtons(buttons: Partial<IPEModalButtonOptions>[], area?: HTMLElement): this;
-    generateButton(opts: Partial<IPEModalButtonOptions>): HTMLButtonElement | HTMLAnchorElement;
-    /** Dynamically add button(s) into footer. Supports insertion index per side. */
-    addButton(opts: Partial<IPEModalButtonOptions>, index?: number): this;
-    /** Remove button by element / id / global index (left first, then right). */
-    removeButton(target: number | string | HTMLElement | '*'): this;
-    changePreviewState(): this;
-    setModalHeight(offset: number, option?: 'height' | 'min-height' | 'max-height'): number;
-    setOptions<T extends keyof IPEModalOptions>(option: T, value: IPEModalOptions[T]): this;
-    setOptions(options: Partial<IPEModalOptions>): this;
-    setPluginName(name: string): this;
-    private applyAnimation;
-    private _hooks;
-    on(type: IPEModalEvent, listener: IPEModalHook): () => this;
-    off(type: IPEModalEvent, listener?: IPEModalHook): this;
-    once(type: IPEModalEvent, listener: IPEModalHook): () => this;
-    private emit;
-    private focusFirst;
-    private onKeyDown;
-    private startCloseTimer;
-    private stopCloseTimer;
-    setZIndex(z: number): void;
-    /** Bring this modal to the top of the stack. */
-    bringToFront(): this;
-    private isAnimationDisabled;
-    private shouldLockBodyOnOpen;
-    private shouldUnlockBodyOnClose;
-    private onDragStart;
-    private onDragMove;
-    private onDragEnd;
-    /** Show as toast (no backdrop, container stack). */
-    showToast(options: Partial<{
-        position: IPEModalNotifyPosition;
-    }>): this;
-    static show(options: Partial<IPEModalOptions>, _element?: AnyContent): IPEModal;
-    static createObject(options: Partial<IPEModalOptions>, _element?: AnyContent): IPEModal;
-    static close(modalId?: string | HTMLElement): IPEModal | undefined;
-    static closeAll(group?: string | string[], except?: string | string[]): IPEModal;
-    static removeAll(): void;
-    static dialog(options: Partial<IPEModalOptions>, method: (e: MouseEvent, m: IPEModal) => void): IPEModal;
-    static confirm(options: Partial<IPEModalOptions> & Partial<{
-        okBtn: Pick<IPEModalButtonOptions, 'label' | 'className'>;
-        cancelBtn: Pick<IPEModalButtonOptions, 'label' | 'className'>;
-    }>, method: (e: MouseEvent, m: IPEModal) => void): IPEModal;
-    static getDefaultNotifyIcon(type: IPEModalNotifyType): import('jsx-dom').ReactElement | null;
-    static notify(type: IPEModalNotifyType, options: Partial<IPEModalOptions> & Partial<{
-        icon: string | Element;
-        okBtn: Pick<IPEModalButtonOptions, 'label' | 'className'>;
-        cancelBtn: Pick<IPEModalButtonOptions, 'label' | 'className'>;
-        overrideOther: boolean;
-        position: IPEModalNotifyPosition;
-    }>, callback?: (result: boolean) => void): IPEModal;
-}