import type { AppContext, CSSProperties, Component, VNode } from 'vue';
|
import type { ComponentSize } from 'element-plus/es/constants';
|
declare type MessageType = '' | 'success' | 'warning' | 'info' | 'error';
|
export declare type Action = 'confirm' | 'close' | 'cancel';
|
export declare type MessageBoxType = '' | 'prompt' | 'alert' | 'confirm';
|
export declare type MessageBoxData = MessageBoxInputData & Action;
|
export interface MessageBoxInputData {
|
value: string;
|
action: Action;
|
}
|
export interface MessageBoxInputValidator {
|
(value: string): boolean | string;
|
}
|
export declare interface MessageBoxState {
|
autofocus: boolean;
|
title: string;
|
message: string;
|
type: MessageType;
|
icon: string | Component;
|
customClass: string;
|
customStyle: CSSProperties;
|
showInput: boolean;
|
inputValue: string;
|
inputPlaceholder: string;
|
inputType: string;
|
inputPattern: RegExp;
|
inputValidator: MessageBoxInputValidator;
|
inputErrorMessage: string;
|
showConfirmButton: boolean;
|
showCancelButton: boolean;
|
action: Action;
|
dangerouslyUseHTMLString: boolean;
|
confirmButtonText: string;
|
cancelButtonText: string;
|
confirmButtonLoading: boolean;
|
cancelButtonLoading: boolean;
|
confirmButtonClass: string;
|
confirmButtonDisabled: boolean;
|
cancelButtonClass: string;
|
editorErrorMessage: string;
|
beforeClose: null | ((action: Action, instance: MessageBoxState, done: () => void) => void);
|
callback: null | Callback;
|
distinguishCancelAndClose: boolean;
|
modalFade: boolean;
|
modalClass: string;
|
validateError: boolean;
|
zIndex: number;
|
}
|
export declare type Callback = ((value: string, action: Action) => any) | ((action: Action) => any);
|
/** Options used in MessageBox */
|
export interface ElMessageBoxOptions {
|
/**
|
* auto focus when open message-box
|
*/
|
autofocus?: boolean;
|
/** Callback before MessageBox closes, and it will prevent MessageBox from closing */
|
beforeClose?: (action: Action, instance: MessageBoxState, done: () => void) => void;
|
/** Custom class name for MessageBox */
|
customClass?: string;
|
/** Custom inline style for MessageBox */
|
customStyle?: CSSProperties;
|
/** MessageBox closing callback if you don't prefer Promise */
|
callback?: Callback;
|
/** Text content of cancel button */
|
cancelButtonText?: string;
|
/** Text content of confirm button */
|
confirmButtonText?: string;
|
/** Custom class name of cancel button */
|
cancelButtonClass?: string;
|
/** Custom class name of confirm button */
|
confirmButtonClass?: string;
|
/** Whether to align the content in center */
|
center?: boolean;
|
/** Whether MessageBox can be drag */
|
draggable?: boolean;
|
/** Content of the MessageBox */
|
message?: string | VNode | (() => VNode);
|
/** Title of the MessageBox */
|
title?: string | ElMessageBoxOptions;
|
/** Message type, used for icon display */
|
type?: MessageType;
|
/** Message box type */
|
boxType?: MessageBoxType;
|
/** Custom icon component */
|
icon?: string | Component;
|
/** Whether message is treated as HTML string */
|
dangerouslyUseHTMLString?: boolean;
|
/** Whether to distinguish canceling and closing */
|
distinguishCancelAndClose?: boolean;
|
/** Whether to lock body scroll when MessageBox prompts */
|
lockScroll?: boolean;
|
/** Whether to show a cancel button */
|
showCancelButton?: boolean;
|
/** Whether to show a confirm button */
|
showConfirmButton?: boolean;
|
/** Whether to show a close button */
|
showClose?: boolean;
|
/** Whether to use round button */
|
roundButton?: boolean;
|
/** Whether MessageBox can be closed by clicking the mask */
|
closeOnClickModal?: boolean;
|
/** Whether MessageBox can be closed by pressing the ESC */
|
closeOnPressEscape?: boolean;
|
/** Whether to close MessageBox when hash changes */
|
closeOnHashChange?: boolean;
|
/** Whether to show an input */
|
showInput?: boolean;
|
/** Placeholder of input */
|
inputPlaceholder?: string;
|
/** Initial value of input */
|
inputValue?: string;
|
/** Regexp for the input */
|
inputPattern?: RegExp;
|
/** Input Type: text, textArea, password or number */
|
inputType?: string;
|
/** Validation function for the input. Should returns a boolean or string. If a string is returned, it will be assigned to inputErrorMessage */
|
inputValidator?: MessageBoxInputValidator;
|
/** Error message when validation fails */
|
inputErrorMessage?: string;
|
/** Custom size of confirm and cancel buttons */
|
buttonSize?: ComponentSize;
|
/** Custom element to append the message box to */
|
appendTo?: HTMLElement | string;
|
}
|
export declare type ElMessageBoxShortcutMethod = ((message: ElMessageBoxOptions['message'], title: ElMessageBoxOptions['title'], options?: ElMessageBoxOptions, appContext?: AppContext | null) => Promise<MessageBoxData>) & ((message: ElMessageBoxOptions['message'], options?: ElMessageBoxOptions, appContext?: AppContext | null) => Promise<MessageBoxData>);
|
export interface IElMessageBox {
|
_context: AppContext | null;
|
/** Show a message box */
|
/** Show a message box */
|
(options: ElMessageBoxOptions, appContext?: AppContext | null): Promise<MessageBoxData>;
|
/** Show an alert message box */
|
alert: ElMessageBoxShortcutMethod;
|
/** Show a confirm message box */
|
confirm: ElMessageBoxShortcutMethod;
|
/** Show a prompt message box */
|
prompt: ElMessageBoxShortcutMethod;
|
/** Close current message box */
|
close(): void;
|
}
|
export {};
|
