element-plus
Version:
A Component Library for Vue 3
90 lines (89 loc) • 3.2 kB
TypeScript
import type { CSSProperties, VNode } from 'vue';
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 {
title: string;
message: string;
type: MessageType;
iconClass: string;
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);
export interface ElMessageBoxOptions {
beforeClose?: (action: Action, instance: MessageBoxState, done: () => void) => void;
customClass?: string;
customStyle?: CSSProperties;
callback?: Callback;
cancelButtonText?: string;
confirmButtonText?: string;
cancelButtonClass?: string;
confirmButtonClass?: string;
center?: boolean;
message?: string | VNode;
title?: string;
type?: MessageType;
boxType?: MessageBoxType;
iconClass?: string;
dangerouslyUseHTMLString?: boolean;
distinguishCancelAndClose?: boolean;
lockScroll?: boolean;
showCancelButton?: boolean;
showConfirmButton?: boolean;
showClose?: boolean;
roundButton?: boolean;
closeOnClickModal?: boolean;
closeOnPressEscape?: boolean;
closeOnHashChange?: boolean;
showInput?: boolean;
inputPlaceholder?: string;
inputValue?: string;
inputPattern?: RegExp;
inputType?: string;
inputValidator?: MessageBoxInputValidator;
inputErrorMessage?: string;
}
export declare type ElMessageBoxShortcutMethod = ((message: ElMessageBoxOptions['message'], title: ElMessageBoxOptions['title'], options?: ElMessageBoxOptions) => Promise<MessageBoxData>) & ((message: ElMessageBoxOptions['message'], options?: ElMessageBoxOptions) => Promise<MessageBoxData>);
export interface IElMessageBox {
(options: ElMessageBoxOptions): Promise<MessageBoxData>;
alert: ElMessageBoxShortcutMethod;
confirm: ElMessageBoxShortcutMethod;
prompt: ElMessageBoxShortcutMethod;
close(): void;
}
export {};