mirror of
https://github.com/element-plus/element-plus.git
synced 2024-11-27 02:01:15 +08:00
91 lines
2.3 KiB
TypeScript
91 lines
2.3 KiB
TypeScript
import Vue, { VNode } from 'vue'
|
|
|
|
export type MessageType = 'success' | 'warning' | 'info' | 'error'
|
|
|
|
/** Message Component */
|
|
export declare class ElMessageComponent extends Vue {
|
|
/** Close the Loading instance */
|
|
close (): void
|
|
}
|
|
|
|
export interface CloseEventHandler {
|
|
/**
|
|
* Triggers when a message is being closed
|
|
*
|
|
* @param instance The message component that is being closed
|
|
*/
|
|
(instance: ElMessageComponent): void
|
|
}
|
|
|
|
/** Options used in Message */
|
|
export interface ElMessageOptions {
|
|
/** Message text */
|
|
message: string | VNode
|
|
|
|
/** Message type */
|
|
type?: MessageType
|
|
|
|
/** Custom icon's class, overrides type */
|
|
iconClass?: string
|
|
|
|
/** Custom class name for Message */
|
|
customClass?: string
|
|
|
|
/** Display duration, millisecond. If set to 0, it will not turn off automatically */
|
|
duration?: number
|
|
|
|
/** Whether to show a close button */
|
|
showClose?: boolean
|
|
|
|
/** Whether to center the text */
|
|
center?: boolean
|
|
|
|
/** Whether message is treated as HTML string */
|
|
dangerouslyUseHTMLString?: boolean
|
|
|
|
/** Callback function when closed with the message instance as the parameter */
|
|
onClose?: CloseEventHandler
|
|
|
|
/** Set the distance to the top of viewport. Default is 20 px. */
|
|
offset?: number
|
|
}
|
|
|
|
export interface ElMessage {
|
|
/** Show an info message */
|
|
(text: string): ElMessageComponent
|
|
|
|
/** Show message */
|
|
(options: ElMessageOptions): ElMessageComponent
|
|
|
|
/** Show a success message */
|
|
success (text: string): ElMessageComponent
|
|
|
|
/** Show a success message with options */
|
|
success (options: ElMessageOptions): ElMessageComponent
|
|
|
|
/** Show a warning message */
|
|
warning (text: string): ElMessageComponent
|
|
|
|
/** Show a warning message with options */
|
|
warning (options: ElMessageOptions): ElMessageComponent
|
|
|
|
/** Show an info message */
|
|
info (text: string): ElMessageComponent
|
|
|
|
/** Show an info message with options */
|
|
info (options: ElMessageOptions): ElMessageComponent
|
|
|
|
/** Show an error message */
|
|
error (text: string): ElMessageComponent
|
|
|
|
/** Show an error message with options */
|
|
error (options: ElMessageOptions): ElMessageComponent
|
|
}
|
|
|
|
declare module 'vue/types/vue' {
|
|
interface Vue {
|
|
/** Used to show feedback after an activity. The difference with Notification is that the latter is often used to show a system level passive notification. */
|
|
$message: ElMessage
|
|
}
|
|
}
|