You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
98 lines
5.2 KiB
98 lines
5.2 KiB
import type { AppContext, ExtractPropTypes, VNode } from 'vue';
|
|
import type { Mutable } from 'element-plus/es/utils';
|
|
import type MessageConstructor from './message.vue';
|
|
export declare const messageTypes: readonly ["success", "info", "warning", "error"];
|
|
export type messageType = typeof messageTypes[number];
|
|
export interface MessageConfigContext {
|
|
max?: number;
|
|
grouping?: boolean;
|
|
duration?: number;
|
|
offset?: number;
|
|
showClose?: boolean;
|
|
}
|
|
export declare const messageDefaults: Mutable<{
|
|
readonly customClass: "";
|
|
readonly center: false;
|
|
readonly dangerouslyUseHTMLString: false;
|
|
readonly duration: 3000;
|
|
readonly icon: undefined;
|
|
readonly id: "";
|
|
readonly message: "";
|
|
readonly onClose: undefined;
|
|
readonly showClose: false;
|
|
readonly type: "info";
|
|
readonly plain: false;
|
|
readonly offset: 16;
|
|
readonly zIndex: 0;
|
|
readonly grouping: false;
|
|
readonly repeatNum: 1;
|
|
readonly appendTo: HTMLElement;
|
|
}>;
|
|
export declare const messageProps: {
|
|
readonly customClass: import("element-plus/es/utils").EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
|
|
readonly center: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
|
|
readonly dangerouslyUseHTMLString: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
|
|
readonly duration: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 3000, boolean>;
|
|
readonly icon: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => (string | import("vue").Component) & {}) | (() => string | import("vue").Component) | ((new (...args: any[]) => (string | import("vue").Component) & {}) | (() => string | import("vue").Component))[], unknown, unknown, undefined, boolean>;
|
|
readonly id: import("element-plus/es/utils").EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
|
|
readonly message: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => string | VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
[key: string]: any;
|
|
}> | (() => VNode)) | (() => string | VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
[key: string]: any;
|
|
}> | (() => VNode)) | ((new (...args: any[]) => string | VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
[key: string]: any;
|
|
}> | (() => VNode)) | (() => string | VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
[key: string]: any;
|
|
}> | (() => VNode)))[], unknown, unknown, "", boolean>;
|
|
readonly onClose: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => () => void) | (() => () => void) | {
|
|
(): () => void;
|
|
new (): any;
|
|
readonly prototype: any;
|
|
} | ((new (...args: any[]) => () => void) | (() => () => void) | {
|
|
(): () => void;
|
|
new (): any;
|
|
readonly prototype: any;
|
|
})[], unknown, unknown, undefined, boolean>;
|
|
readonly showClose: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
|
|
readonly type: import("element-plus/es/utils").EpPropFinalized<StringConstructor, "error" | "success" | "warning" | "info", unknown, "info", boolean>;
|
|
readonly plain: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
|
|
readonly offset: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 16, boolean>;
|
|
readonly zIndex: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
|
|
readonly grouping: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
|
|
readonly repeatNum: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 1, boolean>;
|
|
};
|
|
export type MessageProps = ExtractPropTypes<typeof messageProps>;
|
|
export declare const messageEmits: {
|
|
destroy: () => boolean;
|
|
};
|
|
export type MessageEmits = typeof messageEmits;
|
|
export type MessageInstance = InstanceType<typeof MessageConstructor> & unknown;
|
|
export type MessageOptions = Partial<Mutable<Omit<MessageProps, 'id'> & {
|
|
appendTo?: HTMLElement | string;
|
|
}>>;
|
|
export type MessageParams = MessageOptions | MessageOptions['message'];
|
|
export type MessageParamsNormalized = Omit<MessageProps, 'id'> & {
|
|
/**
|
|
* @description set the root element for the message, default to `document.body`
|
|
*/
|
|
appendTo: HTMLElement;
|
|
};
|
|
export type MessageOptionsWithType = Omit<MessageOptions, 'type'>;
|
|
export type MessageParamsWithType = MessageOptionsWithType | MessageOptions['message'];
|
|
export interface MessageHandler {
|
|
/**
|
|
* @description close the Message
|
|
*/
|
|
close: () => void;
|
|
}
|
|
export type MessageFn = {
|
|
(options?: MessageParams, appContext?: null | AppContext): MessageHandler;
|
|
closeAll(type?: messageType): void;
|
|
};
|
|
export type MessageTypedFn = (options?: MessageParamsWithType, appContext?: null | AppContext) => MessageHandler;
|
|
export interface Message extends MessageFn {
|
|
success: MessageTypedFn;
|
|
warning: MessageTypedFn;
|
|
info: MessageTypedFn;
|
|
error: MessageTypedFn;
|
|
}
|